cliff.toml

# 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.

[remote.github]
  owner = "northwood-labs"
  repo  = ""

[changelog]
  # @config-manager:start changelog-content
  header = """
# CHANGELOG

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com), adheres to [Semantic Versioning](https://semver.org), and uses [Conventional Commit](https://www.conventionalcommits.org) syntax.
"""

  # template for the changelog body
  # https://keats.github.io/tera/
  body = """
{% if version %}
  ## {{ version | trim_start_matches(pat="v") }} — {{ timestamp | date(format="%Y-%m-%d") }}
  {% if previous.version %}
    [Compare: {{ previous.version }} → {{ version }}]({{ self::remote_url() }}/compare/{{ previous.version }}...{{ version }})
  {% endif %}\
{% else %}
  ## Unreleased
  {% if previous.version %}
    [Compare: {{ previous.version }} → `HEAD`]({{ self::remote_url() }}/compare/{{ previous.version }}..HEAD)
  {% endif %}\
{% endif %}\
{% for group, commits in commits | filter(attribute="merge_commit", value=false) | group_by(attribute="group") %}
  ### {{ group | upper_first }}
  {% for commit in commits %}
    {% set commit_message = commit.message -%}
    * {% if commit.breaking %}**[BC BREAK]** {% endif %}\
    [`{{ commit.id | truncate(length=7, end="") }}`]({{ self::remote_url() }}/commit/{{ commit.id }}): {% if commit.scope %}\
    **{{ commit.scope }}**: {% endif %}{{ commit_message | split(pat="\n") | first | upper_first | trim_end }} \
    ({% if commit.remote.username %}[@{{ commit.remote.username | replace(from="[bot]", to="") }}](https://github.com/{{ commit.remote.username | replace(from="[bot]", to="") }}){%- endif -%})\
  {%- endfor %}
{% endfor %}
{%- macro remote_url() -%}
  https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}
{%- endmacro -%}
"""

  # remove the leading and trailing whitespace from the template
  trim = true

  # changelog footer
  footer = """

<p>Generated on {{ now() | date(format="%Y-%m-%d") }}.</p>
"""
  # @config-manager:end changelog-content

  postprocessors = [
    # @config-manager:start post-processors
    {pattern = "(?i)pkg\\.go\\.dev", replace = "`$0`"},
    {pattern = "([^ ]+)\\(\\)", replace = "`$0`"},
    {pattern = "([^ ]+)\\.md", replace = "`$0`"},
    {pattern = "([^ ]+)\\.ya?ml", replace = "`$0`"},
    {pattern = "AUTHORS|CONTRIBUTORS|CONTRIBUTING|README", replace = "$0.md"},
    {pattern = "Bump ([^ ]+)", replace = "Bump `$1`"},
    {pattern = "\\(#([0-9]+)\\)", replace = "([#${1}](@REPO/issues/${1}))"},
    {pattern = "\\.md\\.md", replace = ".md"},
    {pattern = "go\\.(mod|sum)", replace = "`$0`"},
    # @config-manager:end post-processors
  ]

[git]
  # @config-manager:start reading-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

  # 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 = "beta|alpha"

  # regex for ignoring tags
  ignore_tags = "rc"

  # sort the tags topologically
  topo_order = true

  # sort the commits inside sections by oldest/newest order
  sort_commits = "oldest"
  # @config-manager:end reading-git

  # regex for preprocessing the commit messages
  commit_preprocessors = [
    # @config-manager:start commit-pre
    # { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))"}, # replace issue numbers
    # @config-manager:end commit-pre
  ]

  # regex for parsing and grouping commits
  commit_parsers = [
    # @config-manager:start commit-parsers
    {body = ".*security", group = ":closed_lock_with_key: Security"},
    {group = ":art: Styling", message = "^style"},
    {group = ":books: Documentation", message = "^docs"},
    {group = ":dependabot: Building and Dependencies", message = "^build|deps"},
    {group = ":soap: Linting", message = "^lint"},
    {group = ":test_tube: Testing", message = "^test"},
    {group = ":tractor: Refactor", message = "^refactor"},
    {group = "<!-- 0 -->:rocket: Features", message = "^feat"},
    {group = "<!-- 1 -->:bug: Bug Fixes", message = "^fix"},
    {group = "<!-- 2 -->:racecar: Performance", message = "^perf"},
    {group = "<!-- ZYY -->:x: Revert", message = "^revert"},
    {group = "<!-- ZZZ -->:gear: Miscellaneous Tasks", message = "^chore|ci"},
    {message = "^automation", skip = true},
    {message = "^chore\\(deps\\)", skip = true},
    {message = "^chore\\(pr\\)", skip = true},
    {message = "^chore\\(pull\\)", skip = true},
    {message = "^chore\\(release\\): prepare for", skip = true},
    {message = "^relprep", skip = true},
    # @config-manager:end commit-parsers
  ]