-
Notifications
You must be signed in to change notification settings - Fork 218
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(docs): add git-cliff config for easier changelog generation
- Loading branch information
Showing
1 changed file
with
54 additions
and
0 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
# https://git-cliff.org/docs/configuration | ||
|
||
[changelog] | ||
header = "# Change log\n\n" | ||
body = """ | ||
{% if version %}\ | ||
## {{ version | trim_start_matches(pat="v") }} ({{ timestamp | date(format="%Y-%m-%d") }}) | ||
{% else %}\ | ||
## (unreleased) | ||
{% endif %} | ||
{% for commit in commits %}\ | ||
- {{ commit.group }}: {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message }} by {{ commit.author.name }} | ||
{% endfor %}\n | ||
""" | ||
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 preprocessing the commit messages | ||
commit_preprocessors = [ | ||
{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/evilmartians/lefthook/pull/${2}))"}, # replace issue numbers | ||
] | ||
# regex for parsing and grouping commits | ||
commit_parsers = [ | ||
{ message = "^feat", group = "feat" }, | ||
{ message = "^fix", group = "fix" }, | ||
{ message = "^docs", group = "docs" }, | ||
{ message = "^perf", group = "perf" }, | ||
{ message = "^refactor", group = "refactor" }, | ||
{ message = "^ci", group = "ci" }, | ||
{ message = "^test", group = "test" }, | ||
{ message = "^chore\\(release\\): prepare for", skip = true }, | ||
{ message = "^chore", group = "chore" }, | ||
{ 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 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 |