Skip to content

docs: record 0.2.0 in the changelog on main - #37

Open
RobertoIskandarani wants to merge 1 commit into
mainfrom
docs/record-0.2.0-on-main
Open

docs: record 0.2.0 in the changelog on main#37
RobertoIskandarani wants to merge 1 commit into
mainfrom
docs/record-0.2.0-on-main

Conversation

@RobertoIskandarani

Copy link
Copy Markdown
Collaborator

main carries the released notes under [Unreleased]. 0.2.0 was stabilized on its own branch and the commit that renamed the heading lives only there — release.yml deletes the release branch after tagging, so nothing brings it home.

What changes

Two added lines: the ## [0.2.0] - 2026-09-09 heading, and the now-empty [Unreleased] above it. No note is edited, moved or reworded.

Verified rather than assumed: the resulting ## [0.2.0] section is byte-identical to the one at the v0.2.0 tag — 204 lines, checked by extracting both and diffing.

Byte-exactness holds here, unlike last time

The 0.1.0 back-port had to break that rule on purpose. Its tagged section carried ### Changed with a migration note and ### Fixed, on a first release — entries that were deltas against pre-release states, and meaningless to anyone reading published notes. Correcting that meant main deliberately differing from the tag.

None of it applies to 0.2.0. It is a real delta against 0.1.0, its sections describe changes that actually happened, and the migration notes have a version to migrate from. So the copy is exact, and any correction to these notes belongs in the GitHub Release body rather than in main.

Third release in a row doing this by hand

cut-release opens a back-port PR that bumps POM versions and nothing else; release.yml reads the section on the release branch and never writes to the default branch. Tracked.

Verification

mvn verify green across all four modules against the pinned conformance catalog.

Two added lines: the `## [0.2.0] - 2026-09-09` heading and the now-empty
`[Unreleased]` above it. No note is edited, moved or reworded.

Verified rather than asserted: the resulting `## [0.2.0]` section is
byte-identical to the one at the `v0.2.0` tag, 204 lines, checked by
extracting both and diffing.

Byte-exactness is the rule here and it holds, unlike the 0.1.0
back-port. That one had to depart from it deliberately, because the
tagged section carried `Changed` and `Fixed` with a migration note on a
*first* release — deltas against pre-release states, meaningless to
anyone reading published notes. Nothing like that applies to 0.2.0: it
is a real delta against 0.1.0, its sections describe changes that
happened, and the migration notes have somewhere to migrate from. So
the copy is exact and any correction to these notes belongs in the
GitHub Release body rather than here.

The release flow still does not do this by itself — `cut-release` opens
a back-port PR that bumps POM versions and nothing else, and
`release.yml` reads the section on the release branch, which is deleted
post-tag. Third release in a row that needs this by hand.
@RobertoIskandarani
RobertoIskandarani requested a review from a team as a code owner September 9, 2026 14:02
@RobertoIskandarani RobertoIskandarani self-assigned this Sep 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant