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

[changelog]
# A Tera template to be rendered as the changelog's header.
# See https://keats.github.io/tera/docs/#introduction
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.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n
"""
# A Tera template to be rendered for each release in the changelog.
# See https://keats.github.io/tera/docs/#introduction
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 | upper_first }}
    {% for commit in commits %}
        - {% if commit.breaking %}**BREAKING** {% endif %}\
          {%- if commit.scope %}{{ commit.scope }}: {% endif %}\
          {{- commit.message | split(pat="\n") | first | upper_first | trim }}\
    {% endfor %}
{% endfor %}\n
"""
# A Tera template to be rendered as the changelog's footer.
# See https://keats.github.io/tera/docs/#introduction
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 -%}
        [unreleased]: https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}\
            /compare/{{ release.previous.version }}..HEAD
    {% endif -%}
{% endfor %}
<!-- generated by git-cliff -->
"""
# Remove leading and trailing whitespaces from the changelog's body.
trim = true

[remote.github]
owner = "datahearth"
repo = "streamline"

[git]
# Only app tags are releases here. The chart versions independently on chart-v*
# tags (.taskfiles/release.yaml), and without this git-cliff reads those as app
# releases: the changelog grew a "[chart-v2.1.0]" section, and every app release
# cut after a chart tag covered only the commits since that chart tag.
tag_pattern = "^v[0-9]+\\.[0-9]+\\.[0-9]+"
# Parse commits according to the conventional commits specification.
# See https://www.conventionalcommits.org
conventional_commits = true
# Exclude commits that do not match the conventional commits specification.
filter_unconventional = false
# An array of regex based parsers for extracting data from the commit message.
# Assigns commits to groups.
# Optionally sets the commit's scope and can decide to exclude commits from further processing.
# Keyed off the scoped conventional commits the repo adopted. This is the only
# place release content is filtered — GitHub release bodies are the rendered
# CHANGELOG.md section (see .github/workflows/release.yaml).
commit_parsers = [
    # filter_unconventional = false sends anything unmatched to Changed, and an
    # empty commit message renders there as a bare "- ".
    { message = "^\\s*$", skip = true },
    # Scope, not path: --exclude-path drops a commit only when *every* file it
    # touched is excluded, and a chart change routinely edits one file outside
    # deploy/helm — a `feat(helm)!` that also touches ci.yaml and the Taskfile
    # would land in the app's notes as a breaking change to an app nobody
    # deploys with helm. A (helm)-scoped commit is a chart
    # change by definition; cliff.chart.toml is where it belongs.
    { message = "^\\w+\\(helm\\)", skip = true },
    { message = "^feat", group = "Added" },
    { message = "^fix", group = "Fixed" },
    { message = "^revert", group = "Removed" },
    { message = "^docs", skip = true },
    { message = "^test", skip = true },
    { message = "^chore", skip = true },
    { message = "^ci", skip = true },
    { message = "^style", skip = true },
    { message = "^.*", group = "Changed" },
]
# Prevent commits that are breaking from being excluded by commit parsers.
filter_commits = false
# Order releases topologically instead of chronologically.
topo_order = false
# Order of commits in each group/release within the changelog.
# Allowed values: newest, oldest
sort_commits = "oldest"