Skip to content

docs(changelog): the BDC entry documents the next release, not a published one - #1044

Closed
dgunning wants to merge 1 commit into
mainfrom
fix/changelog-bdc-entry-section
Closed

docs(changelog): the BDC entry documents the next release, not a published one#1044
dgunning wants to merge 1 commit into
mainfrom
fix/changelog-bdc-entry-section

Conversation

@dgunning

Copy link
Copy Markdown
Owner

#990 branched from 2df53a2c on 2026-08-07, when the entries now dated 5.46.0 were still under [Unreleased]. It added its own entry to that block, and eight days later the squash merge applied the hunk by context — into a section that had since been released.

Two consequences, both wrong in opposite directions:

  • 5.46.0's published changelog claims a feature it does not contain. That release went out on 2026-08-07; the BDC parsing work merged on 2026-08-15.
  • The next release would ship the BDC work undocumented, because [Unreleased] had no entry for it at all.

Moved to [Unreleased] under a ### Changed heading. I extended the text with the two label-shape fixes and the ticker count, since those are what a reader upgrading actually needs to know, and added the (GH #990) reference. 5.46.0 keeps its other 22 entries unchanged, and the entry appears exactly once in the file.

Found while checking whether [Unreleased] was ready to be cut as 5.49.0 — it wasn't.

Worth knowing for any long-lived branch: a CHANGELOG hunk written against [Unreleased] does not follow that heading when a release is cut underneath it. Git matches context lines, and the context is the neighbouring entries, which move into the dated section with it.

🤖 Generated with Claude Code

…ished one

#990 branched from 2df53a2 on 2026-08-07, when the entries now dated 5.46.0
were still under [Unreleased]. It added its own entry to that block, and eight
days later the squash merge applied the hunk by context — into a section that
had since been released.

So 5.46.0's published changelog claimed a feature it does not contain, and the
BDC work would have shipped in the next release undocumented. Moved to
[Unreleased] under a `### Changed` heading, with the two label-shape fixes and
the ticker count added, since those are what a reader upgrading actually needs.
5.46.0 keeps its other 22 entries unchanged.

Worth knowing for any long-lived branch: a CHANGELOG hunk written against
[Unreleased] does not follow that heading when a release is cut underneath it.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@dgunning dgunning mentioned this pull request Aug 15, 2026
@dgunning

Copy link
Copy Markdown
Owner Author

Superseded by #1045, which folded this correction into the 5.49.0 release commit. Keeping the two apart risked the same squash-merge collision that #1043 hit earlier today, since both touch adjacent lines of CHANGELOG.md. The entry now sits under ## [5.49.0] - 2026-08-15, and 5.46.0 keeps its other 22 entries unchanged.

@dgunning dgunning closed this Aug 15, 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