Render real release notes instead of preview text on tag builds - #51
Open
piotrekno1 wants to merge 3 commits into
Open
piotrekno1 wants to merge 3 commits into
piotrekno1 wants to merge 3 commits into
Conversation
Fix two stale bits in the release artifact path found while verifying: llms.txt carried the retired on-device-only tagline, and build_changelog_comment.py still imported tomllib, which breaks the release-PR preview on any runner whose default python3 is 3.10. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01TVrfA4Xy9wWmifB9JZc8Es
Release 0.2.1
release.yml and release-pr.yml share build_changelog_comment.py, but the script only ever emitted the PR wording, so every tag build published notes headed "Changelog preview for vX" over a blockquote promising notes that would be generated "when this is tagged" — on the tag's own release. Past releases were hand-edited afterwards; the generator was never fixed. release.yml sets TAG_NAME from github.ref_name and release-pr.yml never sets it, so its absence distinguishes the two callers with no workflow change. Adds the first tests for this script, covering both wordings, the first-release range fallback, and the empty range. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01TVrfA4Xy9wWmifB9JZc8Es
Coverage report
Top uncovered files
|
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.
Follow-up to the 0.2.1 release, where the published
v0.2.1notes came out headed "Changelog preview forv0.2.1" above a blockquote promising notes that would be generated "when this is tagged" — on the tag's own release.Cause
release.ymlandrelease-pr.ymlsharescripts/build_changelog_comment.py, but the script only ever emitted the PR wording. It is not a regression: the string is byte-identical atv0.2.0.The v0.2.0 and v0.1.5 releases read "Changelog for
vX" because their bodies were hand-edited after publishing. The generator was never fixed, so every tag build has quietly required that cleanup.Fix
release.ymlsetsTAG_NAMEfromgithub.ref_name;release-pr.ymlnever sets it. That difference already distinguishes the two callers, somain()derivespreview = not TAG_NAMEandbuild_comment()takes it as a keyword-only argument. No workflow change needed.Verified against both real invocations on a clean clone, on Python 3.10 (which also re-confirms the
tomllibremoval shipped in 0.2.1):Tests
First tests for this script: both wordings, the first-release range fallback, the empty-commit-range case, the release-commit filter, and that
get_version()works withouttomllib.601 passed, 36 skipped;
ruff checkclean.Note, not fixed here
RELEASE_COMMIT_REonly matches^Release \d+\.\d+\.\d+$, so the subjects used by earlier releases —Bump version to 0.1.5,0.1.4 release bump— slip through into the notes. Harmless while release commits keep the currentRelease X.Y.Zform; worth tightening only if that convention drifts again.This PR also carries the 0.2.1 release commit back to
devel, which was otherwise still behindmain.🤖 Generated with Claude Code
https://claude.ai/code/session_01TVrfA4Xy9wWmifB9JZc8Es