Add documentation publishing workflow (#4427)

Exploring publishing documentation to GitHub Pages. Not intended for
public consumption yet.
This commit is contained in:
Zanie Blue 2024-06-20 13:24:20 -04:00 committed by GitHub
parent 13e532ccda
commit 30eedb35c6
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

39
.github/workflows/docs.yml vendored Normal file
View file

@ -0,0 +1,39 @@
name: Publish documentation
on:
push:
branches: ["zb-docs-i"]
# Allows you to run this workflow manually from the Actions tab
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: "docs"
cancel-in-progress: false
jobs:
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@v5
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: "docs"
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4