cliff.toml

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

[changelog]
header = """
# Changelog\n
All notable changes to this project will be documented in this file.

<!-- markdownlint-disable no-duplicate-heading -->
<!-- markdownlint-disable emph-style -->
<!-- markdownlint-disable strong-style -->

"""
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 %}
        -   {% if commit.scope %}_({{ commit.scope }})_ {% endif %}\
            {% if commit.breaking %}[**breaking**] {% endif %}\
            {{ commit.message | upper_first }}\
    {% endfor %}
{% endfor %}
{% set has_non_bot_contributors = false %}\
{% for contributor in github.contributors %}\
    {% if contributor.username is ending_with("[bot]") %}{% continue %}{% endif %}\
    {% set_global has_non_bot_contributors = true %}\
{% endfor %}\
{% if has_non_bot_contributors %}\
    ### Contributors

    {% for contributor in github.contributors %}\
        {% if contributor.username is ending_with("[bot]") %}{% continue %}{% endif %}\
        -   @{{ contributor.username }}
    {% endfor %}
{% else %}\
    <!-- No contributors to list -->

{% endif %}\
"""
footer = """
<!-- generated by git-cliff on {{ now() | date(format="%Y-%m-%d") }}-->
"""
trim = true
postprocessors = []

[git]
conventional_commits  = true
filter_unconventional = true
split_commits         = false
# Only strict semver tags are releases. This deliberately excludes the legacy
# moving `v2` tag, which git-cliff cannot parse.
tag_pattern           = "v[0-9]+\\.[0-9]+\\.[0-9]+"
commit_preprocessors  = [
  # Remove the PR number added by GitHub when merging PR in UI
  { pattern = '\s*\(#([0-9]+)\)$', replace = "" },
  # Check spelling of the commit with https://github.com/crate-ci/typos
  { pattern = ".*", replace_command = "typos --write-changes -" },
]
commit_parsers        = [
  # Ignore deps commits from the changelog
  { message = "^(chore|fix)\\(deps.*\\)", skip = true },
  # Group commits by type
  { group = "<!-- 00 -->🚀 Features", message = "^feat" },
  { group = "<!-- 01 -->🐛 Bug Fixes", message = "^fix" },
  { group = "<!-- 50 -->🚜 Refactor", message = "^refactor" },
  { group = "<!-- 51 -->⚡ Performance", message = "^perf" },
  { group = "<!-- 52 -->🎨 Styling", message = "^style" },
  { group = "<!-- 60 -->📚 Documentation", message = "^docs" },
  { group = "<!-- 80 -->🧪 Testing", message = "^test" },
  { group = "<!-- 98 -->◀️ Revert", message = "^revert" },
  { group = "<!-- 99 -->⚙️ Miscellaneous Tasks", message = "^chore" },
  { group = "<!-- 99 -->💼 Other", message = ".*" },
]
filter_commits        = false
topo_order            = false
sort_commits          = "oldest"

[remote.github]
owner = "pactflow"
repo  = "actions"