Use git-cliff to generate changelog

Signed-off-by: Pawel Langowski <pawel.langowski@3mdeb.com>
This commit is contained in:
Pawel Langowski
2024-11-22 10:30:11 +01:00
parent 26a9293070
commit b689dc1c26
4 changed files with 930 additions and 350 deletions
+1 -1
View File
@@ -2,7 +2,7 @@
default_stages: [pre-commit]
default_install_hook_types: [pre-commit, commit-msg]
exclude: .*\.(patch)|(diff)$
exclude: .*\.(patch)|(diff)$|CHANGELOG.md
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
+841 -349
View File
File diff suppressed because it is too large Load Diff
+82
View File
@@ -0,0 +1,82 @@
# git-cliff ~ configuration file
# https://git-cliff.org/docs/configuration
[changelog]
# template for the changelog header
header = """
# Changelog\n
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.0.0/).\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 | filter(attribute="merge_commit", value=false) | group_by(attribute="group") %}
### {{ group | upper_first }}
{% for commit in commits %}
{%- set short_message = commit.message | split(pat="\n") | first | trim -%}
- {{ short_message | trim }}\n\
{% endfor %}
{% endfor %}\n
"""
# template for the changelog footer
footer = """
{% for release in releases -%}
{% if release.version -%}
{% if release.previous.version -%}
[{{ release.version | trim_start_matches(pat="v") }}]: \
https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}\
/compare/{{ release.previous.version }}..{{ release.version }}
{% endif -%}
{% else -%}
[unreleased]: https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}\
/compare/{{ release.previous.version }}..HEAD
{% endif -%}
{% endfor %}
<!-- generated by git-cliff -->
"""
# remove the leading and trailing whitespace from the templates
trim = true
[git]
# parse the commits based on https://www.conventionalcommits.org
conventional_commits = false
# 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 parsing and grouping commits
commit_parsers = [
{ message = "^.*: add", group = "Added" },
{ message = "^.*: support", group = "Added" },
{ message = "^.*: remove", group = "Removed" },
{ message = "^.*: delete", group = "Removed" },
{ message = "^test", group = "Fixed" },
{ message = "^fix", group = "Fixed" },
{ message = "^.*: fix", group = "Fixed" },
{ message = "^.*", group = "Changed" },
]
# 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 = "v0.1.0-beta.1"
# 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"
[remote.github]
owner="Dasharo"
repo="meta-dts"
+6
View File
@@ -0,0 +1,6 @@
#!/bin/bash
RELEASE=$(grep '^DISTRO_VERSION ' ./meta-dts-distro/conf/distro/dts-distro.conf | cut -d'=' -f2 | tr -d ' "')
docker run -t -v "$(pwd)":/app/ "orhunp/git-cliff:${TAG:-latest}" \
--prepend CHANGELOG.md --unreleased --tag "$RELEASE"