cliff.toml

# Copyright (c) 2026, NVIDIA CORPORATION.  All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# git-cliff configuration
# https://git-cliff.org/docs/configuration
#
# This configuration mirrors the changelog settings in .goreleaser.yaml
# to ensure consistency between release notes and CHANGELOG.md

[changelog]
# Changelog header
header = """
# Changelog

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

"""
# Template for the changelog body
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 | striptags | trim | upper_first }}
    {% for commit in commits %}
        - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
            {{ commit.message | upper_first }}\
            {% if commit.remote.username %} by [@{{ commit.remote.username }}](https://github.com/{{ commit.remote.username }}){%- endif %}\
    {% endfor %}
{% endfor %}\n
"""
# Template for the changelog footer
footer = """
<!-- Generated by git-cliff -->
"""
# Remove leading and trailing whitespace from the templates
trim = true

[git]
# Parse conventional commits
conventional_commits = true
# Include all commits (non-conventional commits go to "Other" group)
filter_unconventional = false
# Process each line of a commit as an individual commit
split_commits = false
# Regex for preprocessing the commit messages
commit_preprocessors = [
    # Remove issue numbers from commit messages
    { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "" },
]
# Regex for parsing and grouping commits
# Three categories: New Features, Bug Fixes, Other Tasks
commit_parsers = [
    { message = "^feat", group = "New Features" },
    { message = "^fix", group = "Bug Fixes" },
    { message = "^bug", group = "Bug Fixes" },
    # Skip commits that should not appear in changelog
    { message = "^docs:", skip = true },
    { message = "^test:", skip = true },
    { message = "^lint:", skip = true },
    { message = "^chore: readme", skip = true },
    { message = "^chore: bump version", skip = true },
    { message = "^chore: update CHANGELOG", skip = true },
    { message = "^build: release v[0-9]+\\.[0-9]+\\.[0-9]+", skip = true },
    # Everything else (refactor, chore, ci, build, perf, etc.)
    { message = ".*", group = "Other Tasks" },
]
# Protect breaking changes from being skipped
protect_breaking_commits = false
# Filter out commits by their body
filter_commits = false
# Glob pattern for matching git tags
tag_pattern = "v[0-9].*"
# Regex for skipping tags
skip_tags = ""
# Regex for ignoring tags
ignore_tags = ""
# Sort commits by date (oldest first, matching goreleaser's sort: asc)
topo_order = false
# Sort commits within a group by date
sort_commits = "oldest"