Skip to content

Deploy documentation #5

Deploy documentation

Deploy documentation #5

Workflow file for this run

name: Deploy documentation
on:
# Runs on version tags pushes
push:
tags:
- 'v*'
# Runs on manual triggers
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:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v3
- name: Install Poetry
uses: abatilo/actions-poetry@v2
with:
poetry-version: '1.5.1'
- name: Install Python
uses: actions/setup-python@v4
with:
python-version: '3.8'
cache: "poetry"
- name: Check Poetry lock file consistency
run: poetry lock --check
- name: Install dependencies
run: poetry install --sync
- name: Check version numbers consistency
run: poetry run poe version_check
- name: Build documentation
run: poetry run poe docs
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: 'docs/_build'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2