[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://keats.github.io/tera/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 | striptags | trim | upper_first }} {% for commit in commits %} - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\ {% if commit.breaking %}[**breaking**] {% endif %}\ {{ commit.message | upper_first }}\ {% endfor %} {% endfor %}\n """ # template for the changelog footer footer = """ <!-- generated by git-cliff --> """ # remove the leading and trailing s 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 = true # process each line of a commit as an individual commit split_commits = false # regex for parsing and grouping commits commit_parsers = [ { message = "^feat", group = "<!-- 0 -->๐ Features" }, { message = "^fix|^bugfix|^hotfix", group = "<!-- 1 -->๐ Bug Fixes" }, { message = "^refactor", group = "<!-- 2 -->๐ Refactor" }, { message = "^doc.*update changelog.*", group = "<!-- 3 -->๐ Documentation", skip = true }, { message = "^doc", group = "<!-- 3 -->๐ Documentation" }, { message = "^perf", group = "<!-- 4 -->โก Performance" }, { message = "^style", group = "<!-- 5 -->๐จ Styling" }, { message = "^test", group = "<!-- 6 -->๐งช Testing" }, { message = "^chore|^ci", group = "<!-- 7 -->โ๏ธ Miscellaneous Tasks", skip = true }, { body = ".*security", group = "<!-- 8 -->๐ก๏ธ Security" }, { message = "^revert", group = "<!-- 9 -->โ๏ธ Revert" }, { message = "^chore\\(release\\): prepare for", skip = true }, { message = "^chore\\(deps.*\\)", skip = true }, { message = "^chore\\(pr\\)", skip = true }, { message = "^chore\\(pull\\)", skip = true }, ] # protect breaking changes from being skipped due to matching a skipping commit_parser protect_breaking_commits = true # filter out the commits that are not matched by commit parsers filter_commits = true # sort the tags topologically topo_order = false # sort the commits inside sections by oldest/newest order sort_commits = "newest" # limit the number of commits included in the changelog. limit_commits = 100000