You've already forked CS-Box
Alexander Lyall
e4a8617927
All checks were successful
Changelog / changelog (push) Successful in 21s
- Add initial CHANGELOG.md (Keep a Changelog format) - Group historical commits by Conventional Commit type - Stabilise git-cliff configuration for automated changelog generation - Fix template issues to support first run with no tags - Align changelog wording with Computing:Box branding Signed-off-by: Alexander Lyall <alex@adcm.uk>
57 lines
1.4 KiB
TOML
57 lines
1.4 KiB
TOML
# git-cliff configuration
|
|
# Keep a Changelog compatible
|
|
# Safe for first run with no tags
|
|
|
|
[changelog]
|
|
header = """
|
|
# Changelog
|
|
|
|
All notable changes to this project will be documented in this file.
|
|
|
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
|
and this project adheres to [Conventional Commits](https://www.conventionalcommits.org/).
|
|
"""
|
|
|
|
body = """
|
|
{% if version %}
|
|
## [{{ version }}] - {{ timestamp | date(format="%Y-%m-%d") }}
|
|
{% else %}
|
|
## [Unreleased]
|
|
{% endif %}
|
|
|
|
{% for group, commits in commits | group_by(attribute="group") %}
|
|
### {{ group }}
|
|
|
|
{% for commit in commits %}
|
|
- {{ commit.message | trim }}
|
|
{% endfor %}
|
|
{% endfor %}
|
|
"""
|
|
|
|
footer = """
|
|
<!-- generated by git-cliff -->
|
|
"""
|
|
|
|
trim = true
|
|
|
|
[git]
|
|
conventional_commits = true
|
|
filter_unconventional = false
|
|
split_commits = false
|
|
commit_parsers = [
|
|
{ message = "^feat", group = "Added" },
|
|
{ message = "^fix", group = "Fixed" },
|
|
{ message = "^docs", group = "Documentation" },
|
|
{ message = "^style", group = "Styling" },
|
|
{ message = "^refactor", group = "Changed" },
|
|
{ message = "^perf", group = "Performance" },
|
|
{ message = "^test", group = "Tests" },
|
|
{ message = "^build", group = "Build" },
|
|
{ message = "^ci", group = "CI" },
|
|
{ message = "^chore", group = "Chore" },
|
|
{ message = "^revert", group = "Reverted" }
|
|
]
|
|
|
|
protect_breaking_commits = false
|
|
sort_commits = "oldest"
|