mirror of
https://github.com/hcengineering/platform.git
synced 2025-05-10 17:30:51 +00:00
Fix changelog
Signed-off-by: Andrey Sobolev <haiodo@gmail.com>
This commit is contained in:
parent
a807f99f16
commit
4ec4609364
22187
changelog.md
22187
changelog.md
File diff suppressed because it is too large
Load Diff
117
cliff.toml
117
cliff.toml
@ -1,86 +1,91 @@
|
|||||||
# git-cliff ~ default configuration file
|
# git-cliff configuration file
|
||||||
# https://git-cliff.org/docs/configuration
|
# https://git-cliff.org/docs/configuration
|
||||||
#
|
|
||||||
# Lines starting with "#" are comments.
|
|
||||||
# Configuration options are organized into tables and keys.
|
|
||||||
# See documentation for more information on available options.
|
|
||||||
|
|
||||||
|
#---------------------------------#
|
||||||
|
# Changelog Configuration #
|
||||||
|
#---------------------------------#
|
||||||
[changelog]
|
[changelog]
|
||||||
# template for the changelog footer
|
# Header template
|
||||||
header = """
|
header = """
|
||||||
# Changelog\n
|
# Changelog
|
||||||
Changelog.\n
|
|
||||||
|
All notable changes to this project will be documented in this file.
|
||||||
"""
|
"""
|
||||||
# template for the changelog body
|
|
||||||
# https://keats.github.io/tera/docs/#introduction
|
# Body template - updated with GitHub profile links
|
||||||
body = """
|
body = """
|
||||||
{% if version %}\
|
{% if version %}
|
||||||
## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}\n
|
## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
|
||||||
{% else %}\
|
{% else %}
|
||||||
## [unreleased]\n
|
## [unreleased]
|
||||||
{% endif %}\
|
{% endif %}
|
||||||
{% for group, commits in commits | group_by(attribute="group") %}\
|
|
||||||
* {{ group | striptags | trim | upper }}: \
|
{% for author, commits in commits | group_by(attribute="author.name") %}
|
||||||
{% for commit in commits %}\
|
### {{ author }}
|
||||||
· {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
|
{% for commit in commits %}
|
||||||
{% if commit.breaking %}[**breaking**] {% endif %}\
|
- {% if commit.scope %}**{{ commit.scope }}:** {% endif %}{% if commit.breaking %}[**BREAKING**] {% endif %}{{ commit.message | trim | upper_first }}{% if commit.group %} ({{ commit.group | striptags | trim }}){% endif %}
|
||||||
{{ commit.message | trim | upper_first }} \
|
{% endfor %}
|
||||||
{% endfor %}
|
{% endfor %}
|
||||||
{% endfor %}\n
|
|
||||||
"""
|
"""
|
||||||
# template for the changelog footer
|
|
||||||
|
# Footer template
|
||||||
footer = """
|
footer = """
|
||||||
|
|
||||||
<!-- generated by git-cliff -->
|
<!-- generated by git-cliff -->
|
||||||
"""
|
"""
|
||||||
# remove the leading and trailing s
|
|
||||||
trim = true
|
trim = true
|
||||||
# postprocessors
|
|
||||||
postprocessors = [
|
postprocessors = [
|
||||||
# { pattern = '<REPO>', replace = "https://github.com/orhun/git-cliff" }, # replace repository URL
|
# { pattern = '<PATTERN>', replace = "replacement" },
|
||||||
]
|
]
|
||||||
|
|
||||||
|
#---------------------------------#
|
||||||
|
# Git Configuration #
|
||||||
|
#---------------------------------#
|
||||||
[git]
|
[git]
|
||||||
# parse the commits based on https://www.conventionalcommits.org
|
# Parse commits based on Conventional Commits spec
|
||||||
conventional_commits = true
|
conventional_commits = true
|
||||||
# filter out the commits that are not conventional
|
filter_unconventional = false
|
||||||
filter_unconventional = true
|
|
||||||
# process each line of a commit as an individual commit
|
|
||||||
split_commits = false
|
split_commits = false
|
||||||
# regex for preprocessing the commit messages
|
|
||||||
|
# Commit message preprocessing
|
||||||
commit_preprocessors = [
|
commit_preprocessors = [
|
||||||
{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/hcengineering/platform/issues/${2}))"},
|
{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/hcengineering/platform/issues/${2}))"},
|
||||||
{ pattern = "Merge pull request #([0-9]+) from [^ ]+", replace = "PR [#${1}](https://github.com/hcengineering/platform/pull/${1}):"},
|
{ pattern = "Merge pull request #([0-9]+) from [^ ]+", replace = "PR [#${1}](https://github.com/hcengineering/platform/pull/${1}):"},
|
||||||
|
{ pattern = "Signed-off-by:.*", replace = "" },
|
||||||
]
|
]
|
||||||
# regex for parsing and grouping commits
|
|
||||||
|
# Commit parsing and grouping
|
||||||
commit_parsers = [
|
commit_parsers = [
|
||||||
{ message = "^feat", group = "<!-- 0 -->🚀 Features" },
|
# Features and Improvements
|
||||||
{ message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" },
|
{ message = "^feat", group = "🚀 Features" },
|
||||||
{ message = "^doc", group = "<!-- 3 -->📚 Documentation" },
|
{ message = "^Merge pull request.*", group = "🔀 Merged Changes" },
|
||||||
{ message = "^perf", group = "<!-- 4 -->⚡ Performance" },
|
|
||||||
{ message = "^refactor", group = "<!-- 2 -->🚜 Refactor" },
|
# Fixes
|
||||||
{ message = "^style", group = "<!-- 5 -->🎨 Styling" },
|
{ message = "^fix", group = "🐛 Bug Fixes" },
|
||||||
{ message = "^test", group = "<!-- 6 -->🧪 Testing" },
|
|
||||||
|
# Code Changes
|
||||||
|
{ message = "^refactor", group = "🚜 Refactor" },
|
||||||
|
{ message = "^perf", group = "⚡ Performance" },
|
||||||
|
{ message = "^style", group = "🎨 Styling" },
|
||||||
|
|
||||||
|
# Documentation and Testing
|
||||||
|
{ message = "^doc", group = "📚 Documentation" },
|
||||||
|
{ message = "^test", group = "🧪 Testing" },
|
||||||
|
|
||||||
|
# Maintenance
|
||||||
{ message = "^chore\\(release\\): prepare for", skip = true },
|
{ message = "^chore\\(release\\): prepare for", skip = true },
|
||||||
{ message = "^chore\\(deps.*\\)", skip = true },
|
{ message = "^chore\\(deps.*\\)", skip = true },
|
||||||
{ message = "^chore\\(pr\\)", skip = true },
|
{ message = "^chore\\(pr\\)", skip = true },
|
||||||
{ message = "^chore\\(pull\\)", skip = true },
|
{ message = "^chore\\(pull\\)", skip = true },
|
||||||
{ message = "^chore|^ci", group = "<!-- 7 -->⚙️ Miscellaneous Tasks" },
|
{ message = "^chore|^ci", group = "⚙️ Miscellaneous Tasks" },
|
||||||
{ body = ".*security", group = "<!-- 8 -->🛡️ Security" },
|
|
||||||
{ message = "^revert", group = "<!-- 9 -->◀️ Revert" },
|
# Special Categories
|
||||||
|
{ body = ".*security", group = "🛡️ Security" },
|
||||||
|
{ message = "^revert", group = "◀️ Revert" },
|
||||||
]
|
]
|
||||||
# protect breaking changes from being skipped due to matching a skipping commit_parser
|
|
||||||
protect_breaking_commits = false
|
protect_breaking_commits = false
|
||||||
# filter out the commits that are not matched by commit parsers
|
|
||||||
filter_commits = false
|
filter_commits = false
|
||||||
# regex for matching git tags
|
|
||||||
# tag_pattern = "v[0-9].*"
|
|
||||||
# regex for skipping tags
|
|
||||||
# skip_tags = ""
|
|
||||||
# regex for ignoring tags
|
|
||||||
# ignore_tags = ""
|
|
||||||
# sort the tags topologically
|
|
||||||
topo_order = false
|
topo_order = false
|
||||||
# sort the commits inside sections by oldest/newest order
|
|
||||||
sort_commits = "oldest"
|
sort_commits = "oldest"
|
||||||
# limit the number of commits included in the changelog.
|
|
||||||
# limit_commits = 42
|
|
||||||
|
Loading…
Reference in New Issue
Block a user