a9f89323a9
Co-authored-by: raphaelcoeffic <1050031+raphaelcoeffic@users.noreply.github.com> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Peter Feerick <peter.feerick@gmail.com>
56 lines
1.5 KiB
YAML
56 lines
1.5 KiB
YAML
name: Deploy Documentation
|
|
|
|
on:
|
|
push:
|
|
branches:
|
|
- main
|
|
paths:
|
|
- 'docs/**'
|
|
- 'mkdocs.yml'
|
|
- 'pyproject.toml'
|
|
- '.github/workflows/docs.yml'
|
|
tags:
|
|
- 'v[0-9]+.[0-9]+.[0-9]+' # release tags only, not -rc
|
|
pull_request:
|
|
paths:
|
|
- 'docs/**'
|
|
- 'mkdocs.yml'
|
|
- 'pyproject.toml'
|
|
- '.github/workflows/docs.yml'
|
|
workflow_dispatch:
|
|
|
|
permissions:
|
|
contents: write
|
|
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v7
|
|
with:
|
|
fetch-depth: 0
|
|
|
|
- name: Install uv
|
|
uses: astral-sh/setup-uv@v10.0.1
|
|
|
|
- name: Configure git for mike
|
|
if: github.event_name != 'pull_request'
|
|
run: |
|
|
git config user.name "github-actions[bot]"
|
|
git config user.email "github-actions[bot]@users.noreply.github.com"
|
|
|
|
- name: Build docs (PR check)
|
|
if: github.event_name == 'pull_request'
|
|
run: uv run --extra docs -- mkdocs build --strict
|
|
|
|
- name: Deploy as latest (main branch)
|
|
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
|
|
run: uv run --extra docs -- mike deploy --push --update-aliases latest
|
|
|
|
- name: Deploy release version
|
|
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
|
|
run: |
|
|
# Extract minor version from tag, e.g. v2.11.2 -> v2.11
|
|
VERSION=$(echo "${GITHUB_REF_NAME}" | sed 's/\.[0-9]*$//')
|
|
uv run --extra docs -- mike deploy --push --update-aliases "${VERSION}" stable
|