diff --git a/cliff.toml b/cliff.toml new file mode 100644 index 0000000..1407000 --- /dev/null +++ b/cliff.toml @@ -0,0 +1,71 @@ +# ============================================================ +# GIT CLIFF CONFIGURATION +# ============================================================ + +[changelog] + +header = """ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on: +https://keepachangelog.com +https://semver.org +""" + +body = """ +{% if version %} +## {{ version }} โ€” {{ timestamp | date(format="%Y-%m-%d") }} +{% else %} +## Unreleased +{% endif %} + +{% for group, commits in commits | group_by(attribute="group") %} +### {{ group }} + +{% for commit in commits %} +- {{ commit.message | upper_first }} ({{ commit.id | truncate(length=7, end="") }}) +{% endfor %} +{% endfor %} +""" + +footer = """ +--- + +Generated automatically by git-cliff +""" + +trim = true + + +[git] + +conventional_commits = true +filter_unconventional = true +split_commits = false +sort_commits = "oldest" + +commit_parsers = [ + +{ message = ".*!", group = "๐Ÿ’ฅ Breaking Changes" }, +{ message = "^feat(\\(.+\\))?:", group = "๐Ÿš€ Features" }, +{ message = "^fix(\\(.+\\))?:", group = "๐Ÿ› Bug Fixes" }, +{ message = "^perf(\\(.+\\))?:", group = "โšก Performance" }, +{ message = "^refactor(\\(.+\\))?:", group = "โ™ป๏ธ Refactoring" }, +{ message = "^docs(\\(.+\\))?:", group = "๐Ÿ“š Documentation" }, +{ message = "^style(\\(.+\\))?:", group = "๐ŸŽจ Styling" }, +{ message = "^test(\\(.+\\))?:", group = "๐Ÿงช Tests" }, +{ message = "^build(\\(.+\\))?:", group = "๐Ÿ“ฆ Build System" }, +{ message = "^ci(\\(.+\\))?:", group = "โš™๏ธ CI" }, +{ message = "^chore(\\(.+\\))?:", group = "๐Ÿ”ง Maintenance" } + +] + +tag_pattern = "v[0-9]*" + + +[remote.github] + +owner = "your-user" +repo = "your-repo"