cliff.toml

# git-cliff ~ configuration file
# https://git-cliff.org/docs/configuration

[changelog]
# A Tera template to be rendered as the changelog's header.
# See https://keats.github.io/tera/docs/#introduction
header = """
Changelog
=========\n
All notable changes to this project will be documented in this file.

The format is based on `Keep a Changelog <https://keepachangelog.com/en/1.0.0/>`_,
and this project adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0.html>`_.\n
"""
# A Tera template to be rendered for each release in the changelog.
# See https://keats.github.io/tera/docs/#introduction
body = """
{%- macro remote_url() -%}
  https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}
{%- endmacro -%}

{% if version -%}
    .. `{{ version | trim_start_matches(pat="v") }}`_ - {{ timestamp | date(format="%Y-%m-%d") }}
    {{ version | trim_start_matches(pat="v") }} - {{ timestamp | date(format="%Y-%m-%d") }}
    -----------------------------------------------------------------------------------------
{% else -%}
    .. `Unreleased`_
    Unreleased
    ----------
{% endif -%}

{% for group, commits in commits | group_by(attribute="group") %}
    {{ group | upper_first }}
    ^^^^^^^^^^^^^^^^^^^^^^^^^
    {%- for commit in commits %}
        * {{ commit.message | split(pat="\n") | first | upper_first | trim }}\
            {% if commit.remote.username %} by @{{ commit.remote.username }}{%- endif -%}
            {% if commit.remote.pr_number %} in \
            `#{{ commit.remote.pr_number }} <{{ self::remote_url() }}/pull/{{ commit.remote.pr_number }}>`_ \
            {%- endif -%}
    {% endfor %}
{% endfor %}

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

{% for contributor in github.contributors | filter(attribute="is_first_time", value=true) %}
  * @{{ contributor.username }} made their first contribution
    {%- if contributor.pr_number %} in \
      `#{{ contributor.pr_number }} <{{ self::remote_url() }}/pull/{{ contributor.pr_number }}>`_ \
    {%- endif %}
{%- endfor %}\n

{%- if github.contributors | filter(attribute="is_first_time", value=true) | length != 0 %}{% raw %}\n{% endraw -%}{% endif %}

"""
# A Tera template to be rendered as the changelog's footer.
# See https://keats.github.io/tera/docs/#introduction
# footer = """
# {%- macro remote_url() -%}
#   https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}
# {%- endmacro -%}

# {% for release in releases -%}
#     {% if release.version -%}
#         {% if release.previous and release.previous.version -%}
#             .. _{{ release.version | trim_start_matches(pat="v") }}: {{ self::remote_url() }}/compare/{{ release.previous.version }}...{{ release.version }}
#         {% endif -%}
#     {% else -%}
#         {% if release.previous and release.previous.version -%}
#             .. _Unreleased: {{ self::remote_url() }}/compare/{{ release.previous.version }}...HEAD
#         {% endif -%}
#     {% endif -%}
# {% endfor %}
# """
# Remove leading and trailing whitespaces from the changelog's body.
trim = true

[git]
# Parse commits according to the conventional commits specification.
# See https://www.conventionalcommits.org
conventional_commits = true
# Exclude commits that do not match the conventional commits specification.
filter_unconventional = true
# An array of regex based parsers to modify commit messages prior to further processing.
commit_preprocessors = [
    # Remove issue numbers.
    { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "" },
]
# An array of regex based parsers for extracting data from the commit message.
# Assigns commits to groups.
# Optionally sets the commit's scope and can decide to exclude commits from further processing.
commit_parsers = [
    { message = "^fix", group = "Fixed" },
    { message = "(?i)\\bfix(ed)?\\b", group = "Fixed" },
    { message = "(?i)\\b(add(ed)?|support(ed)?)\\b", group = "Added" },
    { message = "(?i)\\b(remove(d)?|delete(d)?|erase(d)?)\\b", group = "Removed" },
    { message = "(?i)\\bdeprecate(d)?\\b", group = "Deprecated" },
    { message = "(?i)\\b(change(d)?|modif(y|ied)|improve(d)?)\\b", group = "Changed" },
    { message = "^feat", group = "Added" },
    # { message = "^.*", skip = true },
]
# Exclude commits that are not matched by any commit parser.
filter_commits = true

protect_breaking_commits = true
# Order releases topologically instead of chronologically.
topo_order = true
topo_order_commits = true
# Order of commits in each group/release within the changelog.
# Allowed values: newest, oldest
sort_commits = "newest"