Repository navigation
docs: unprefixed release tags run nothing rather than failing fast - #74
Merged
Merged
Conversation
RELEASING.md said a tag not equal to v + __version__ fails the build fast. That only holds for a v-prefixed tag; an unprefixed one matches no publish.yml trigger and runs nothing, which is how 0.2.0 and 0.3.0.dev20260808 went unpublished (#34). README's Installation note also tied PyPI availability to a release being tagged, though tags exist and none was published. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The workflow never running is observable; whether PyPI's one-time setup would also have blocked a publish is not, so drop the causal claim. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Member
Author
|
Self-review rubric (head 7ace2f9):
One finding, now fixed: the first revision said the unprefixed tags were "why no release has been published". That overstated the cause, because PyPI's one-time Trusted Publisher setup could also be missing and cannot be checked from the repository. Commit 7ace2f9 narrows the claim to the observable fact that the publish workflow has never run. Out-of-diff note: the step-3 example in This review comment was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener). drafted by Claude on behalf of Daniel Stephenson |
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
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.
Summary
Stage A documentation accuracy sweep. Two claims were found to disagree with the repository's actual release state:
RELEASING.mdstated that a tag not equal tov+__version__makes "the build fail fast before anything is published". That holds only for av-prefixed tag with a mismatched version. A tag without the prefix matches nopublish.ymltrigger (v*.*.*), so the workflow never runs and nothing is reported. The remote tags0.2.0and0.3.0.dev20260808are unprefixed, andgh run list --workflow publish.ymlreturns zero runs. The paragraph now describes both failure modes and links release: version tags are pushed without the 'v' prefix publish.yml requires, so no release has ever been published #34.README.mdsaidpip install graphik"will not resolve until the first release is tagged". Release tags already exist, but nothing has been published, so the wording now says "published".No code, workflow or version file is changed. #34 stays open: the choice between fixing the tagging practice and broadening the trigger is still a maintainer decision. This PR only stops the docs from contradicting that issue.
Issues skipped this cycle
Every open issue is waiting on a maintainer decision or touches a path excluded from autonomous change:
.github/workflows/.preponderous.*projects use, which cannot be determined from this repo.Test plan
.github/workflows/publish.yml(triggerv*.*.*),git ls-remote --tags origin, andgh run list --workflow publish.yml(no runs)pytest: not run, because the dispatch sandbox denied the command. Recorded as UNVERIFIED-not-applicable since only Markdown files change. CI (test.yml) runs on this PR.No tracking issue: the drift was found during the triage sweep. The PR references #34 but does not close it.
This PR description was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).
🤖 Generated with Claude Code
drafted by Claude on behalf of Daniel Stephenson