cliff.toml

# Shared git-cliff configuration
# https://git-cliff.org/docs/configuration
# Materialized from research-repo-tools 0.1.7; only the deps-dev body condition
# below differs from the packaged template. See scripts/README.md.

[changelog]
# Keep a Changelog header
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.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n
"""

# Tera template for each release section.
#
# Release sections are generated from commit ranges. The normalizer escapes
# prose angle brackets after protecting Markdown code, so Rust generics remain
# literal inside code spans and fences. Breaking footers are separate from
# commit.body; render their full descriptions before grouping ordinary entries.
body = """
{% if version -%}
    ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
{% else -%}
    ## [Unreleased]
{% endif -%}
{% set breaking_commits = commits | filter(attribute="breaking", value=true) %}
{% if breaking_commits | length > 0 %}
    ### ⚠️ Breaking Changes
    {% for commit in breaking_commits %}
        {% if commit.breaking_description and commit.breaking_description != commit.message %}
            - {{ commit.breaking_description | trim | indent(prefix="  ", first=false) }}
        {% else %}
            - {{ commit.message | split(pat="\n") | first | upper_first | trim }}
        {% endif %}
    {% endfor %}
{% endif %}
{% for group, commits in commits | group_by(attribute="group") %}
    ### {{ group | upper_first }}
    {% for commit in commits %}
        - {% if commit.breaking %}[**breaking**] {% endif %}\
            {{ commit.message | split(pat="\n") | first | upper_first | trim }} \
            [`{{ commit.id | truncate(length=7, end="") }}`]\
            (https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}\
            /commit/{{ commit.id }})
        {%- if commit.body and (group != "Dependencies" or commit.scope == "deps-dev") %}

        {{ commit.body | indent(prefix="  ", first=true) }}
        {%- endif %}
    {%- endfor %}
{% endfor %}\n

"""

# Compare-link footer (requires [remote.github] below)
footer = """
{% for release in releases -%}
    {% if release.version -%}
        {% if release.previous.version -%}
            [{{ release.version | trim_start_matches(pat="v") }}]: \
                https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}\
                /compare/{{ release.previous.version }}...{{ release.version }}
        {% else -%}
            [{{ release.version | trim_start_matches(pat="v") }}]: \
                https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}\
                /tree/{{ release.version }}
        {% endif -%}
    {% else -%}
        {% if release.previous.version -%}
            [Unreleased]: https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}\
                /compare/{{ release.previous.version }}...HEAD
        {% else -%}
            [Unreleased]: https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}\
                /commits/HEAD
        {% endif -%}
    {% endif -%}
{% endfor -%}
"""

trim = true
# Collapse 3+ consecutive newlines into exactly 2 (one blank line).
# This prevents MD012 violations from Tera template whitespace artifacts.
postprocessors = [
    { pattern = '\n{3,}', replace = "\n\n" },
]

[git]
conventional_commits = true
# Include non-conventional commits so we capture the full history
# (mixed styles: "feat:", "Changed:", plain merge commits, dependency bumps).
filter_unconventional = false
filter_commits = false
protect_breaking_commits = true
# Expanded from the package's shared SemVer grammar when this template is read.
tag_pattern = '\Av(?:0|[1-9][0-9]*)\.(?:0|[1-9][0-9]*)\.(?:0|[1-9][0-9]*)(?:-(?:(?:0|[1-9][0-9]*)|[0-9A-Za-z-]*[A-Za-z-][0-9A-Za-z-]*)(?:\.(?:(?:0|[1-9][0-9]*)|[0-9A-Za-z-]*[A-Za-z-][0-9A-Za-z-]*))*)?(?:\+[0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*)?\z'
topo_order = false
sort_commits = "oldest"

# Link (#N) references to GitHub PRs before rendering.
# NOTE: The repo path is hardcoded here because commit_preprocessors run before
# Tera template rendering, so {{ remote.github.owner }} variables are not
# available. The body/footer templates above do use the remote.github variables.
commit_preprocessors = [
    { pattern = '(?m)^Closes #\d+\n\n', replace = "" },
    { pattern = '\(#(\d+)\)', replace = '[#${1}](https://github.com/acgetchell/la-stack/pull/${1})' },
]

commit_parsers = [
    # Skip merge commits and release-prep noise from the changelog body.
    { message = "^Merge pull request", skip = true },
    { message = "^Merge branch", skip = true },
    { message = '(?i)^(chore(:|\(release\):) |Changed: )?(prepare|release) v[0-9]', skip = true },

    # Dependency bumps: keep all bump commits so archived release history
    # preserves CI/action/tooling dependency updates as well as Rust crates.
    { message = "^chore\\(deps(?:-[^)]+)?\\)!?: bump ", group = "Dependencies" },
    { message = "(?i)^bump\\s+(deps?\\b|dependencies\\b|[A-Za-z0-9_.-]+/[A-Za-z0-9_./-]+|[A-Za-z0-9_.-]+\\s+from\\s+)", group = "Dependencies" },

    # Conventional commit types
    { message = "^feat", group = "Added" },
    { message = "^fix", group = "Fixed" },
    { message = "^perf", group = "Performance" },
    { message = "^refactor", group = "Changed" },
    { message = "^docs?", group = "Documentation" },
    { message = "^test", group = "Changed" },
    { message = "^style", group = "Changed" },
    { message = "^build", group = "Maintenance" },

    # Historical non-conventional commit categories
    { message = "(?i)^add", group = "Added" },
    { message = "(?i)^support", group = "Added" },
    { message = "(?i)^implement", group = "Added" },
    { message = "(?i)^deprecate", group = "Deprecated" },
    { message = "(?i)^remove", group = "Removed" },
    { message = "(?i)^delete", group = "Removed" },
    { message = "(?i)^change", group = "Changed" },
    { message = "(?i)^update", group = "Changed" },
    { message = "(?i)^fix", group = "Fixed" },

    # Chore / CI
    { message = "^chore|^ci", group = "Maintenance" },

    # Catch-all
    { message = ".*", group = "Changed" },
]

[remote.github]
owner = "acgetchell"
repo = "la-stack"