Skip to content

Commit 830b806

Browse files
committed
chore: Add changelog using cliff
1 parent 1ef5ae0 commit 830b806

File tree

2 files changed

+103
-0
lines changed

2 files changed

+103
-0
lines changed

CHANGELOG.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
## [0.5.1] - 2023-07-03
6+
7+
### Fix
8+
9+
- Add back the diverging sampler stats (Adrian Seyboldt)
10+
- Use one as initial mass matrix if grad is zero (Adrian Seyboldt)
11+
12+
### Documentation
13+
14+
- Update links from aseyboldt to pymc-devs (Adrian Seyboldt)
15+
16+
17+
### Miscellaneous Tasks
18+
19+
- Update metadata in Cargo.toml (Adrian Seyboldt)
20+
21+
22+
### Styling
23+
24+
- Formatting fix (Adrian Seyboldt)
25+
26+
27+
<!-- generated by git-cliff -->

cliff.toml

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# git-cliff ~ default configuration file
2+
# https://git-cliff.org/docs/configuration
3+
#
4+
# Lines starting with "#" are comments.
5+
# Configuration options are organized into tables and keys.
6+
# See documentation for more information on available options.
7+
8+
[changelog]
9+
# changelog header
10+
header = """
11+
# Changelog\n
12+
All notable changes to this project will be documented in this file.\n
13+
"""
14+
# template for the changelog body
15+
# https://tera.netlify.app/docs
16+
body = """
17+
{% if version %}\
18+
## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
19+
{% else %}\
20+
## [unreleased]
21+
{% endif %}\
22+
{% for group, commits in commits | group_by(attribute="group") %}
23+
### {{ group | upper_first }}
24+
{% for commit in commits %}
25+
- {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }} \
26+
({{ commit.author.name }})
27+
{% endfor %}
28+
{% endfor %}\n
29+
"""
30+
# remove the leading and trailing whitespace from the template
31+
trim = true
32+
# changelog footer
33+
footer = """
34+
<!-- generated by git-cliff -->
35+
"""
36+
37+
[git]
38+
# parse the commits based on https://www.conventionalcommits.org
39+
conventional_commits = true
40+
# filter out the commits that are not conventional
41+
filter_unconventional = true
42+
# process each line of a commit as an individual commit
43+
split_commits = false
44+
# regex for preprocessing the commit messages
45+
commit_preprocessors = [
46+
# { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/orhun/git-cliff/issues/${2}))"}, # replace issue numbers
47+
]
48+
# regex for parsing and grouping commits
49+
commit_parsers = [
50+
{ message = "^feat", group = "Features" },
51+
{ message = "^fix", group = "Bug Fixes" },
52+
{ message = "^doc", group = "Documentation" },
53+
{ message = "^perf", group = "Performance" },
54+
{ message = "^refactor", group = "Refactor" },
55+
{ message = "^style", group = "Styling" },
56+
{ message = "^test", group = "Testing" },
57+
{ message = "^chore\\(release\\): prepare for", skip = true },
58+
{ message = "^chore", group = "Miscellaneous Tasks" },
59+
{ body = ".*security", group = "Security" },
60+
]
61+
# protect breaking changes from being skipped due to matching a skipping commit_parser
62+
protect_breaking_commits = false
63+
# filter out the commits that are not matched by commit parsers
64+
filter_commits = false
65+
# glob pattern for matching git tags
66+
tag_pattern = "v[0-9]*"
67+
# regex for skipping tags
68+
skip_tags = "v0.1.0-beta.1"
69+
# regex for ignoring tags
70+
ignore_tags = ""
71+
# sort the tags topologically
72+
topo_order = false
73+
# sort the commits inside sections by oldest/newest order
74+
sort_commits = "oldest"
75+
# limit the number of commits included in the changelog.
76+
# limit_commits = 42

0 commit comments

Comments
 (0)