Skip to content

fix: list every commit type in the release notes - #24

Merged
Mearman merged 2 commits into
mainfrom
fix/list-all-commit-types-in-release-notes
Oct 29, 2026
Merged

Mearman merged 2 commits into
mainfrom
fix/list-all-commit-types-in-release-notes

Conversation

@Mearman

@Mearman Mearman commented Oct 29, 2026

Copy link
Copy Markdown
Member

The release notes used the angular preset, which only lists feat, fix, perf and revert, so v2.1.1 and v2.1.2 (both cut by ci commits) and v1.1.1 to v1.1.3 had a bare version header and nothing under it, in the GitHub release and in CHANGELOG.md.

The notes now use the conventionalcommits preset with a section for every type in commitTypes, so the types commit-analyzer releases on and the types the notes list come from one list. conventional-changelog-conventionalcommits is pinned to 9.3.1 as a direct devDependency, since release-notes-generator loads writer 8 and the 10.x preset needs writer 9. pnpm hoisted the 10.x copy next to the generator, so a packageExtensions entry in pnpm-workspace.yaml makes it find 9.3.1 first; without it the notes render an error. I ran generateNotes with the real options over a commit of each type for a patch and a minor release, and every type is listed under an H2 version header.

The second commit backfills CHANGELOG.md for those five releases.

The angular preset lists only feat, fix, perf and revert, so a release cut
by a docs, refactor, ci or chore commit had a version header and nothing
under it. The notes now use the conventionalcommits preset with a section
for every type in commitTypes.

conventional-changelog-conventionalcommits is pinned to 9.3.1 because
release-notes-generator loads conventional-changelog-writer 8, which the
10.x preset cannot render with. A package extension makes the pinned
preset resolve next to the generator, which otherwise finds the 10.x copy
that @commitlint/config-conventional brings in.
…g entry

Generated with the repository's own release-notes options from the commits
between each pair of release tags.
@Mearman
Mearman marked this pull request as ready for review October 29, 2026 10:00
@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
🔒 Security Review ⚠️ Failed 2026-10-29T10:00:57.785837Z
We couldn’t complete this review. Comment @codex security review to try again.
fe75bc2 Draft marked ready
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector

Copy link
Copy Markdown

This security review couldn’t start because the paying account has exhausted its Codex allowance and has insufficient available credits. The payer can check their balance and add credits in the Codex usage dashboard, then try again. If you do not manage the paying account, contact this repository's admins.

@Mearman
Mearman merged commit d7c4795 into main Oct 29, 2026
14 checks passed
@Mearman
Mearman deleted the fix/list-all-commit-types-in-release-notes branch October 29, 2026 10:01
@github-actions

Copy link
Copy Markdown

🎉 This PR is included in version 2.1.3 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant