Skip to content

fix(release): render dependency updates in release notes#42

Open
cwaits6 wants to merge 1 commit into
mainfrom
fix/release-notes-dependency-sections
Open

fix(release): render dependency updates in release notes#42
cwaits6 wants to merge 1 commit into
mainfrom
fix/release-notes-dependency-sections

Conversation

@cwaits6

@cwaits6 cwaits6 commented Jul 4, 2026

Copy link
Copy Markdown
Owner

Problem

Releases triggered only by chore(deps) / ci(deps) commits (e.g. v1.1.3, v1.2.1) are published with empty bodies. The custom releaseRules entry makes commit-analyzer cut a patch release for chore(deps), but release-notes-generator's default angular preset hides chore/ci commits — so the release exists but the notes are blank.

Fix

Switch commit-analyzer and release-notes-generator to the conventionalcommits preset with an explicit presetConfig.types list that renders chore(deps) and ci(deps) under a Dependencies section.

Notes:

  • conventional-changelog-conventionalcommits is already installed by the shared krypsis-io/.github release workflow, so no change is needed there.
  • presetConfig.types replaces the default list wholesale (no merging), so feat/fix/perf/revert must be re-declared.
  • Type lookup is first-match-wins, so the scoped chore(deps)/ci(deps) entries are placed before the general hidden chore/ci entries.
  • The chore(deps) → patch release rule is unchanged; ci(deps) still doesn't trigger releases on its own, it just renders when riding along.

https://claude.ai/code/session_01EN4tyYEvuDqwHDyxSbyvT8

Summary by CodeRabbit

  • Chores
    • Updated release-note generation to better organize future changelogs by commit type.
    • Dependency-related maintenance changes are now more consistently recognized as patch-level updates.
    • Non-user-facing categories like docs, style, tests, and refactors are now omitted from release highlights.

Releases triggered only by chore(deps)/ci(deps) commits (e.g. v1.1.3,
v1.2.1) had empty bodies: commit-analyzer cut a patch release via the
custom releaseRule, but the default angular preset hides chore/ci
commits from the notes.

Switch both commit-analyzer and release-notes-generator to the
conventionalcommits preset (already installed by the shared release
workflow) with an explicit types list that surfaces chore(deps) and
ci(deps) under a Dependencies section. The scoped entries must precede
the general hidden chore/ci entries because type lookup is
first-match-wins.

Claude-Session: https://claude.ai/code/session_01EN4tyYEvuDqwHDyxSbyvT8
@coderabbitai

coderabbitai Bot commented Jul 4, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: ae02ece1-c5c4-460a-ab1b-227e1672c854

📥 Commits

Reviewing files that changed from the base of the PR and between b823487 and 200b9c0.

📒 Files selected for processing (1)
  • .releaserc.json

📝 Walkthrough

Walkthrough

Updates .releaserc.json semantic-release configuration to use the conventionalcommits preset for both commit-analyzer and release-notes-generator plugins, adding a custom release rule for dependency chores and a detailed changelog section mapping.

Changes

Release configuration changes

Layer / File(s) Summary
Configure conventionalcommits presets
.releaserc.json
commit-analyzer adds preset: conventionalcommits and a releaseRules entry mapping chore(deps) to patch; release-notes-generator is expanded to an object with preset: conventionalcommits and presetConfig.types defining changelog sections and hidden types.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Poem

A hop, a preset, a config anew,
Chores tagged "deps" now get their due,
Changelogs sorted, sections aligned,
This bunny's release notes are finally refined! 🐇📦

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: dependency updates are now rendered in release notes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/release-notes-dependency-sections

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant