Skip to content

Commit

Permalink
automatically deploy docs to GitHub Pages
Browse files Browse the repository at this point in the history
  • Loading branch information
drbruced12 committed Feb 8, 2024
1 parent d5f8da5 commit 2b0dd1f
Showing 1 changed file with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions .github/workflows/publish-docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Publish Docs Workflow
run-name: ${{ github.actor }} is publishing document artifacts 🚀
on: [push, workflow_dispatch]


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

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
# Single deploy job since we're just deploying
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Build html
run: make html
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
# Upload build repository
path: './_build/html'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4


- run: echo "🍏 This job's status is ${{ job.status }}."

0 comments on commit 2b0dd1f

Please sign in to comment.