docs: repair v0.35.0 release notes and automate release notes validation and rotation - #1220
Draft
starius wants to merge 2 commits into
Draft
docs: repair v0.35.0 release notes and automate release notes validation and rotation#1220starius wants to merge 2 commits into
starius wants to merge 2 commits into
Conversation
starius
marked this pull request as ready for review
September 1, 2026 06:05
hieblmi
requested review from
alexbosworth
and
a lite review from Copilot
and removed request for
Copilot
September 1, 2026 09:17
Collaborator
|
@alexbosworth for acking the new release procedure |
hieblmi
requested changes
Sep 1, 2026
hieblmi
left a comment
Collaborator
There was a problem hiding this comment.
There seems to be a problem with non-merged PRs being wrongly taken into account for a release:
Example:
1. A feature PR branches from master when the version is 0.35.
2. Later, master is bumped to 0.36.
3. The feature PR still contains 0.35, although it never changed version.go.
4. CI compares master (0.36) with the PR (0.35) and mistakenly treats the feature PR as a release PR.
The check should compare the PR with its merge base, where both versions are 0.35.
1 task
starius
marked this pull request as draft
September 1, 2026 16:34
alexbosworth
requested changes
Sep 2, 2026
alexbosworth
left a comment
Member
There was a problem hiding this comment.
i think we should keep it simple on the release side, but could put more complexity in the release script itself in order to avoid mistakes
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.
Fixed v0.35.0 release notes and added a script which manages release notes.
scripts/release-notes.py rotate <tag> <highlights>- movesrelease-notes-next.mdinto a new versioned release notes file and updates cross-references.<highlights>is a short text describing this release, which is written to the table indocs/release-notes/README.mdscripts/release-notes.py pr <base-sha> <head-sha>run per-PR checks. If it is a regular PR, it checks thatrelease-notes-next.mdis updated (unlessno-changeloglabel is set). For a release PR (version bump) it checks thatrelease-notes-next.mdis blank and the versioned release notes file exists (i.e. the rotation has been done). This command is called by CI.scripts/release-notes.py release <tag>checks thatrelease-notes-next.mdis blank and the versioned release notes file exists. I.e. the same check thatscripts/release-notes.py prdoes for a version bump PR. This command is called by release building scripts (make docker-release tag=<tag-of-release>or./release.sh <tag-of-release>). To disable, passSKIP_RELEASE_NOTES_CHECK=1env var.The workflow to make a release is:
version.go.nextfile without requiring the tag.release.shverifies that the tag exists, points atHEAD, is signed, and matches the compiled version; and it checks again the versioned notes file and emptynextfile.Pull Request Checklist
docs/release-notes/release-notes-next.md, or apply theno-changeloglabel (required by CI)