File Content: cliff.toml # git-cliff ~ configuration file # https://git-cliff.org/docs/configuration [changelog] # template for the changelog footer 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 -%} ## [v{{ version | trim_start_matches(pat="v") }}] {% else -%} ## [Unreleased] {% endif -%} {% for group, commits in commits | group_by(attribute="group") %} ### {{ group | striptags }} {% for commit in commits %} - [{{ commit.id | truncate(length=7, end="") }}](https://github.com/williamdes/mariadb-mysql-kbs/commit/{{ commit.id }}) {{ commit.message }}\ {% endfor %} {% 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/williamdes/mariadb-mysql-kbs\ /compare/{{ release.previous.version }}..{{ release.version }} {% endif -%} {% else -%} [unreleased]: https://github.com/williamdes/mariadb-mysql-kbs\ /compare/{{ release.previous.version }}..HEAD {% endif -%} {% endfor %} <!-- generated by git-cliff --> """ # remove the leading and trailing whitespace from the templates trim = true [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 parsing and grouping commits commit_parsers = [ { body = "^.*[changelog skip].*$", skip = true }, { message = "^update", group = "<!-- 0 -->Changed" }, { message = "^removed", group = "<!-- 0 -->Removed" }, { message = "^add", group = "<!-- 0 -->Added" }, { message = "^added", group = "<!-- 0 -->Added" }, { message = "^doc", group = "<!-- 3 -->Documentation" }, { message = "^docs", group = "<!-- 3 -->Documentation" }, { message = "^fix", group = "<!-- 1 -->Fixed" }, { message = "^feat", group = "<!-- 2 -->Features" }, { message = "^perf", group = "<!-- 4 -->Performance" }, { message = "^refactor", group = "<!-- 5 -->Refactor" }, { message = "^style", skip = true }, { message = "^test", group = "<!-- 6 -->Testing" }, { message = "^chore|^ci", group = "<!-- 7 -->Others" }, ] # 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 = true # 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 = "newest" Submit