Skip to content

Commit

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

GitHub really wants us to use their deploy-pages system for this, so
switch to it.
  • Loading branch information
lifehackerhansol authored Apr 24, 2024
1 parent 20a6e63 commit 32e3461
Showing 1 changed file with 26 additions and 7 deletions.
33 changes: 26 additions & 7 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,18 @@ on:
workflow_dispatch:

jobs:
doc-deploy:
build:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
with:
persist-credentials: false
submodules: recursive

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

- uses: actions/setup-node@v3
with:
node-version: 20
Expand All @@ -30,9 +33,25 @@ jobs:
# Build the site using VuePress
run: npm run docs:build

- name: Deploy 🚀
uses: JamesIves/github-pages-[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: docs/.vuepress/dist # The folder the action should deploy.
clean: true # Automatically remove deleted files from the deploy branch
path: "docs/.vuepress/dist"

# 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 32e3461

Please sign in to comment.