connect-py/.github/workflows/docs.yaml at main · connectrpc/connect-py · 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: Documentation
on:
  push:
    branches:
      - main
    paths:
      - "docs/**"
      - "src/**"
      - "connectrpc-fastapi/**"
      - "connectrpc-grpchealth/**"
      - "connectrpc-grpcreflect/**"
      - "connectrpc-otel/**"
      - zensical.toml
      - ".github/workflows/docs.yaml"
  pull_request:
    paths:
      - "docs/**"
      - "src/**"
      - "connectrpc-fastapi/**"
      - "connectrpc-grpchealth/**"
      - "connectrpc-grpcreflect/**"
      - "connectrpc-otel/**"
      - zensical.toml
      - ".github/workflows/docs.yaml"

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

concurrency:
  # Use a constant key for commits so deployments are queued in order.
  # Cancel in-progress jobs for PRs only
  group: ${{ github.workflow }}-${{ github.event_name == 'pull_request' && github.ref || 'deploy' }}
  cancel-in-progress: ${{ github.event_name == 'pull_request' }}

jobs:
  build:
    environment:
      name: ${{ github.event_name != 'pull_request' && 'github-pages' || null }}
      url: ${{ steps.deployment.outputs.page_url }}

    runs-on: ubuntu-26.04

    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

      - uses: astral-sh/setup-uv@68559e99cc807c1eb7e9238fd43a15bba460eec2 # v10.3.3

      - run: uv run poe docs-build

      - uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
        if: github.event_name != 'pull_request'
        with:
          path: site

      - uses: actions/deploy-pages@368f82528645a54fb793d4d04e342629a3f51346 # v5.0.1
        if: github.event_name != 'pull_request'
        id: deployment