Skip to content

Commit

Permalink
workflows: add publishing docs to Github pages on release
Browse files Browse the repository at this point in the history
  • Loading branch information
airwoodix committed Sep 26, 2023
1 parent 119497e commit c66f068
Showing 1 changed file with 58 additions and 0 deletions.
58 changes: 58 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
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 Python
uses: actions/setup-python@v4
with:
python-version: '3.8'
cache: "poetry"
- name: Install Poetry
uses: abatilo/actions-poetry@v2
with:
poetry-version: '1.5.1'
- 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/html'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2

0 comments on commit c66f068

Please sign in to comment.