Skip to content

Commit 677eabc

Browse files
committed
docs: add commit to changelog settings.
1 parent 2ce7e8c commit 677eabc

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

Diff for: cliff.toml

+16-2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,14 @@
55
header = """
66
# Changelog\n
77
All notable changes to this project will be documented in this file.\n
8+
Acronyms:
9+
- LB: lab-report
10+
- MT: master-thesis
11+
- PT: paper-translation
12+
- PS: presentation-slide
13+
- UPR: undergraduate-proposal-report
14+
- UT: undergraduate-thesis\n
15+
**Bolded text highlight its importance.**\n
816
"""
917
# template for the changelog body
1018
# https://tera.netlify.app/docs/#introduction
@@ -14,10 +22,16 @@ body = """
1422
{% else %}\
1523
## [unreleased]
1624
{% endif %}\
25+
{% if previous %}\
26+
{% if previous.commit_id %}
27+
[{{ previous.commit_id | truncate(length=7, end="") }}]({{ previous.commit_id }})...\
28+
[{{ commit_id | truncate(length=7, end="") }}]({{ commit_id }})
29+
{% endif %}\
30+
{% endif %}\
1731
{% for group, commits in commits | group_by(attribute="group") %}
1832
### {{ group | upper_first }}
1933
{% for commit in commits %}
20-
- {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\
34+
- {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }} ([{{ commit.id | truncate(length=7, end="") }}]({{ commit.id }}))\
2135
{% endfor %}
2236
{% endfor %}\n
2337
"""
@@ -51,7 +65,7 @@ filter_commits = false
5165
# glob pattern for matching git tags
5266
tag_pattern = "v[0-9]*"
5367
# regex for skipping tags
54-
skip_tags = "v0.1.0-beta.1"
68+
# skip_tags = "v0.1.0-beta.1"
5569
# regex for ignoring tags
5670
ignore_tags = ""
5771
# sort the tags chronologically

0 commit comments

Comments
 (0)