From 794073b46befd6291821076a3d649f7891649f8c Mon Sep 17 00:00:00 2001 From: Jan Ferdinand Sauer Date: Mon, 9 Oct 2023 12:26:57 +0200 Subject: [PATCH] chore(deps): add config file for `git-cliff` --- cliff.toml | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 cliff.toml diff --git a/cliff.toml b/cliff.toml new file mode 100644 index 000000000..b11ad7d29 --- /dev/null +++ b/cliff.toml @@ -0,0 +1,51 @@ +# https://git-cliff.org/docs/configuration + +[changelog] +# Template engine: https://keats.github.io/tera/docs/ + +header = "" +body = """ +release Triton VM {{ version }} +{% for group, commits in commits | group_by(attribute="group") %} + # {{ group | striptags | trim | upper_first }} + {% for commit in commits %} + - {% if commit.breaking %}(!) {% endif %}{{ commit.message | upper_first }} ({{ commit.id | truncate(length=8, end="") }})\ + {% endfor %} +{% endfor %}\n +""" +footer = "Note: (!) indicates a breaking change.\n" +trim = true + +postprocessors = [] + +[git] + +conventional_commits = true +filter_unconventional = true +split_commits = false +commit_preprocessors = [] + +# Use hack to sort the categories. See: https://github.com/orhun/git-cliff/issues/9 +commit_parsers = [ + { message = "^feat", group = " ✨ Features" }, + { message = "^fix", group = " 🐛 Bug Fixes" }, + { message = "^perf", group = " ⚡️ Performance" }, + { message = "^doc", group = " 📝 Documentation" }, + { message = "^chore\\(deps\\)", skip = true }, + { message = "^chore\\(pr\\)", skip = true }, + { message = "^chore\\(pull\\)", skip = true }, + { message = "^chore|ci|misc", group = " 🔧 Miscellaneous" }, + { message = "^refactor", group = " ♻️ Refactor" }, + { message = "^test", group = " ✅ Testing" }, + { body = ".*security", group = " 🔒️ Security" }, + { message = "^revert", group = " ⏪️ Revert" }, + { message = "^style", group = " 💄 Styling" }, +] + +protect_breaking_commits = false +filter_commits = false +tag_pattern = "v[0-9]*\\.[0-9]*\\.[0-9]*" +skip_tags = "" +ignore_tags = "" +topo_order = false +sort_commits = "oldest"