Skip to content

Commit 824101e

Browse files
committed
ci: add docs-privacy gate (check_docs_private_markers on docs/**)
1 parent 5ca70fa commit 824101e

2 files changed

Lines changed: 28 additions & 0 deletions

File tree

.github/workflows/docs-privacy.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# docs-privacy.yml — docs-privacy gate. Required check name: "docs-privacy".
2+
# Proves no private piloting marker leaks into the published docs/** (anti-regression
3+
# at HEAD). check_docs_private_markers is decidable and prefix-anchored (METHOD section 6).
4+
name: docs-privacy
5+
on:
6+
pull_request:
7+
push:
8+
branches: [main]
9+
permissions:
10+
contents: read
11+
jobs:
12+
docs-privacy:
13+
name: docs-privacy
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
17+
- uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
18+
with:
19+
python-version: "3.12"
20+
# Exact-version pin (determinism + CI<->local parity) via the runtime group.
21+
- run: python -m pip install --upgrade pip && pip install --group runtime
22+
# Gate command single-sourced in scripts/gates/docs-privacy.sh (S31).
23+
- run: bash scripts/gates/docs-privacy.sh

scripts/gates/docs-privacy.sh

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
#!/usr/bin/env bash
2+
# Gate command for the `docs-privacy` CI check, single-sourced (METHOD section 6 / S31).
3+
# Proves no private piloting marker leaks into docs/** (check_docs_private_markers).
4+
set -e
5+
python scripts/check_docs_private_markers.py

0 commit comments

Comments
 (0)