Skip to content

fix(release): take a changelog section for a tagged version as history - #38

Merged
bpapaspyros merged 3 commits into
mainfrom
fix/changelog-history
Oct 27, 2026
Merged

bpapaspyros merged 3 commits into
mainfrom
fix/changelog-history

Conversation

@bpapaspyros

@bpapaspyros bpapaspyros commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

What and why

A repository released by its root CHANGELOG.rst can only gain one version section per pull request, and only in a release: one. That also refuses the changelog of releases made before the file existed, which every repository moving to changelog releases has, this one included.

  • check_release_pr.py: a section for a version that already has a v<version> tag is history, not a release. It no longer counts as an added section, so any pull request may add it. A section for an untagged version is checked as before.
  • CHANGELOG.rst: the releases from 1.0.0 to 1.16.1, one section per tag, from the commits between them. 1.13.0 was tagged on the same commit as 1.12.0, so it reads "No changes."
  • README: one line on history sections.

Testing

  • Ran prepare_release.py --changelog over this CHANGELOG.rst. It writes the 1.17.0 section on top and leaves the history as it is.
  • check_changelog_format.py reads the new file, and the shared pre-commit config passes.
  • Tests updated, or not applicable
  • Docs updated, or not applicable
  • This changes or removes something existing (if so, title needs ! and means the next release is a major version bump)

Notes

  • With this on main, the next release pull request carries the history. A release branch prepared before it does not.

@bpapaspyros bpapaspyros self-assigned this Oct 27, 2026
@bpapaspyros
bpapaspyros requested a review from mbloechli October 27, 2026 14:04

@mbloechli mbloechli left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good to me

@bpapaspyros
bpapaspyros merged commit d4e3796 into main Oct 27, 2026
3 checks passed
@bpapaspyros
bpapaspyros deleted the fix/changelog-history branch October 27, 2026 16:44
@duatic-release duatic-release Bot mentioned this pull request Oct 27, 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.

2 participants