# git-cliff ~ configuration file # https://git-cliff.org/docs/configuration [changelog] header = """ # Changelog\n All notable changes to this project will be documented in this file. See [conventional commits](https://www.conventionalcommits.org/) for commit guidelines.\n """ body = """ --- {% if version %} {% if previous.version %} ## [{{ version | trim_start_matches(pat="v") }}]($REPO/compare/{{ previous.version }}..{{ version }}) - {{ timestamp | date(format="%Y-%m-%d") }} {% else %} ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }} {% endif %} {% else %} ## [unreleased] {% endif %} {% for group, commits in commits | group_by(attribute="group") %} ### {{ group | striptags | trim | upper_first }} {% for commit in commits | filter(attribute="scope") | sort(attribute="scope") %} - **({{commit.scope}})**{% if commit.breaking %} [**breaking**]{% endif %} {{ commit.message|trim }} - ([{{ commit.id | truncate(length=7, end="") }}]($REPO/commit/{{ commit.id }})) - {{ commit.author.name }} {%- endfor -%} {% raw %}\n{% endraw %} {%- for commit in commits %} {%- if not commit.scope -%} - {% if commit.breaking %} [**breaking**]{% endif %}{{ commit.message|trim }} - ([{{ commit.id | truncate(length=7, end="") }}]($REPO/commit/{{ commit.id }})) - {{ commit.author.name }} {%- endif -%} {% endfor -%} {% endfor %}\n """ footer = "" trim = true postprocessors = [ { pattern = '\$REPO', replace = "https://github.com/rustsbi/prototyper" }, ] [git] conventional_commits = true filter_unconventional = false split_commits = false commit_preprocessors = [] commit_parsers = [ { message = "\\[skip", skip = true }, { message = "\\p{Han}", skip = true }, { message = "^feat", group = "Features" }, { message = "^fix", group = "Bug Fixes" }, { message = "^doc", group = "Documentation" }, { message = "^perf", group = "Performance" }, { message = "^refactor", group = "Refactoring" }, { message = "^style", group = "Style" }, { message = "^revert", group = "Revert" }, { message = "^test", group = "Tests" }, { message = "^chore\\(version\\):", skip = true }, { message = "^chore", group = "Miscellaneous Chores" }, { message = ".*", group = "Other" }, { body = ".*security", group = "Security" }, ] protect_breaking_commits = false filter_commits = false tag_pattern = "v[0-9].*" skip_tags = "v0.1.0-beta.1" ignore_tags = "" topo_order = false sort_commits = "oldest"