sdk-python/.github/workflows/docs-pr.yml at main · durable-workflow/sdk-python · 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
name: Docs PR checks

on:
  pull_request:
    branches: [main]
    paths:
      - 'src/**'
      - 'docs/**'
      - 'overrides/**'
      - 'mkdocs.yml'
      - 'pyproject.toml'
      - 'scripts/ci/classify_docs_visual_changes.py'
      - 'scripts/ci/test-classify-docs-visual-changes.py'
      - 'scripts/ci/validate-release-docs-source.py'
      - 'scripts/api_reference_release.py'
      - 'scripts/check_api_reference_install.py'
      - 'scripts/check-docs-analytics.py'
      - 'scripts/check-docs-layout.py'
      - 'scripts/mkdocs_hooks.py'
      - '.github/workflows/docs.yml'
      - '.github/workflows/docs-pr.yml'
      - '.github/workflows/docs-visual.yml'

permissions:
  contents: read

concurrency:
  group: docs-pr-${{ github.event.pull_request.number }}
  cancel-in-progress: true

jobs:
  validate:
    name: Strict documentation build and rendered layout
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803  # v6

      - uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1  # v6
        with:
          python-version: "3.12"

      - name: Install package + docs deps
        run: pip install -e '.[docs]'

      - name: Install browser for responsive layout checks
        run: python -m playwright install --with-deps chromium

      - name: Build site
        run: |
          python scripts/ci/test-classify-docs-visual-changes.py
          mkdocs build --strict
          python scripts/check_api_reference_install.py --site site
          python scripts/check-docs-analytics.py site
          python scripts/check-docs-layout.py site

  visual-evidence:
    name: Supported viewport interaction evidence
    uses: ./.github/workflows/docs-visual.yml  # local
    with:
      source_base_sha: ${{ github.event.pull_request.base.sha }}
    permissions:
      contents: read