# SPDX-FileCopyrightText: 2024 Jason Pena <jasonpena@awkless.com>
# SPDX-License-Identifier: CC0-1.0

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

[changelog]
# Template for the changelog footer...
header = """
<!--
SPDX-FileCopyrightText: 2024 Jason Pena <jasonpena@awkless.com>
SPDX-License-Identifier: CC-BY-SA-4.0
-->\n
# Changelog\n
All notable changes to this project will be documented in this file. See
[contributing guidelines](CONTRIBUTING.md) for commit guidelines.\n
"""

# Template for the changelog body
# https://keats.github.io/tera/docs/#introduction
body = """
{% if version %}\
    {% if previous.version %}\
        ## [{{ version | trim_start_matches(pat="v") }}]($REPO/compare/{{ previous.version }}..{{ version }}) - {{ timestamp | date(format="%Y-%m-%d") }}
    {% else %}\
        ## [{{ version | trim_start_matches(pat="v") }}]($REPO/releases/tag/{{ version }}) - {{ timestamp | date(format="%Y-%m-%d") }}
    {% endif %}\
{% else %}
    ## Unreleased
{% endif %}\
{% for group, commits in commits | group_by(attribute="group") %}
    ### {{ group | striptags | trim | upper_first }}
    {% for commit in commits
    | filter(attribute="scope")
    | sort(attribute="scope") %}
        - **({{commit.scope}})**{% if commit.breaking %} [**breaking**]{% endif %} \
            {{ commit.message }} - ([{{ commit.id | truncate(length=7, end="") }}]($REPO/commit/{{ commit.id }})) - {{ commit.author.name }}
    {%- endfor -%}
    {% raw %}\n{% endraw %}\
    {%- for commit in commits %}
        {%- if commit.scope -%}
        {% else -%}
            - {% if commit.breaking %} [**breaking**]{% endif %}\
                {{ commit.message }} - ([{{ commit.id | truncate(length=7, end="") }}]($REPO/commit/{{ commit.id }})) - {{ commit.author.name }}
        {% endif -%}
    {% endfor -%}
{% endfor %}\n
"""
# Template for the changelog footer...
footer = """
<!-- generated by git-cliff -->
"""

# Remove the leading and trailing whitespace from the templates...
trim = true

# Postprocessors...
postprocessors = [
    { pattern = '\$REPO', replace = "https://github.com/rice-configs/ricer" }, # replace 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 = false

# Regex for preprocessing the commit messages...
commit_preprocessors = [
    { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/rice-configs/ricer/issues/${2}))"},
]

# Regex for parsing and grouping commits...
commit_parsers = [
    { message = "^feat", group = "Features" },
    { message = "^fix", group = "Bug Fixes" },
    { message = "^doc", group = "Documentation" },
    { message = "^doc\\(changelog\\):", skip = true },
    { message = "^perf", group = "Performance" },
    { message = "^ref", group = "Refactoring" },
    { message = "^ref\\(clippy\\):", skip = true }, # Users will not care about refactors from clippy.
    { message = "^style", skip = true }, # Users do not care about style changes.
    { message = "^rev", group = "Revert" },
    { message = "^test", group = "Tests" },
    { message = "^chore", group = "Miscellaneous Chores" },
    { message = "^chore\\(version\\):", skip = true },
    { body = ".*security", group = "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 = false

# Regex for matching git tags...
tag_pattern = "v[0-9].*"

# Regex for skipping tags...
skip_tags = "v0.1.0-beta.1"

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