Skip to content

Protect release refs and gate publishing #14

Closed

Description

@MushuEE

Part of #12. Follows google/ax#547.

Goal

Release tags and publishing are controlled by GitHub, not by convention, and the rules are reviewable in the repo.

Current state

  • Protect main: blocks deletion and force-push, requires a PR with 1 approval, clears approvals on new commits, and requires the License headers check.
  • protect-tags: applies to all tags. Blocks create, update and delete, and requires names matching ^v\d+\.\d+\.\d+(-[0-9A-Za-z.-]+)?$. Repository admins can bypass it, so today only admins can push a release tag.
  • Both exist only in the GitHub UI.
  • There is no release environment, and none is planned (see below).

Work

  • Rulesets as code (ci: manage repository rulesets as code #23). Export both rulesets to .github/rulesets/*.json, add a script that applies them (matched by name, with a dry-run mode), and a check that reports drift between the files and the live rulesets. Port from google/ax (hack/apply-rulesets.sh, .github/workflows/rulesets.yml, docs/rulesets.md).
  • Decide who can tag. Decided: only repository admins can create release tags. This is what protect-tags already enforces, so the ruleset doesn't change.
  • release environment. Decided: not needed. Publishing is gated by tag protection alone, as in ai-on-gke/substrate-gke, which has no environments.
  • Make tags immutable, as in substrate-gke (ci: make release tags immutable, as in substrate-gke #24). Split protect-tags into protect-tags-create (admins can bypass) and protect-tags-immutable (nobody can), so a tag can't be moved or deleted once it exists.
  • Required checks on main. Decided: dropped. License headers stays the only required check.
  • Releasing doc. docs/releasing.md: how to cut a prerelease and a release, what the workflow publishes, and how to make a new package public.

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions