cliff.toml

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

[remote.github]
owner = "rsvim"
repo = "rsvim"

[changelog]
# changelog header
# header = """
# # Changelog\n
# """
# template for the changelog body
# https://keats.github.io/tera/docs/#introduction
body = """
{% if version and previous.version %}\
    ## [{{ version | trim_start_matches(pat="v") }}]($REPO/compare/{{previous.version}}..{{version}}) - {{ timestamp | date(format="%Y-%m-%d") }}
{% elif previous.version %}\
    ## [unreleased]($REPO/compare/{{previous.version}}..HEAD)
{% else %}\
    ## unreleased
{% endif %}\
{% macro makecommitid(commit_id) -%}[{{ commit_id | truncate(length=8, end="") }}]($REPO/commit/{{ commit_id }}){% endmacro -%}
{% if previous %}\
    {% if previous.commit_id %}
        {{ self::makecommitid(commit_id=previous.commit_id) }}...\
            {% if commit_id %}{{ self::makecommitid(commit_id=commit_id) }}{% endif %}
    {% endif %}\
{% endif %}\
{% macro makecommit(commit) -%}
- {% if commit.scope %}*({{commit.scope}})* {% endif -%}\
  {% if commit.breaking %} [**breaking**]{% endif -%}\
  {{ commit.message | upper_first | trim }} ({{ self::makecommitid(commit_id=commit.id) }})\
  {% if commit.github.username %} by @{{ commit.github.username }}{%- endif -%}\
  {% if commit.github.pr_number %} ([#{{ commit.github.pr_number }}]($REPO/pull/{{ commit.github.pr_number }})){%- endif %}\
{% if commit.body %}
  {{ '  ' }}````text
  {% for bod in commit.body | split(pat="\n") -%}\
  {{ '  '}}{{ bod | trim }}
  {% endfor %}\
  {{ '  ' }}````
{% endif %}\
{% for footer in commit.footers -%}
  {%- if footer.token != "Signed-off-by" and footer.token != "Co-authored-by" %}

  {{ '  ' }}{{ footer.token }}{{ footer.separator }}{{ footer.value }}
  {%- endif %}
{% endfor %}\
{% endmacro -%}
{% for group, commits in commits | group_by(attribute="group") %}
### {{ group | upper_first }}
{% for commit in commits %}
{{ self::makecommit(commit=commit) }}
{% endfor %}
{% endfor %}
"""
# remove the leading and trailing s
trim = true
# postprocessors
postprocessors = [
  { pattern = '\$REPO', replace = "https://github.com/rsvim/rsvim" }, # repository URL
]

[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 = true
# regex for preprocessing the commit messages
commit_preprocessors = [
  # Replace issue numbers
  #{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))"},
  # 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 -' },
]
# regex for parsing and grouping commits
commit_parsers = [
  { message = "^feat", group = "<!-- 0 -->Features" },
  { message = "^fix", group = "<!-- 1 -->Bug Fixes" },
  { message = "^perf", group = "<!-- 2 -->Performance Improvements" },
  { message = "^refactor", group = "<!-- 3 -->Code Refactoring" },
  { message = "^security", group = "<!-- 4 -->Security" },
]
# 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 = true
# 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 = "oldest"
# limit the number of commits included in the changelog.
# limit_commits = 42