Is it possible to "merge" commits in the changelog?

[truenicoco]

My use-case is:

• release version x
• push a new feature to the main branch, let's call this commit A: "feat: new cool stuff"
• before the version x+1 release, fix something introduced by commit A, let's call this commit B: "cfix: feat: new cool stuff"; "cfix" is the commit title header I use when this happens (I don't have an army of testers to make sure I never introduce bugs with new features ^^)

When I release version x+1, I actually don't want commit B to be part of the changelog since it does not make sense for users updating from x to x+1 to read about it. I achieve this by skipping "^cfix" commits. But I also use commit hashes in my changelog, so ideally I would like to have this in my changelog:

## New features

- New cool stuff (commit A by author A, commit B by author B)

Is there any way to achieve that?

I have considered not skipping the "cfix" commits but actually using a dedicated group for that, eg, "🤐 Fixes for unreleased bugs", which is probably fine too but… git-cliff is for perfectionists, isn't it? ;-)

[Cyclonit]

This is not supported currently I feel like implementing it in git-cliff itself would be fairly convoluted. Your use case is quite niche.

You might be able to achieve something like it by using Tera's ability to manipulate data within the template itself: https://keats.github.io/tera/docs/#manipulating-data. But I haven't been able to come up with a solution on the fly. The overall idea would be to do a nested loop.

I am thinking of something like this (not tested):

body = """
{% if version %}\
    ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
{% else %}\
    ## [unreleased]
{% endif %}\
{% for group, commits in commits | group_by(attribute="group") %}
    ### {{ group | striptags | trim | upper_first }}
    {% for commit in commits %}
       {# only include non-cfix commits as their own items #}
       {% if commit.message is not starting_with("cfix") %}
          - {{ commit.message }} ({{commit.id}}
          {# append ids of related cfix commits #}
          {%- for cfix_commit in commits -%}
            {%- if commit.message == cfix_commit.message -%}
               , {{commit.id}}
            {%- endif %-}
          )
          {%- endfor %}
       {% endif %}
    {% endfor %}
{% endfor %}\n
"""

[truenicoco]

Thanks a lot for your reply!

This does not work as-is, as you said you haven't tested it, but it looks like it could work. Maybe I could use the hash of the commit at the "scope" of the cfix commit to do something a bit cleaner. I'll update here in case I come up with a nice solution for this.

And most importantly, thanks for awesome piece of software you gave us. <3

[truenicoco]

It works!

My pyproject.toml:

body = """
{% for group, all_commits in commits | group_by(attribute="group") %}
    {%- if group == "cfix" %}{% continue %}{%- endif %}
    ## {{ group | striptags | trim | upper_first }}
    {% for commit in all_commits %}
        - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
            {% if commit.breaking %}[**breaking**] {% endif %}\
            {{ commit.message | split(pat="\n") | first | upper_first | trim }} \
            ([`{{ commit.id | truncate(length=7, end="") }}`](./commit/{{ commit.id -}})\
            {% if commit.remote.username %} by @{{ commit.remote.username }}{%- endif -%}
            {%- for cfix_commit in commits | filter(attribute="group", value="cfix") -%}
                {%- if cfix_commit.scope and commit.id is starting_with(cfix_commit.scope) -%}
                    , [`{{ cfix_commit.id | truncate(length=7, end="") }}`](./commit/{{ cfix_commit.id }}){% if cfix_commit.remote.username %} by @{{ cfix_commit.remote.username }}{%- endif -%}
                {%- endif -%}
            {%- endfor -%})\
    {% endfor %}
{% endfor %}\n
"""
conventional_commits = true
filter_unconventional = false
commit_parsers = [
...
  { message = "^cfix", group = "cfix" },
]

Result

• (reactions) Use dedicated matrix API call (c4fde61 by @truenicoco)
• (reactions) Use sqlite for reaction cache (4d4b42b by @truenicoco, 505df6b)

where 505df6b has "cfix(4d4b42b5): blablabla" as commit title. For some reason, cfix_commit.remote.username seems to be empty, I'm not sure what's up with that. Should I accept your answer or mine?

[Cyclonit]

Mine was an idea, yours is the solution.