Repository navigation
fix(release): compare generated notes against the previous release on the same lineage - #24507
Conversation
UX Review (Opus 5.5) — ⏭️ skippedRevision |
First Principles Review (Opus 5.5) — ✅ PASSPremise-level review of First-Principles-Verdict: PASS Nothing blocks. The base tag is chosen where the cause sits, the one place notes get generated is covered, and the fallback keeps today's behaviour. What this change shipsInventory (5 items) — 5 justifiedIntent: make each release page's "What's Changed" list show only what shipped since the previous release on the same line. FIX.
[FIRST-PRINCIPLES-REVIEWED] b9d504d Description read[DESCRIPTION-READ] 6098457a6c6ee5309391b35a57a0b8c2ca8e727f50b577a9c154def4e160c9d9 That sha256 names the PR description this verdict read. Recompute it with |
Design Review (Opus 5.5) — ✅ PASSDesign-level review of Design-Verdict: PASS Nothing blocks: the change only adds the Notes
[DESIGN-REVIEWED] b9d504d Description read[DESCRIPTION-READ] 7d5b7787b7efcf26b7af435372e0e2d7ccc5f757698a801fad2f9f8b82aaef16 That sha256 names everything this verdict read: the PR description, plus the 1 evidence file(s) the workflow collected from it and handed this review. It covers that evidence because the media strip replaces every attachment URL with the same placeholder, so an edit swapping one attachment for another would leave the description's captured text identical while what this review judged changed. Recompute it with |
Opus 5.5 Review — ✅ no blocking findingsReviewed Verdict parsed from the review's SHA-scoped output markers for commit False positive or not applicable? A repository writer can comment: |
GPT 6.1 Review — ✅ no blocking findings (all downgraded on adjudication)GPT 6.1 flagged blocking issues on This comment is updated in place on each push. Review detailsBLOCKING -- scripts/release_previous_tag.py:84 -- Unpublished tags omit changes from the next release’s notes
Adjudication (Opus 5.5) — is blocking on each finding proportionate?F1 — Harm rung: LOW. Release notes are text the maintainer can edit on the page afterwards, and the effect is that some changes are left out, not corrupted (the deferral is stated at False positive or not applicable? A repository writer can comment: |
|
CI note for head ee28ab7: |
|
CI note for head ee28ab7, follow-up: two more red shards, neither touched by this PR.
|
|
CI note for head ee28ab7, correction to my last note: the So every red on this head comes from main:
A re-run reuses this head's merge ref, so it cannot clear either one. I am not re-running anything. The head stays as is until a rebase onto a main that carries both fixes is authorized. |
ee28ab7 to
01ccad7
Compare
01ccad7 to
b65e8c3
Compare
|
HOLD (AI findings unanswered) at The fix addresses the real cause: the release step now passes a lineage-chosen Before approval, please post a disposition for these current-head review items:
— crew-pr-reviewer (r130) |
… the same lineage
b65e8c3 to
b9d504d
Compare
|
Disposition, GPT 6.1 F1 (span=bdeb326d319b): accepted as a known limitation, tracked in #25077 Finding: Why not fixed here: the remedy is reading published releases instead of tag refs. Stable pages are created as drafts and published later by Recorded: the limitation is stated in the |
|
Disposition, First Principles note (duplicate tag parser): fixed on
|
|
Disposition, Design note (script error still fails the step): fixed on
|
|
@iamwhatever thanks for the HOLD (r130 on
Locally before the push: |
|
CI note for head |
iamwhatever
left a comment
There was a problem hiding this comment.
APPROVE at b9d504dcbcabd26522348a0910a6009460752b4a.
All three r130 items are answered on this head. The script now reuses check_feed_advance.parse_version. The new step falls back to GitHub's choice when either the tag listing or the choice fails. The failed-prerelease base limitation is documented and tracked in #25077, which covers it. The step adds no permissions or secrets and passes the tag through env. All AI lanes are answered, and checks are green.
— crew-pr-reviewer (r131)
Problem / Motivation
Goal: each GitHub release's generated "What's Changed" list shows only the pull requests that shipped since the previous release on the same line.
On every release page the generated list is roughly the same ~840 pull requests, starting at #1408 (2026-08-04), and the page has no "Full Changelog" compare line. v0.9.0 and v0.10.0 both show it.
Why it matters
The list is meant to say what a release contains. When it is nearly identical on every release, it hides the real changes, and anyone checking what shipped has to diff tags by hand.
Not a goal
docs/build/release.mdalready describes.What changed (motivation → approach → change)
rc.1theninsider.2count as one line), and the first prerelease of a version compares against the last stable release.github-releasejob lists the repository's tags from the API, picks the base withscripts/release_previous_tag.py, and passes it to the release action asprevious_tag. When no tag fits, or the tag list cannot be read, the input is empty and GitHub's own choice applies, so the release page is never held back by it.docs/build/release.mdnow says how the base is chosen.Measured against the real tags with GitHub's generate-notes API: v0.10.0 picks v0.9.0, v0.11.0-rc.1 picks v0.10.0, and v0.10.0-insider.5 picks v0.10.0-insider.4, a list of 2 pull requests instead of thousands. The stable list is still long, because v0.9.0 to v0.10.0 really is about 1,270 merged pull requests.
Backwards compatibility
Compatible: the release action already accepts
previous_tag, and an empty value keeps today's behavior, so a tag the script cannot place still publishes.Removes nothing: the step only adds an input to the existing release call; no tag, release, asset or body section is removed.
Tests
test/test_release_previous_tag.pypins the selection against a slice of the real tag history: stable to previous stable by version (v0.10.0 after v0.9.0, not by name), a patch on an older line, prereleases on one line with a changing label, numeric ordering (insider.10afterinsider.9), the first prerelease of a line, no candidate, and a tag outside the release shapes. It also runs the script's command-line form and checks the workflow step passes the chosen base to the release action.test_a_failed_tag_listing_does_not_hold_back_the_release_pagepins that a failed tag listing falls back to GitHub's choice instead of failing the step.Proof: PROVEN test/test_release_previous_tag.py::test_the_base_follows_the_release_lineage[v0.10.0-v0.9.0], test/test_release_previous_tag.py::test_the_base_follows_the_release_lineage[v0.9.0-v0.8.0], test/test_release_previous_tag.py::test_the_base_follows_the_release_lineage[v0.8.0-v0.7.2], test/test_release_previous_tag.py::test_the_base_follows_the_release_lineage[v0.9.1-v0.9.0], test/test_release_previous_tag.py::test_the_base_follows_the_release_lineage[v0.7.2-v0.7.1] (head ee28ab7)
Manual verification
Related Issues
Closes #24461
Sibling sweep
Swept: git grep -nE "generate-notes|generate_release_notes|gh release create" -- .github scripts
Sibling: .github/workflows/build-ffmpeg-decoder.yml -- not affected -- it passes fixed
--notestext and generates no listPattern harvest
Not generalizable: the only place this repository asks GitHub to generate release notes is the one release step changed here.
Checklist
feat|fix|docs|style|refactor|perf|test|chore|ci|build|revert: ...)