# 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 = "prefix-dev" repo = "pixi" [changelog] # 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.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n """ # template for the changelog body # 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 %}\ ### ✨ Highlights ### 📃 Details {% for group, commits in commits | group_by(attribute="group") %} #### {{ group | upper_first }} {%- for commit in commits %} {% if commit.github.pr_labels is not containing("skip-release-notes") %} - {{ commit.message | upper_first | trim }}\ {% if commit.github.username %} by @{{ commit.github.username }}{%- endif -%} {% if commit.github.pr_number %} in [#{{ commit.github.pr_number }}]\ (https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}/pull/{{ commit.github.pr_number }}){%- endif -%} {% endif %} {% endfor %} {% endfor %} {%- if github.contributors | filter(attribute="is_first_time", value=true) | length != 0 %} ## New Contributors {%- endif -%} {% for contributor in github.contributors | filter(attribute="is_first_time", value=true) %} * @{{ contributor.username }} made their first contribution in [#{{ contributor.pr_number }}]\ (https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}/pull/{{ contributor.pr_number }})\ {%- endfor %}\n """ # template for the changelog footer 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 }} {% endif -%} {% else -%} [unreleased]: https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}\ /compare/{{ release.previous.version }}..HEAD {% endif -%} {% endfor %} """ # remove the leading and trailing whitespace from the template trim = true # changelog footer # postprocessors postprocessors = [ # { pattern = '', replace = "https://github.com/orhun/git-cliff" }, # 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 = 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 commits { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "" }, ] # regex for parsing and grouping commits commit_parsers = [ { message = "^.*: add", group = "Added" }, { message = "^[a|A]dd", group = "Added" }, { message = "^.*: support", group = "Added" }, { message = "^.*: remove", group = "Removed" }, { message = "^.*: delete", group = "Removed" }, { message = "^test", group = "Fixed" }, { message = "^fix", group = "Fixed" }, { message = "^.*: fix", group = "Fixed" }, { message = "^chore|ci", skip = true }, { message = "^.*", group = "Changed" }, ] # 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 = "" # 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"