ArchUnitPython/.github/workflows/docs.yaml at main · LukasNiessen/ArchUnitPython · 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
name: Deploy Documentation

on:
    push:
        branches: [main]

# Allow one concurrent deployment
concurrency:
    group: 'pages'
    cancel-in-progress: true

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

jobs:
    # Build job
    build:
        runs-on: ubuntu-latest
        steps:
            - name: Checkout
              uses: actions/checkout@v6
              with:
                  fetch-depth: 0

            - name: Setup Python
              uses: actions/setup-python@v6
              with:
                  python-version: '3.12'

            - name: Install dependencies
              run: |
                  pip install -e ".[dev]"
                  pip install pdoc

            - name: Generate documentation
              run: pdoc src/archunitpython/ -o docs/ --docformat google

            - name: Setup Pages
              uses: actions/configure-pages@v6

            - name: Upload artifact
              uses: actions/upload-pages-artifact@v4
              with:
                  path: './docs'

    # Deployment job - only runs on main branch pushes
    deploy:
        if: github.ref == 'refs/heads/main' && github.event_name == 'push'
        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@v5