-
Notifications
You must be signed in to change notification settings - Fork 483
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Setup GitHub Actions for README auto-deployment to GitHub Pages #33
Setup GitHub Actions for README auto-deployment to GitHub Pages #33
Conversation
Hi @AnthonyByansi 👋 Thanks for the PR! Adding @sarah-yo for review. |
Hi @AnthonyByansi, what is the goal of this PR? |
@AnthonyByansi understand. However, this can be done using a first party Github action now rather than a third party one (like this example here: https://github.com/tonybaloney/vscode-pets/blob/main/.github/workflows/docs.yml , please can you update this to use native GH actions? |
…github pages deployment
@AnthonyByansi can you please make sure the job had appripriate permissions, I think you need a statement along the lines of this: # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: true |
Hi @fhinkel
This pull request adds a GitHub Actions workflow to automatically publish changes from the
README.md
to GitHub Pages. The workflow is triggered on pushes to themain
branch that include changes to theREADME.md
. It converts theREADME.md
into anindex.html
and deploys it.Changes:
.github/workflows/deploy.yml
to define the GitHub Actions workflow.README.md
toindex.html
, and deploys it usingpeaceiris/actions-gh-pages
.Resolves #22