mirror of
https://github.com/orhun/git-cliff.git
synced 2024-12-15 16:21:44 +03:00
a3980f4632
* feat(changelog, config)!: replace --topo-order by --date-order Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp> * ci: simplify test-fixtures workflow Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp> * ci: add fixtures tests of topo_order and date_order Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp> * remove unnecessary checkout Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp> * remove cargo run Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp> * set GIT_COMMITTER_DATE for each commit Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp> * add a test for --date-order arg Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp> * fix git config style Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp> * remove an unnecessary period Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp> * apply #60 Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp> * minify the config files for tests Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp> * fix git config style Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp> * fix styles of expected.md Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp> * make some steps one-line Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp> * remove footers Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp> * remove newlines Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp> * Revert "remove newlines" This reverts commit802881523f. * Revert "remove footers" This reverts commit3d334cc9ef. * add trim and footer Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp>
76 lines
2.4 KiB
TOML
76 lines
2.4 KiB
TOML
# configuration file for git-cliff (0.1.0)
|
|
|
|
[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://tera.netlify.app/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 | upper_first }}
|
|
{% for commit in commits
|
|
| filter(attribute="scope")
|
|
| sort(attribute="scope") %}
|
|
- *({{commit.scope}})* {{ commit.message | upper_first }}
|
|
{%- if commit.breaking %}
|
|
{% raw %} {% endraw %}- **BREAKING**: {{commit.breaking_description}}
|
|
{%- endif -%}
|
|
{%- endfor -%}
|
|
{%- for commit in commits %}
|
|
{%- if commit.scope -%}
|
|
{% else -%}
|
|
- *(No Category)* {{ commit.message | upper_first }}
|
|
{% if commit.breaking -%}
|
|
{% raw %} {% endraw %}- **BREAKING**: {{commit.breaking_description}}
|
|
{% endif -%}
|
|
{% endif -%}
|
|
{% endfor -%}
|
|
{% raw %}\n{% endraw %}\
|
|
{% endfor %}\n
|
|
"""
|
|
# remove the leading and trailing whitespace from the template
|
|
trim = true
|
|
# changelog footer
|
|
footer = """
|
|
<!-- generated by git-cliff -->
|
|
"""
|
|
|
|
[git]
|
|
# parse the commits based on https://www.conventionalcommits.org
|
|
conventional_commits = true
|
|
# filter out the commits that are not conventional
|
|
filter_unconventional = true
|
|
# regex for parsing and grouping commits
|
|
commit_parsers = [
|
|
{ message = "^feat", group = "Features"},
|
|
{ message = "^fix", group = "Bug Fixes"},
|
|
{ message = "^doc", group = "Documentation"},
|
|
{ message = "^perf", group = "Performance"},
|
|
{ message = "^refactor", group = "Refactor"},
|
|
{ message = "^style", group = "Styling"},
|
|
{ message = "^test", group = "Testing"},
|
|
{ message = "^chore\\(release\\): prepare for", skip = true},
|
|
{ message = "^chore", group = "Miscellaneous Tasks"},
|
|
{ body = ".*security", group = "Security"},
|
|
]
|
|
# 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 skipping tags
|
|
skip_tags = "v0.1.0-beta.1"
|
|
# regex for ignoring tags
|
|
ignore_tags = ""
|
|
# sort the tags chronologically
|
|
date_order = false
|
|
# sort the commits inside sections by oldest/newest order
|
|
sort_commits = "oldest"
|