Skip to content

Commit

Permalink
Migrate fully to GitHub Actions for Pages deployment
Browse files Browse the repository at this point in the history
Legacy deploy environments (including simply having something in
gh-pages!) is deprecated too.

GitHub really wants us to use their deploy-pages system for this, so
switch to it.
  • Loading branch information
lifehackerhansol committed Apr 24, 2024
1 parent 7211119 commit b200086
Showing 1 changed file with 24 additions and 10 deletions.
34 changes: 24 additions & 10 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ jobs:
with:
persist-credentials: false

- name: Configure GitHub Pages
uses: actions/configure-pages@v3

- name: Set up Python 3.x
uses: actions/setup-python@v4
with:
Expand Down Expand Up @@ -41,14 +44,25 @@ jobs:
# Build the site using mkdocs
run: mkdocs build --verbose --clean --strict

- name: Post-Mkdocs touch/copy files
# miscellaneous files needed for GitHub etc
run: |
touch site/.nojekyll
- name: Deploy 🚀
uses: JamesIves/[email protected]
- name: Upload GitHub Pages artifact
uses: actions/upload-pages-artifact@v3
with:
branch: gh-pages # The branch the action should deploy to.
folder: site # The folder the action should deploy.
clean: true # Automatically remove deleted files from the deploy branch
path: "site"

# Deployment job
deploy:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

0 comments on commit b200086

Please sign in to comment.