From e5e4ba5aec860a52c755ef5c7b300c53cf246d17 Mon Sep 17 00:00:00 2001 From: cutestnekoaqua Date: Tue, 3 Jan 2023 14:05:25 +0100 Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20automatic=20changelog=20generation?= =?UTF-8?q?=20using=20git=20cliffy?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- cliff.toml | 102 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 102 insertions(+) create mode 100644 cliff.toml diff --git a/cliff.toml b/cliff.toml new file mode 100644 index 000000000..fc187c3dd --- /dev/null +++ b/cliff.toml @@ -0,0 +1,102 @@ +# configuration file for git-cliff (0.1.0) + +[changelog] +# changelog header +header = """ +# Changelog\n +All notable changes to this project will be documented in this file.\n +""" +# template for the changelog body +# https://tera.netlify.app/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 %}{{ commit.message | upper_first }}\ + {% endfor %} +{% endfor %}\n +""" +# remove the leading and trailing whitespace from the template +trim = true +# changelog footer +footer = """ + +""" + +[git] +# parse the commits based on https://www.conventionalcommits.org +conventional_commits = false +# filter out the commits that are not conventional +filter_unconventional = true +# process each line of a commit as an individual commit +split_commits = false +# regex for preprocessing the commit messages +commit_preprocessors = [ + { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/orhun/git-cliff/issues/${2}))"}, +] +# regex for parsing and grouping commits +commit_parsers = [ + { message = "^feat", group = "Features"}, + { message = "^add", group = "Features"}, + { message = "^fix", group = "Bug Fixes"}, + { message = "^prevent", group = "Bug Fixes"}, + { message = "^doc", group = "Documentation"}, + { message = "^perf", group = "Performance"}, + { message = "^🎨", group = "Refactor"}, + { message = "^⚡️", group = "Refactor"}, + { message = "^🔥", group = "Features"}, + { message = "^🐛", group = "Bug Fixes"}, + { message = "^🚑️", group = "Bug Fixes"}, + { message = "^block", group = "Bug Fixes"}, + { message = "^✨", group = "Features"}, + { message = "^📝", group = "Documentation"}, + { message = "^🚀", group = "Features"}, + { message = "^💄", group = "Styling"}, + { message = "^✅", group = "Testing"}, + { message = "^🔒️", group = "Security"}, + { message = "^🚨", group = "Testing"}, + { message = "^💚", group = "CI"}, + { message = "^👷", group = "CI"}, + { message = "^⬇️", group = "Miscellaneous Tasks"}, + { message = "^⬆️", group = "Miscellaneous Tasks"}, + { message = "^📌", group = "Miscellaneous Tasks"}, + { message = "^➕", group = "Miscellaneous Tasks"}, + { message = "^➖", group = "Miscellaneous Tasks"}, + { message = "^♻️", group = "Refactor"}, + { message = "^🔧", group = "CI"}, + { message = "^🔨", group = "CI"}, + { message = "^🌐", group = "Localization"}, + { message = "^✏️", group = "Localization"}, + { message = "^👽️", group = "Bug Fixes"}, + { message = "^🍱", group = "Styling"}, + { message = "^♿️", group = "Styling"}, + { message = "^🩹", group = "Bug Fixes"}, + { message = "^refactor", group = "Refactor"}, + { message = "^style", group = "Styling"}, + { message = "^test", group = "Testing"}, + { message = "^chore\\(release\\): prepare for", skip = true}, + { message = "^chore", group = "Miscellaneous Tasks"}, + { message = "^update", group = "Miscellaneous Tasks"}, + { body = ".*security", group = "Security"}, +] +# 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 +# glob pattern 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 chronologically +date_order = false +# sort the commits inside sections by oldest/newest order +sort_commits = "oldest" +# limit the number of commits included in the changelog. +# limit_commits = 42