fix(release): align release-note sections with studio and guard preset at v9 - #45
Merged
Merged
Conversation
…t at v9 - Aligned `.releaserc.json` `presetConfig.types` to studio's superset (adds `chore`→Chores, `build`, `ci`, `style`; renames to match studio) so no release comes out empty. - Added the Renovate guard. (No lockfile change — the preset devDep is already on a 9.x range, so notes already render; this is the consistency + guard piece.) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Code Review
This pull request updates the release configuration in .releaserc.json to refine commit types and sections, and adds a rule in renovate.json to pin conventional-changelog-conventionalcommits to versions below 10 to avoid compatibility issues. Feedback on .releaserc.json highlights that the conventionalcommits preset does not support a scope property within the types array. Consequently, the two conflicting chore entries will overwrite each other, and it is recommended to consolidate them into a single entry.
|
🎉 This PR is included in version 1.1.4 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
Why
Our semantic-release repos generate GitHub release notes with the
conventionalcommitspreset, but the behavior had drifted and, in several repos, notes were coming out empty. Two separate causes:@semantic-release/release-notes-generator@14still bundles the Handlebars-basedconventional-changelog-writer@8. Theconventional-changelog-conventionalcommitsv10 preset rewrote its templates as JS functions for the newer@conventional-changelog/templateengine (writer@9); fed to writer@8 only the header survives, so every release note collapses to just its## [x.y.z]…line.presetConfig.typesdrift. Types likechore/chore(deps)/ci/build/stylewere hidden or missing, so dependency-only releases (the common Renovate case) produced empty notes.This PR makes the repo consistent with studio's canonical release config (which surfaces every commit type) and holds the preset on v9 where relevant. Reference: HarperFast/studio#1560.
What changed
.releaserc.jsonpresetConfig.typesto studio's superset (addschore→Chores,build,ci,style; renames to match studio) so no release comes out empty.(No lockfile change — the preset devDep is already on a 9.x range, so notes already render; this is the consistency + guard piece.)
Canonical
presetConfig.types(matches studio)feat→Features,fix→Bug Fixes,perf→Performance Improvements,refactor→Refactoring,chore(deps)→Dependency Updates,chore→Chores,docs→Documentation,style→Styles,test→Tests,build→Build System,ci→Continuous Integration,revert→Reverts — nothing hidden, so no release comes out empty.Renovate guard
Added a
packageRulesentry pinningconventional-changelog-conventionalcommitsto<10so Renovate won't re-introduce the v10 breakage. Remove once@semantic-release/release-notes-generatorships awriter@9-based major.Verification
.releaserc.jsonis valid JSON.🤖 Generated with Claude Code