meta/.github/workflows/docs.yml at main · kitconcept/meta · 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
name: Documentation

on:
  workflow_call:
    inputs:
      python-version:
        required: false
        type: string
        default: "3.14"
      working-directory:
        required: false
        type: string
        default: docs

jobs:

  deprecation-notice:
    name: Deprecated
    runs-on: ubuntu-latest
    steps:
      - name: Report deprecation
        run: |
          MESSAGE="This workflow is deprecated and will be removed. Use plone/meta/.github/workflows/docs-build.yml@2.x instead."
          echo "::warning title=Deprecated workflow::${MESSAGE}"
          {
            echo "> [!WARNING]"
            echo "> ${MESSAGE}"
          } >> "$GITHUB_STEP_SUMMARY"
  docs:
    name: Documentation
    runs-on: ubuntu-latest
    defaults:
      run:
        working-directory: ${{ inputs.working-directory }}
    steps:
      - uses: actions/checkout@v7

      - name: Install the latest version of uv
        uses: astral-sh/setup-uv@v10.0.1
        with:
          python-version: ${{ inputs.python-version }}
          enable-cache: false

      - name: Restore uv cache
        uses: actions/cache@v6
        with:
          path: ${{ env.UV_CACHE_DIR }}
          key: uv-${{ runner.os }}-${{ inputs.python-version }}-${{ hashFiles('uv.lock') }}
          restore-keys: |
            uv-${{ runner.os }}-${{ inputs.python-version }}-${{ hashFiles('uv.lock') }}
            uv-${{ runner.os }}-${{ inputs.python-version }}

      - name: Install Dependencies
        run: make install

      - name: Check for broken links
        run: make linkcheckbroken

      - name: Build HTML documentation
        run: make build