fix(release): restore release-notes generation (pin conventional-changelog preset to v9)#1560
Merged
dawsontoth merged 1 commit intoJul 24, 2026
Conversation
…ase notes @commitlint/config-conventional@21.2.0 bumped the shared conventional-changelog-conventionalcommits preset to v10, whose function-based templates target conventional-changelog-writer@9. But @semantic-release/release-notes-generator@14.1.1 (latest) still renders with the Handlebars-based writer@8, so v10's templates emitted only the header line — every release from v2.131.0 onward had empty notes. Hold the preset on 9.x via a pnpm override until release-notes-generator ships a writer@9-based major. commitlint keeps working on v9 (it only uses the preset's stable parserOpts). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Code Review
This pull request downgrades the conventional-changelog-conventionalcommits package to version 9.3.1 via overrides in pnpm-workspace.yaml and updates pnpm-lock.yaml accordingly. This change addresses a regression where release notes collapsed to only their header lines due to an incompatibility between version 10's template engine and the older writer bundled by @semantic-release/release-notes-generator. There are no review comments, and we have no feedback to provide.
Coverage Report
File CoverageNo changed files found. |
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.
What broke
Every GitHub release from v2.131.0 onward has had empty notes — just the
## [x.y.z](compare) (date)header line, no### Features/### Bug Fixessections. v2.130.0 (2026-07-02) was the last good one.Root cause
The
conventionalcommitspreset is not a declared dependency of@semantic-release/release-notes-generator— the generator loads it from the project root at runtime, so its version floats with the rest of the tree.Commit
2b3ed70("fix(deps): update all non-major dependencies", in the v2.131.0 window) bumped@commitlint/config-conventional21.1.0 → 21.2.0, moving its preset dep^9.2.0→^10.0.0. Since that's the only package declaring the preset, the whole tree jumpedconventional-changelog-conventionalcommits9.3.1 → 10.2.1.The incompatibility:
release-notes-generator@14.1.1(the latest — there is no newer version) bundles the Handlebars-basedconventional-changelog-writer@8.{{#each commitGroups}}…) → writer@8 renders them fine.@conventional-changelog/templateengine (meant for writer@9). Fed to writer@8, only the header survives — every commit group renders empty.Reproduced both sides against the exact
.releaserc.jsonconfig and real commits: preset v10 → header only; preset v9 → fully categorized.The fix
A single pnpm override in
pnpm-workspace.yaml— same pattern as the existingjsdom>undicipin, holding a transitive dep back until the consumer catches up:Verified: lockfile now resolves only 9.3.1 (no v10); an isolated run with the locked combo produces correct categorized notes; and
@commitlint/config-conventional@21.2.0still lints correctly on preset v9 (it only uses the preset's stableparserOpts). Takes effect on the next release viapnpm releaseindeploy-stage.yaml.Also done (outside this diff)
Backfilled the notes for all 57 already-published releases (v2.131.0 → v2.154.4) by regenerating from each tag range with the fixed v9 preset and splicing the sections under the original header (preserving real release dates).
Watch out
@commitlint/config-conventional(dragging the preset to v10). The override holds it; don't drop the pin untilrelease-notes-generatorships awriter@9-based major.🤖 Generated with Claude Code