sdk-python/.github/workflows/docs.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
63
64
name: Docs deployment

on:
  push:
    branches: [main]
    paths:
      - 'src/**'
      - 'docs/**'
      - 'mkdocs.yml'
      - 'pyproject.toml'
      - 'scripts/check-docs-analytics.py'
      - 'scripts/check-docs-layout.py'
      - '.github/workflows/docs.yml'
      - '.github/workflows/docs-pr.yml'

permissions:
  contents: read

concurrency:
  group: docs-deployment
  cancel-in-progress: false

jobs:
  build:
    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: |
          mkdocs build --strict
          python scripts/check-docs-analytics.py site
          python scripts/check-docs-layout.py site

      - name: Upload GitHub Pages artifact
        if: ${{ github.server_url == 'https://github.com' }}
        uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9  # v5
        with:
          path: site

  deploy:
    needs: build
    if: ${{ github.server_url == 'https://github.com' && github.ref == 'refs/heads/main' }}
    runs-on: ubuntu-latest
    permissions:
      contents: read
      id-token: write
      pages: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - id: deployment
        uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128  # v5