Skip to content

Commit fbf7a94

Browse files
committed
docs: align release controls with live enforcement
1 parent fa84741 commit fbf7a94

2 files changed

Lines changed: 30 additions & 15 deletions

File tree

‎.github/CODEOWNERS‎

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,17 @@
33
# reviewer other than the last pusher.
44
/.github/workflows/package.yml @codeforester @rameshulugar
55
/.github/workflows/issue-branch-policy.yml @codeforester @rameshulugar
6+
/.github/CODEOWNERS @codeforester @rameshulugar
67
/VERSION @codeforester @rameshulugar
7-
/pyproject.toml @codeforester @rameshulugar
8-
/requirements/ @codeforester @rameshulugar
9-
/scripts/validate_* @codeforester @rameshulugar
10-
/scripts/verify_* @codeforester @rameshulugar
8+
/requirements/release.in @codeforester @rameshulugar
9+
/requirements/release.txt @codeforester @rameshulugar
10+
/scripts/validate_package_artifact.py @codeforester @rameshulugar
11+
/scripts/validate_release_docs.py @codeforester @rameshulugar
12+
/scripts/validate_release_metadata.py @codeforester @rameshulugar
13+
/scripts/validate_release_provenance.py @codeforester @rameshulugar
14+
/scripts/validate_release_ref.py @codeforester @rameshulugar
15+
/scripts/verify_pypi_metadata.py @codeforester @rameshulugar
16+
/scripts/verify_release_assets.py @codeforester @rameshulugar
1117
/scripts/generate_release_metadata.py @codeforester @rameshulugar
1218
/scripts/release_metadata_helpers.py @codeforester @rameshulugar
19+
/docs/releasing.md @codeforester @rameshulugar

‎docs/releasing.md‎

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,17 +20,24 @@ Production releases use a matching annotated tag such as `v0.1.0`, created from
2020
updates, and tags that do not exactly match `v${VERSION}` are rejected before
2121
publication. The workflow fetches the complete trusted `main` history so an
2222
ancestor check fails closed instead of relying on shallow checkout state.
23-
The active default-branch ruleset also requires one approving pull-request
24-
review, approval from someone other than the last pusher, strict up-to-date
25-
status checks, and the policy, quality, runtime, and consumer checks listed in
26-
the repository ruleset. Deletion and non-fast-forward updates are disabled.
23+
The default-branch and `v*` tag rulesets are release prerequisites. Before a
24+
production tag is created, an independent maintainer must verify in the live
25+
repository settings that the default branch requires one approving pull-request
26+
review from someone other than the last pusher, strict up-to-date status checks,
27+
and the policy, quality, runtime, and consumer checks listed in the ruleset.
28+
The same verification must confirm that tag deletion and non-fast-forward
29+
updates are disabled and that no unreviewed bypass actor is configured. This
30+
document describes the required controls; it does not treat a ruleset as active
31+
until that live readback has been recorded in the release evidence.
2732

2833
Release-path changes are additionally covered by `.github/CODEOWNERS`, including
29-
the package workflow, `VERSION`, packaging metadata, release locks, and release
30-
validators. Maintainers must review the complete diff, and the independent
31-
reviewer must rerun the quality and release gates before a production tag is
32-
created. The repository ruleset protects `v*` tags from deletion and force
33-
updates; bypass actors are intentionally empty.
34+
the package workflows, `VERSION`, the hash-locked release toolchain, the
35+
artifact/provenance validators, and this release procedure. CODEOWNERS is a
36+
review-routing control, not enforcement by itself: the protected-branch
37+
ruleset must require the matching owner review and protect the CODEOWNERS file.
38+
The independent reviewer must rerun the quality and release gates before a
39+
production tag is created. The tag ruleset must protect `v*` tags from deletion
40+
and force updates; bypass actors must be intentionally empty.
3441

3542
If a maintainer credential is suspected to be compromised, pause publication,
3643
revoke the affected token or OIDC trust, preserve the workflow run and review
@@ -78,8 +85,9 @@ the exact reviewed wheel, sdist, `SHA256SUMS`, `SBOM.spdx.json`, and
7885
`RELEASE-BOM-ROW.json` downloaded from the build job. GitHub-generated
7986
comparison notes are supplemented by the
8087
dated section in `CHANGELOG.md`; the tagged release is rejected when `VERSION`
81-
or that section does not match the tag. Published tags and release assets are
82-
immutable. Before creating a release, the workflow verifies that the tag still
88+
or that section does not match the tag. Once the live `v*` tag ruleset has been
89+
verified, published tags and release assets are treated as immutable. Before
90+
creating a release, the workflow verifies that the tag still
8391
resolves to the reviewed commit, that the wheel and sdist have provenance and
8492
SBOM attestations for that tag and commit, and that the release metadata binds
8593
the same version, commit, and assets. If an existing GitHub Release is found,

0 commit comments

Comments
 (0)