Repository navigation
scripts: unreleased changes as one file each under changelog.d - #214
Merged
Merged
Conversation
Every PR with a user-visible change appended under "## [Unreleased]" in CHANGELOG.md, so PRs open at the same time conflicted on the same lines and each needed a hand merge after the one before it landed; three of the last six did. Each change now adds its own file under changelog.d/. scripts/changelog.py checks the files (make check runs it), shows everything unreleased, merged by section and as JSON, and at release folds them and any lines still under Unreleased into a new version, updates the compare links and deletes the files. Signed-off-by: Yi-Ru Lin <deduce@gmail.com>
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.
Every PR with a user-visible change appended a line under
## [Unreleased]inCHANGELOG.md. PRs open at the same time therefore conflicted on the same lines, and each one needed a hand merge after the previous one landed. Three of the last six PRs did.Each change now adds its own file under
changelog.d/, so parallel PRs never touch the same lines. The format is described inchangelog.d/README.md.scripts/changelog.pydoes three things:checkvalidates every fragment: known Keep a Changelog section, entries starting with-, and file:line in each error.make checkruns it.show [--json]prints everything unreleased, merged by section: what is still inCHANGELOG.mdplus the fragments.release VERSION [DATE]folds all of it into## [VERSION] - DATE, updates the compare links and deletes the fragments. It refuses a version that is already released.The lines already under Unreleased stay where they are, and the release folds them in too, so open PRs that edit
CHANGELOG.mdkeep working.AGENTS.md now states the rule. Tests are in
scripts/test-changelog.sh.