Skip to content

Say which tags can be rehearsed, and which cannot - #63

Merged
danielplohmann merged 1 commit into
mainfrom
docs/rehearsal-ref-qualifier
Sep 15, 2026
Merged

danielplohmann merged 1 commit into
mainfrom
docs/rehearsal-ref-qualifier

Conversation

@danielplohmann

Copy link
Copy Markdown
Owner

RELEASING.md told a maintainer to rehearse by "choosing a tag as the ref", without saying that only a tag cut after #59 can be one.

A workflow_dispatch run resolves the workflow file from the ref it is given, and the verify job then checks out that same ref to run release_guard.py. Neither exists on a tag from before the workflow landed, so a rehearsal from v0.5.0 fails without naming the cause. I found this the useful way, by recommending exactly that as the way to seed TestPyPI.

Verified against this repository: git ls-tree -r v0.5.0 .github/workflows/ lists ci.yml, fuzz.yml, release.yml and validate.yml — no publish-release.yml, and no scripts/ directory for the guard.

The section now also records two things that follow from the same property:

  • v0.3.0, v0.4.0 and v0.5.0 are inert. A tag only triggers a workflow that exists on it, so re-pushing one of those cannot publish anything.
  • How to rehearse a version before it ships. Pushing the tag starts the real run, which a required reviewer on the pypi environment holds at the publish job; the rehearsal runs from the same tag while it waits, and approve-or-reject comes after. Rejecting leaves the version number unused.

Docs only — no entry required by the Changelog check, which fires on purepdb/ and pyproject.toml.

🤖 Generated with Claude Code

"Choosing a tag as the ref" is true only of a tag cut after the workflow
existed. A manual run resolves the workflow file, and checks out the guard
script it calls, from the ref it is given, so v0.5.0 and earlier carry neither
and fail in a way that does not name the cause. Verified against this
repository: `git ls-tree v0.5.0 .github/workflows/` lists the old release.yml
and no publish-release.yml, and no scripts/ at all.

The same property is worth stating as the reassurance it also is: those three
tags cannot trigger a publish if one is ever re-pushed.

Also records how to rehearse a version before it ships, which the required
reviewer on the `pypi` environment is what makes possible: the tag push parks
the real run at the publish job, the rehearsal runs from the same tag while it
waits, and the decision to approve or reject comes after.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@danielplohmann
danielplohmann merged commit 60326bf into main Sep 15, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant