docs: document publish_release dispatch mechanics - #569
Merged
Conversation
leoschwarz
changed the title
leoschwarz
force-pushed
the
docs/bfabric-scripts-1.15.1-note
branch
from
July 30, 2026 08:28
b1d4d20 to
d777f86
Compare
leoschwarz
changed the title
Records what the bfabric_scripts 1.15.1 hotfix surfaced: an environment=test "dry run" pushes the real tag and blocks the production run; entry points must be verified by module import, since @use_client connects before argparse; and GitHub's single repo-wide "Latest release" badge means a stable non-core release must not claim it. Also corrects the hotfix convention. A hotfix whose fix cannot apply to main has nothing to forward-port and so nothing to put in main's changelog: an [Unreleased] bullet would be promoted into the next release's notes, describing a change that release does not contain.
leoschwarz
force-pushed
the
docs/bfabric-scripts-1.15.1-note
branch
from
July 30, 2026 08:30
d777f86 to
144d453
Compare
leoschwarz
marked this pull request as ready for review
July 30, 2026 08:32
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.
The
bfabric-scripts1.15.1 hotfix (metadata-only cap ofbfabricto<1.19, released off thebfabric_scripts/1.15.0tag) surfaced three release-mechanics traps that weren't written down anywhere. This adds them to AGENTS.md:environment: testis not a dry run. Create and push tag and Create GitHub Release are ungated and run before the publish step, so a test run consumes the tag and the production run then dies atgit tag -abefore reaching PyPI.uv pip install --no-sources, and check entry points by module import rather than--help—@use_clientcallsBfabric.connect()before the wrapped function runs, so--helpreads~/.bfabricpy.ymlfirst and can fail for reasons unrelated to the release.rcNand0.xtags are auto-flagged prerelease and never compete for it.It also corrects the hotfix convention. A hotfix whose fix can't apply to
mainhas nothing to forward-port, and therefore nothing to add tomain's changelog — an[Unreleased]bullet would be promoted into the next release's notes, describing a change that release doesn't contain. 1.15.1 is recorded by its tag and its published GitHub release.🤖 Prepared with assistance from Claude Opus 5 via Claude Code.