docs: record the lockfile step and the approval gate in the release flow - #63
Merged
Merged
Conversation
Two things the 1.2.0 release hit that neither document mentioned.
`make lock` belongs to the version bump. The package is a member of its
own workspace, so uv.lock records project.version. Bumping pyproject.toml
alone leaves the two disagreeing, and every `uv sync --locked` then fails:
The lockfile at `uv.lock` needs to be updated, but `--locked` was provided.
That includes the release workflow's own sync step, so the release fails
before it builds anything. Both files now move together in step 1.
The `pypi` environment has a required reviewer. The run parks at `waiting`
after the artifacts are built and publishes nothing until someone approves
the deployment. The previous wording ("the workflow publishes that version
if CI passes and the tag matches") reads as if a green matrix were enough,
which invites treating a paused release as a finished one.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Two gaps the 1.2.0 release walked into. Neither is a code change; both cost time because the documented flow was incomplete.
make lockis part of the bumpThe package is a member of its own workspace, so
uv.lockrecordsproject.version. Bumpingpyproject.tomlalone leaves the two disagreeing, and everyuv sync --lockedthen fails:That includes the release workflow's own sync step, so a release bumped this way fails before it builds anything. Step 1 in
CLAUDE.mdnow moves both files together, and theCONTRIBUTING.mdflow gains themake lockline it was missing.A green matrix is not a published release
The
pypienvironment carries a required reviewer. AfterBuild Releaseuploads the artifacts, the run parks atwaitingand publishes nothing until someone approves the deployment.The old
CONTRIBUTING.mdsentence read:Both conditions can hold with the package still unpublished, which invites reading a paused release as a finished one. During 1.2.0 the run sat at
waitingwith all 21 checks green and1.1.2still the latest on PyPI. Both documents now say the approval is a third condition, and that the run's own status is what to check.Verification
Documentation only, no code or workflow changes.
CIon this PR still exercises the full matrix.🤖 Generated with Claude Code