Skip to content

Deploy Docs to Pages #15

Deploy Docs to Pages

Deploy Docs to Pages #15

Workflow file for this run

# Simple workflow for deploying static content to GitHub Pages
name: Deploy Docs to Pages
on:
# Runs on pushes targeting the default branch
release:
types: [ published ]
# 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:
actions: read
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: Clean site
run: |
rm -rf ./site
mkdir ./site
- name: Download Artifact Docs
id: download
uses: dawidd6/action-download-artifact@v6
with:
if_no_artifact_found: ignore
github_token: ${{ secrets.GITHUB_TOKEN }}
workflow: python-app.yml
run_id: ${{ github.event.workflow_run.id }}
name: docs-site
path: ./site/
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
# Upload entire repository
path: './site/'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4