Repository navigation
docs(changelog): a pull request leaves CHANGELOG.md alone; the release step writes it - #23
Merged
Merged
Conversation
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.
Summary
A pull request no longer touches
CHANGELOG.md. At release the maintainer runsjust changelog(git-cliff, already in the template) and edits its output into the file before tagging. This is the maintainer's decision "CHANGELOG at release, not in each PR" (no issue exists).Why: every PR that adds a line under
## [Unreleased]is the usual rebase conflict between open PRs in one package, and the entry is written from the commit messages at release either way.What changes in a generated project:
AGENTS.md: the "Commits, changelog, releases" bullet says a PR leavesCHANGELOG.mdalone and the entries are drafted at release; the commit message is the line a user will read. The command table saysjust changelogis for release.CONTRIBUTING.md: the "add a line under## [Unreleased]" step is gone (the steps are renumbered; the commit step says to leaveCHANGELOG.mdalone). The "Releasing" step 1 now opens "Write the changelog", with the samejust changelogand rename-the-heading steps as before. The recipe table says "run at release".CHANGELOG.mdcheckbox is removed.CHANGELOG.md: one sentence in the intro says PRs leave it alone and the entries are written at release.justfilecomment on thechangelogrecipe says "At release".README.md: the Changelog row says the same.Not changed: the
## [Unreleased]heading inCHANGELOG.mdand the release steps that rename it. Dropping the heading would conflict in every package'sCHANGELOG.mdatcopier update(each has its own entries under it); keeping it applies cleanly.cliff.toml,just releaseand the Publish workflow are untouched.Rollout (after a template release is tagged)
Each package:
copier update, then delete the line "User-visible changes go under## [Unreleased]" from its ownAGENTS.md. The maintainer's own brief for agents (kept outside this repo) drops its CHANGELOG instruction at the same time. This PR touches no package and tags nothing.Checks
just test(bakes both variants,publish_to_pypianddocs_notebooksyes and no; quality-check, docs build, pre-commit hooks, dist, version checks, and thejust changelogdraft check) in a Slurm job: passed for both variants (every hook, the docs build with its examples, the dist build, the version checks and thejust changelogdraft).AGENTS.md,CONTRIBUTING.md,CHANGELOG.mdand the PR template: the text reads as above and nothing says to add a line under## [Unreleased]in a PR.copier updateapplies this cleanly (done per package after the release).