Add $changelog: false flag to omit a bump file from the changelog#131
Merged
Conversation
Adds an explicit way to keep a change out of the changelog / release
notes while still applying its version bump — clearer than relying on a
blank body.
- File-level: `$changelog: false` reserved frontmatter key (sigil-prefixed
so it can never collide with a package name) suppresses the whole file's
summary across every package it lists.
- Per-package: `{ bump, changelog: false }` in the nested object form
suppresses the entry for just some of a file's packages. Either flag
wins (file-level OR per-package), via a shared isChangelogSuppressed().
Both the default and GitHub changelog formatters respect the flag. The
body is preserved in the bump file, so it doubles as a note for reviewers.
Includes parser + formatter tests and docs/skill updates.
|
The changes in this PR will be included in the next version bump.
|
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
1 participant
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.
What
Adds an explicit way to keep a change out of the changelog / release notes while still applying its version bump. Previously the only way to do this was to leave the bump file body blank, which is easy to misread as "forgot to write a description."
File-level —
$changelog: falseA sigil-prefixed reserved frontmatter key. The
$can never collide with a package name (it's already rejected byvalidatePackageName), and a package literally namedchangelogis unaffected (changelog: patchis still a normal entry).Suppresses the file's summary across every package it lists (a bump file has one shared body).
Per-package —
changelog: falseFor files that cover several packages where you only want to hide the entry for some of them, use the nested object form:
The effective rule is suppress if file-level OR per-package flag is set, centralized in a shared
isChangelogSuppressed(bf, packageName)helper used by both the default and GitHub formatters. The body is preserved in the bump file, so it doubles as a note for reviewers.Changes
types.ts—noChangelog?onBumpFile(file-level) and both release shapes (per-package).bump-file.ts— parses the$changelogreserved key and the nestedchangelogoption; both validated as boolean, unknown$keyserror out.changelog.ts/changelog-github.ts— both formatters skip suppressed entries via the shared helper.docs/bump-files.md) and theadd-changeskill updated.Tests
10 new tests (parser + both formatters), including per-package suppression of one package while a sibling in the same file still renders. 367 pass, typecheck / lint / format all clean.