cliff.toml and GitLab

[joergklein]

I need a little help. The change log still has errors. I use GitLab!

1. the round bracket after the issue no. has one space too many (#1 )
2. also the merge_request no (!1 )
3. link to the merge requests. I need some lines of code. I don't know how to insert {% for group, commits in commits | filter(attribute="merge_commit", value=false) %} correctly so that (!1) is displayed as a link.
4. new contributors Needs the merge_number after the !
5. The tag [0.1.0] doesn't work

Thank you for the help

here is the cliff.tom

# git-cliff ~ default configuration file
# https://git-cliff.org/docs/configuration
#
# Lines starting with "#" are comments.
# Configuration options are organized into tables and keys.
# See documentation for more information on available options.

[changelog]
header = """
# Changelog\n
This is an automated changelog based on the commits in this repository.

### Releases

Check the notes in the [releases](https://gitlab.com/username/test/-/releases) for more information.
"""
# 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 | trim }} ([{{ commit.id | truncate(length=7, end="") }}](<REPO>/commit/{{ commit.id }}))\
            {% if commit.gitlab.username and commit.gitlab.username != remote.gitlab.owner %} by [@{{ commit.gitlab.username }}](https://gitlab.com/{{ commit.gitlab.username }}){%- endif -%}
            {% if commit.gitlab.pr_number %} in [#{{ commit.gitlab.pr_number }}]( <REPO>/-/commit/{{ commit.gitlab.pr_number }}){%- endif -%}
    {% endfor %}
{% endfor %}

{%- if gitlab.contributors | filter(attribute="is_first_time", value=true) | length != 0 %}
  ## New Contributors
{%- endif -%}

{% for contributor in gitlab.contributors | filter(attribute="is_first_time", value=true) %}
  * [@{{ contributor.username }}](https://gitlab.com/{{ contributor.username }}) made their first contribution in [!{{ contributor.pr_number }}](<REPO>/-/merge_requests/{{ contributor.pr_number }})\
{%- endfor %}\n
"""
# changelog footer
footer = """
{% for release in releases -%}
    {% if release.version -%}
        {% if release.previous.version -%}
            [{{ release.version | trim_start_matches(pat="v") }}]: \
                <REPO>/-/compare/{{ release.previous.version }}...{{ release.version }}
        {% endif -%}
    {% else -%}
        [unreleased]: <REPO>/-/compare/{{ release.previous.version }}...HEAD
    {% endif -%}
{% endfor %}
"""
# remove the leading and trailing whitespace from the template
trim = true
postprocessors = [
  { pattern = '<REPO>', replace = "https://gitlab.com/username/test" }, # replace repository URL
]

[git]
# https://www.conventionalcommits.org
conventional_commits = true
filter_unconventional = true
split_commits = false
commit_preprocessors = [
  # Replace issue numbers
  { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))" }, # replace issue numbers
  # Check spelling of the commit with https://github.com/crate-ci/typos
  # If the spelling is incorrect, it will be automatically fixed.
  # { pattern = '.*', replace_command = 'typos --write-changes -' },
]
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\\(commit\\)", 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 = "v[0-9].*"
# regex for skipping tags
# skip_tags = ""
# regex for ignoring tags
# ignore_tags = ""
# sort the tags topologically
topo_order = false
# sort the commits inside sections by oldest/newest order
sort_commits = "newest"
# limit the number of commits included in the changelog.
# limit_commits = 42

[remote.gitlab]
owner = "username"
repo = "test"
token = ""

[Cyclonit]

The config you posted does not appear to match the screenshot. Did you change anything in between? The order of elements according to the template should be <message> (<commit>) by @<user> in #<pr>. In your screenshot it is <message> (#<pr>) (!<image>) (<commit>).

[joergklein]

I have not changed anything. I don't know why the output is not displayed correctly. GitLab Pages? I have also tested my project on my personal web space. The result remains the same. Does anyone use GitLab? Is it possible to test the cliff.toml with GitLab?

Here an example for a commit message:

git commit -m 'feat: new feature (#1) (!1)'

(#1) for the issue
(!1) for the merge request

[sateeshnavale]

Hi @joergklein,

Please revoke the leaked gitlab token.

[joergklein]

I revoked the GitLab Token.

[orhun]

Are you still having issues? I can try to reproduce this if the repository is open source. It is a bit hard to do testing without the necessary remote data such as pull requests and so on.

[joergklein]

I have a GitLab Repo for tests. This is not open source. I would like to invite you, when you send me your GitLab user name. For this project I use Gitlab Pages. Thank you for the help Jörg Am Di., 20. Aug. 2024 um 15:49 Uhr schrieb Orhun Parmaksız < ***@***.***>:

…

Are you still having issues? I can try to reproduce this if the repository is open source. It is a bit hard to do testing without the necessary remote data such as pull requests and so on. — Reply to this email directly, view it on GitHub <#730 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AJGEMU2SED2Z5M7YQFFM2ALZSNCNBAVCNFSM6AAAAABJ5WRMQOVHI2DSMVQWIX3LMV43URDJONRXK43TNFXW4Q3PNVWWK3TUHMYTAMZZGYZTSOI> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[orhun]

Awesome, you can invite https://gitlab.com/orhunp

[joergklein]

You can clone this repo or work directly in GitLab. After a push, gitlab builds and deploys to GitLab pages. I am grateful for any help and suggestions for improvement. Thank you for your help. Jörg Am Mi., 21. Aug. 2024 um 15:18 Uhr schrieb Orhun Parmaksız < ***@***.***>:

…

Awesome, you can invite https://gitlab.com/orhunp — Reply to this email directly, view it on GitHub <#730 (reply in thread)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AJGEMUZXEC2CFCTBN5MZ52DZSSHSFAVCNFSM6AAAAABJ5WRMQOVHI2DSMVQWIX3LMV43URDJONRXK43TNFXW4Q3PNVWWK3TUHMYTANBQG43DGOA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[orhun]

I just checked the repo and here are the actionable items:

1. the round bracket after the issue no. has one space too many (#1 )
2. also the merge_request no (!1 )

I guess these are now solved, the changelog looks fine to me.

1. link to the merge requests. I need some lines of code. I don't know how to insert {% for group, commits in commits | filter(attribute="merge_commit", value=false) %} correctly so that (!1) is displayed as a link.

You can add this preprocessor:

commit_preprocessors = [
  # add merge request link
  { pattern = '\(!([0-9]+)\)', replace = "([!${1}](<REPO>/-/merge_requests/${1}))" },
]

1. new contributors Needs the merge_number after the !

There seems to be a bug with this, I'm not sure what is going on. Feel free to create a separate issue and I can look into it.

In the meantime you can add a guard like this:

{% for contributor in contributors %}
  {% if contributor.pr_number -%}\
    * [@{{ contributor.username }}](https://gitlab.com/{{ contributor.username }}) made their first contribution in [!{{ contributor.pr_number }}](<REPO>/-/merge_requests/{{ contributor.pr_number }})\
  {% endif -%}\
{%- endfor %}\n

1. The tag [0.1.0] doesn't work

Not sure what you mean by this.