orhun/git-cliff

Distinguished behaviour between version bump and changelog

Open

#1,579 opened on Jul 12, 2026

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Rust (308 forks)auto 404
feature/requestgood first issue

Repository metrics

Stars
 (12,040 stars)
PR merge metrics
 (PR metrics pending)

Description

Is there an existing issue or pull request for this?

  • I have searched the existing issues and pull requests

Feature description

It would be nice if commit types can be considered for the version bump but not for the changelog, and vice versa. Currently, you can only exclude commit types entirely.


From #1564:

I only want to include certain commit types in my CHANGELOG.md, like feat and fix, but exclude less important types like docs. So I went with the following config:

commit_parsers = [
    { message = "^feat", group = "<!-- 0 -->🚀 Features" },
    { message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" },
]
filter_commits = true

Now let's say I need to make a release which only contains one docs commit. Then git-cliff -u --bumped-version says there is nothing to bump. With filter_commits = false, it correctly calculates the next patch version, but the docs commit is included in the changelog.

Is there any way to make this possible? It's basically the inverse of #1520. Not sure if the proposed bump flag for commit parsers would also work here? If so, I'm happy to open a feature request issue.

Desired solution

No desired solution in mind. In #1520 the following is suggested:

{ message = "^doc*", group = "<!-- 3 -->📚 Documentation", bump = true/false },

Which looks good to me. My gut feeling is that omitting in the changelog is more common than ignoring it for version bumps, so I would propose include_in_changelog = true/false (or both?).

Alternatives considered

Don't know about any alternatives.

Additional context

No response

Contributor guide