Skip to content

Dev

Dev #6

Workflow file for this run

name: docs
on:
workflow_dispatch:
push:
branches:
- main
- dev
paths:
- 'docs/**'
- 'mkdocs.yml'
- 'mkdocs_tech_radar/**'
- 'pyproject.toml'
pull_request:
branches:
- main
paths:
- 'docs/**'
- 'mkdocs.yml'
- 'mkdocs_tech_radar/**'
- 'pyproject.toml'
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# Cancel in-progress deployments when a new one is triggered to prevent stuck deployments.
concurrency:
group: "pages"
cancel-in-progress: true
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
with:
fetch-depth: 0
- uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
with:
python-version: 3.12
- name: Install uv
uses: astral-sh/setup-uv@v5
with:
version: "latest"
- name: Install dependencies and plugin
run: |
uv pip install --system --editable .
- name: Setup Pages
id: pages
uses: actions/configure-pages@v5
- name: Build documentation
run: |
uv run mkdocs build --config-file mkdocs.yml
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./site
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4