OAD/.github/workflows/deploy-zen-api-docs.yml at master · zeiss-microscopy/OAD · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
name: Deploy ZEN API docs

on:
    push:
        branches:
            # Temporary trigger to test this workflow before it is merged into master.
            - add_mkdocs_for_zenapi
    workflow_dispatch:
        inputs:
            versions:
                description: Space-separated ZEN API package versions to publish
                required: true
                default: "2026.05.1 2025.10.1"
                type: string

permissions:
    contents: read
    pages: write
    id-token: write

env:
    DOC_VERSIONS: ${{ github.event.inputs.versions || '2026.05.1 2025.10.1' }}

concurrency:
    group: github-pages
    cancel-in-progress: false

jobs:
    deploy-docs:
        name: Deploy ZEN API documentation to GitHub Pages
        runs-on: ubuntu-latest

        steps:
            - name: Checkout repository
              uses: actions/checkout@v5

            - name: Set up Python
              uses: actions/setup-python@v6
              with:
                  python-version: "3.12"
                  cache: pip

            - name: Install MkDocs dependencies
              run: |
                  python -m pip install --upgrade pip
                  python -m pip install mkdocs-material mkdocstrings[python] mike pyyaml

            - name: Build versioned MkDocs Material sites
              run: python .github/scripts/build_zen_api_docs.py --versions ${{ env.DOC_VERSIONS }}

            - name: Configure GitHub Pages
              uses: actions/configure-pages@v6

            - name: Upload GitHub Pages artifact
              uses: actions/upload-pages-artifact@v4
              with:
                  path: site

            - name: Deploy to GitHub Pages
              id: deployment
              uses: actions/deploy-pages@v5