Skip to content

Release docs

Release docs #32

Workflow file for this run

# Simple workflow for deploying static content to GitHub Pages
name: Release docs
on:
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
workflow_run:
workflows: [Go Release, Python Release]
types:
- completed
# 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:
docs:
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@v3
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.11"
- name: Install
run: |
pip3 install poetry
make install
- name: Build docs
run: |
make doc
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: './output/docs/_build/html'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2