1
name: Compat Flag Docs
2
 
3
on:
4
  pull_request:
5
    paths:
6
      - 'src/workerd/io/compatibility-date.capnp'
7
  merge_group:
8
 
9
permissions:
10
  contents: read
11
 
12
concurrency:
13
  group: compat-flag-docs-${{ github.event.pull_request.number || github.run_id }}
14
  cancel-in-progress: true
15
 
16
jobs:
17
  check-compat-flag-docs:
18
    runs-on: ubuntu-latest
19
    timeout-minutes: 5
20
    # Only run on internal PRs – forks can't query the docs repo.
21
    if: >-
22
      github.event_name == 'merge_group' ||
23
      github.event.pull_request.head.repo.full_name == github.event.pull_request.base.repo.full_name
24
    steps:
25
      - uses: actions/checkout@v6
26
        with:
27
          fetch-depth: 0
28
          show-progress: false
29
      - name: Check that new compat flags have documentation
30
        env:
31
          GH_TOKEN: ${{ github.token }}
32
          GITHUB_BASE_SHA: ${{ github.event.pull_request.base.sha }}
33
        run: python3 .github/scripts/check-compat-flag-docs.py