Not sure what is the best way to use git-cliff when bump version after merge request (python CI with poetry)

[david-nano]

My current Python CI is that way:
Every repo starts with 0.0.0, once you create a branch, your version will be 0.0.0-ShortCommitHash, and for each commit a new tag for a new pipeline.
Once you create an MR (my instance is GitLab), and the MR is now merged, a new pipeline starts which are MR event, and in this pipeline, I'm bumping the version of the pyproject.toml, and getting a new version, the bump is based on the MR title, if it includes fix or anything else, it'll be patch, if it was feat: then bump minor, and BREAKING CHANGES: will bump major.

Now, during this script, I'm running git-cliff into CHANGELOG.md, but it takes all my recent commits and puts them in the current version.
I've missed the configuration to follow up, so I've added the cliff.toml into pyproject.toml and used flag --config to point to the relevant file, but still.
What will be the right method to use git-cliff in my case?

[orhun]

Hello 👋🏼

First of all, can you share your git-cliff config + the command-line arguments that you are using so that I can understand the problem better?

Secondly, I'm guessing you can do something like git cliff --unreleased --bump to get the bumped part of the changelog after the commits are made to the branch.

[david-nano]

I don't have git-cliff config, since it's running on CI.
this is the relevant part

#This term make sure it runs only after MR on Gitlab
if [ "$CI_PIPELINE_SOURCE" == "push" ] && [ "$CI_COMMIT_REF_NAME" == "$CI_DEFAULT_BRANCH" ]; then
        if echo "${CI_COMMIT_MESSAGE}" | grep -q 'BREAKING CHANGES:'; then
          poetry version major
        elif echo "${CI_COMMIT_MESSAGE}" | grep -iq 'feat:'; then
          poetry version minor
        else
          poetry version patch
        fi
        git-cliff --tag $(poetry version --short) --config pyproject.toml  -r . > CHANGELOG.md

If you mean mean config of the TOML created by init, so I've added it into pyproject.toml file, hers is the section:

[tool.git-cliff.changelog]
# changelog header
header = """
# Changelog\n
All notable changes to this project will be documented in this file.\n
"""
# template for the changelog body
# https://keats.github.io/tera/docs/#introduction
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 | upper_first }}
    {% for commit in commits %}
        - {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\
    {% endfor %}
{% endfor %}\n
"""
# remove the leading and trailing whitespace from the template
trim = true
# changelog footer
footer = """
<!-- generated by git-cliff -->
"""
# postprocessors
postprocessors = [
    # { pattern = '<REPO>', replace = "https://github.com/orhun/git-cliff" }, # replace repository URL
]

[tool.git-cliff.git]
# parse the commits based on https://www.conventionalcommits.org
conventional_commits = true
# filter out the commits that are not conventional
filter_unconventional = true
# process each line of a commit as an individual commit
split_commits = false
# regex for preprocessing the commit messages
commit_preprocessors = [
    # { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))"}, # replace issue numbers
]
# regex for parsing and grouping commits
commit_parsers = [
    { message = "^feat", group = "Features" },
    { message = "^fix", group = "Bug Fixes" },
    { message = "^doc", group = "Documentation" },
    { message = "^perf", group = "Performance" },
    { message = "^refactor", group = "Refactor" },
    { message = "^style", group = "Styling" },
    { message = "^test", group = "Testing" },
    { message = "^chore\\(release\\): prepare for", skip = true },
    { message = "^chore\\(deps\\)", skip = true },
    { message = "^chore\\(pr\\)", skip = true },
    { message = "^chore\\(pull\\)", skip = true },
    { message = "^chore|ci", group = "Miscellaneous Tasks" },
    { body = ".*security", group = "Security" },
    { message = "^revert", group = "Revert" },
]
# protect breaking changes from being skipped due to matching a skipping commit_parser
protect_breaking_commits = false
# filter out the commits that are not matched by commit parsers
filter_commits = false
# regex for matching git tags
tag_pattern = "[0-9].*"

# regex for skipping tags
skip_tags = "v0.1.0-beta.1"
# regex for ignoring tags
ignore_tags = ""
# sort the tags topologically
topo_order = false
# sort the commits inside sections by oldest/newest order
sort_commits = "oldest"
# limit the number of commits included in the changelog.
# limit_commits = 42

We don't use GitLab tags to manage the package version, instead, we just bump the pyproject.toml.

Edit:
I've tried to add suggested flags, and this is my current output:

ERROR git_cliff > Previous version is not found for calculating the next release.

I think some how git_cliff is not synced with my poetry versioning.

[orhun]

Thanks for sharing! Unfortunately I'm still having trouble understanding your use case. Can you share the example output of git-cliff --tag $(poetry version --short) --config pyproject.toml -r . after you run it VS. what you expect to happen?