typescript/cliff.toml at main · helpers4/typescript · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
# git-cliff configuration for helpers4/typescript
# https://git-cliff.org/docs/configuration

[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 [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n
"""
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 | striptags | trim | upper_first }}
{% for commit in commits | filter(attribute="scope") | sort(attribute="scope") -%}
- **{{ commit.scope }}**: {{ commit.message }}
{%- if commit.breaking %} [**BREAKING**]{% endif %}
{% endfor -%}
{% for commit in commits -%}
{% if not commit.scope -%}
- {{ commit.message }}
{%- if commit.breaking %} [**BREAKING**]{% endif %}
{% endif -%}
{% endfor -%}
{% endfor %}
"""
footer = """
{% for release in releases -%}
{% if release.version -%}
{% if release.previous.version -%}
[{{ release.version | trim_start_matches(pat="v") }}]: https://github.com/helpers4/typescript/compare/{{ release.previous.version }}...{{ release.version }}
{% endif -%}
{% else -%}
[Unreleased]: https://github.com/helpers4/typescript/compare/{{ release.previous.version }}...HEAD
{% endif -%}
{% endfor %}
"""
postprocessors = [
  { pattern = '</?[A-Za-z][^>]*>', replace = "" },
]

[git]
conventional_commits = true
filter_unconventional = true
split_commits = false
protect_breaking_commits = true
tag_pattern = "v[0-9].*"
sort_commits = "newest"

commit_preprocessors = [
  # Strip Unicode gitmoji between scope/type and description
  { pattern = ':\s+[^\x00-\x7F]+\s+', replace = ": " },
  # Strip :shortcode: gitmoji (older commits)
  { pattern = ':\s+:[a-z_]+:\s+', replace = ": " },
]

commit_parsers = [
  { message = "^feat", group = "<!-- 0 -->🚀 Features" },
  { message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" },
  { message = "^perf", group = "<!-- 2 -->⚡ Performance" },
  { message = "^refactor", group = "<!-- 3 -->♻️ Refactoring" },
  { message = "^docs", group = "<!-- 4 -->📝 Documentation" },
  { message = "^test", group = "<!-- 5 -->✅ Tests" },
  { message = "^style", group = "<!-- 6 -->💄 Style" },
  { message = "^build", group = "<!-- 7 -->📦 Build" },
  { message = "^ci", group = "<!-- 8 -->👷 CI/CD" },
  { message = "^chore\\(release\\)", skip = true },
  { message = "^chore\\(deps\\)", group = "<!-- 9 -->📌 Dependencies" },
  { message = "^chore", group = "<!-- 10 -->🔧 Miscellaneous" },
  { message = "^revert", group = "<!-- 11 -->⏪ Reverted" },
]