Artemis/.github/workflows/ci-docs.yml at develop · ls1intum/Artemis · 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
62
63
64
65
66
67
68
69
70
71
name: Build Documentation

on:
  workflow_call:
    inputs:
      upload_pages_artifact:
        description: 'Also upload the built site as a GitHub Pages artifact (set true by the deploy paths in ci.yml / deploy-documentation.yml). PR validation runs leave it false.'
        required: false
        default: false
        type: boolean

permissions: {}

# Workflow-level node pin is drift-checked by ci-workflows.yml.
env:
  node: 24

jobs:
  build:
    name: Build documentation site
    runs-on: ubuntu-latest
    timeout-minutes: 15
    permissions:
      contents: read
    steps:
      - uses: actions/checkout@v6

      - uses: pnpm/action-setup@0e279bb959325dab635dd2c09392533439d90093  # v6.0.8
        with:
          package_json_file: package.json
          run_install: false

      - uses: actions/setup-node@v6
        with:
          node-version: '${{ env.node }}'
          cache: 'pnpm'
          cache-dependency-path: |
            pnpm-lock.yaml
            documentation/pnpm-lock.yaml

      - name: Install client dependencies
        run: pnpm install --frozen-lockfile

      - name: Install documentation dependencies
        working-directory: documentation
        run: pnpm install --frozen-lockfile

      - name: Documentation Code Style
        working-directory: documentation
        run: pnpm run lint

      - name: Documentation Type Check
        working-directory: documentation
        run: pnpm run typecheck

      - name: Build documentation site
        run: pnpm run docs:build

      - name: Install documentation browser
        run: pnpm exec playwright install --with-deps --only-shell chromium

      - name: Test documentation integration
        run: pnpm run docs:integration:test

      # Only on the deploy paths (develop push / manual redeploy); the deploy job consumes this.
      # Uploading the artifact needs no extra permissions — `pages: write` lives on the deploy job.
      - name: Upload Pages artifact
        if: ${{ inputs.upload_pages_artifact }}
        uses: actions/upload-pages-artifact@v5
        with:
          path: documentation/build