-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
build: introduce git-cliff to generate the changelog
- Loading branch information
Showing
2 changed files
with
301 additions
and
45 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| # git-cliff ~ default configuration file | ||
| # https://git-cliff.org/docs/configuration | ||
| # | ||
| # Lines starting with "#" are comments. | ||
| # Configuration options are organized into tables and keys. | ||
| # See documentation for more information on available options. | ||
|
|
||
| [changelog] | ||
| # template for the changelog footer | ||
| 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 | ||
| # postprocessors | ||
| postprocessors = [ | ||
| # { pattern = '<REPO>', replace = "https://github.com/orhun/git-cliff" }, # replace repository URL | ||
| ] | ||
|
|
||
| [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 preprocessing the commit messages | ||
| commit_preprocessors = [ | ||
| # Replace issue numbers | ||
| #{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))"}, | ||
| # Check spelling of the commit with https://github.com/crate-ci/typos | ||
| # If the spelling is incorrect, it will be automatically fixed. | ||
| #{ pattern = '.*', replace_command = 'typos --write-changes -' }, | ||
| ] | ||
| # regex for parsing and grouping commits | ||
| commit_parsers = [ | ||
| { message = "^feat", group = "<!-- 0 -->🚀 Features" }, | ||
| { message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" }, | ||
| { message = "^doc", group = "<!-- 3 -->📚 Documentation" }, | ||
| { message = "^perf", group = "<!-- 4 -->⚡ Performance" }, | ||
| { message = "^refactor", group = "<!-- 2 -->🚜 Refactor" }, | ||
| { message = "^style", group = "<!-- 5 -->🎨 Styling" }, | ||
| { message = "^test", group = "<!-- 6 -->🧪 Testing" }, | ||
| { message = "^chore\\(release\\): prepare for", skip = true }, | ||
| { message = "^chore\\(deps.*\\)", skip = true }, | ||
| { message = "^chore\\(pr\\)", skip = true }, | ||
| { message = "^chore\\(pull\\)", skip = true }, | ||
| { message = "^chore|^ci", group = "<!-- 7 -->⚙️ Miscellaneous Tasks" }, | ||
| { body = ".*security", group = "<!-- 8 -->🛡️ Security" }, | ||
| { message = "^revert", group = "<!-- 9 -->◀️ Revert" }, | ||
| ] | ||
| # 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 | ||
| # regex for matching git tags | ||
| # tag_pattern = "v[0-9].*" | ||
| # regex for skipping tags | ||
| # skip_tags = "" | ||
| # regex for ignoring tags | ||
| # ignore_tags = "" | ||
| # sort the tags topologically | ||
| topo_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 |