Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Menu
Open sidebar
Arch Linux
gitlab-exporter
Commits
ba073512
Verified
Commit
ba073512
authored
Jun 16, 2022
by
Leonidas Spyropoulos
Browse files
feat: add git cliff support for changelog
parent
e337c0f6
Pipeline
#20756
passed with stages
in 4 minutes and 14 seconds
Changes
1
Pipelines
2
Hide whitespace changes
Inline
Side-by-side
cliff.toml
0 → 100644
View file @
ba073512
# configuration file for git-cliff (0.1.0)
[changelog]
# changelog header
header
=
""
# template for the changelog body
# https://tera.netlify.app/docs/#introduction
body
=
"""
{% if version %}
\
Release [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
{% else %}
\
Release [unreleased]
{% endif %}
\
{% for group, commits in commits | group_by(attribute="group") %}
{{ group | lower }}
\
{% for commit in commits %}
- {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}
\
{% endfor %}
{% endfor %}
\n
"""
# remove the leading and trailing whitespace from the template
trim
=
true
# changelog footer
footer
=
""
[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 preprocessing the commit messages
commit_preprocessors
=
[
{
pattern
=
'\((\w+\s)?#([0-9]+)\)'
,
replace
=
"([#${2}](https://gitlab.archlinux.org/archlinux/gitlab-exporter/-/issues/${2}))"
}
,
]
# 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
=
"newest"
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment