-
Notifications
You must be signed in to change notification settings - Fork 71
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(release): add cliff.toml and generate rustic_core changelog
Signed-off-by: simonsan <[email protected]>
- Loading branch information
Showing
2 changed files
with
143 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,82 @@ | ||
# git-cliff ~ default configuration file | ||
# 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] | ||
# changelog header | ||
header = """ | ||
# Changelog\n | ||
All notable changes to this project will be documented in this file.\n | ||
""" | ||
# template for the changelog body | ||
# https://tera.netlify.app/docs | ||
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 | upper_first }} | ||
{% for commit in commits %} | ||
- {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\ | ||
{% endfor %} | ||
{% endfor %}\n | ||
""" | ||
# remove the leading and trailing whitespace from the template | ||
trim = true | ||
# changelog footer | ||
footer = """ | ||
<!-- generated by git-cliff --> | ||
""" | ||
# postprocessors | ||
postprocessors = [ | ||
{ pattern = '<REPO>', replace = "https://github.com/rustic-rs/rustic" }, | ||
] | ||
[git] | ||
# parse the commits based on https://www.conventionalcommits.org | ||
conventional_commits = true | ||
# 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 preprocessing the commit messages | ||
commit_preprocessors = [ | ||
{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))" }, # replace issue numbers | ||
] | ||
# regex for parsing and grouping commits | ||
commit_parsers = [ | ||
{ message = "^feat", group = "Features" }, | ||
{ message = "^fix", group = "Bug Fixes" }, | ||
{ message = "^doc", group = "Documentation" }, | ||
{ message = "^perf", group = "Performance" }, | ||
{ message = "^refactor", group = "Refactor" }, | ||
{ message = "^style", group = "Styling", skip = true }, # we ignore styling in the changelog | ||
{ message = "^test", group = "Testing" }, | ||
{ message = "^chore\\(release\\): prepare for", skip = true }, | ||
{ message = "^chore\\(deps\\)", skip = true }, | ||
{ message = "^chore\\(pr\\)", skip = true }, | ||
{ message = "^chore\\(pull\\)", skip = true }, | ||
{ message = "^chore|ci", group = "Miscellaneous Tasks" }, | ||
{ 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 | ||
# filter out the commits that are not matched by commit parsers | ||
filter_commits = false | ||
# glob pattern 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" | ||
# limit the number of commits included in the changelog. | ||
# limit_commits = 42 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
# Changelog | ||
|
||
All notable changes to this project will be documented in this file. | ||
|
||
## [0.1.1] - 2023-09-14 | ||
|
||
### Bug Fixes | ||
|
||
- Correct glob-matching for relative paths ([#783](https://github.com/rustic-rs/rustic/issues/783)) | ||
|
||
### Documentation | ||
|
||
- Update Readme layout, move docs to separate repository, add rustic_core Readme.md ([#820](https://github.com/rustic-rs/rustic/issues/820)) | ||
- Add rustic_core logo | ||
- Set subtitle for rustic_core readme | ||
|
||
### Features | ||
|
||
- Option to disable requiring git repository for git-ignore rules | ||
- Wait for password-command to exit | ||
- Add `--json` option to `forget` command ([#806](https://github.com/rustic-rs/rustic/issues/806)) | ||
|
||
### Miscellaneous Tasks | ||
|
||
- Lint markdown with dprint, run initial dprint fmt ([#830](https://github.com/rustic-rs/rustic/issues/830)) | ||
- Lint has been removed | ||
|
||
### Refactor | ||
|
||
- Replace `nom` with `shellwords` to split strings ([#752](https://github.com/rustic-rs/rustic/issues/752)) | ||
- Add metadata to crate manifests ([#822](https://github.com/rustic-rs/rustic/issues/822)) | ||
|
||
### Build | ||
|
||
- Bump public-api from 0.29.1 to 0.31.2 ([#695](https://github.com/rustic-rs/rustic/issues/695)) | ||
- Bump public-api from 0.31.2 to 0.31.3 ([#796](https://github.com/rustic-rs/rustic/issues/796)) | ||
- Bump rustdoc-json from 0.8.6 to 0.8.7 ([#794](https://github.com/rustic-rs/rustic/issues/794)) | ||
|
||
### Prune | ||
|
||
- Add example using rustic_core | ||
- Don't abort if time is unset for pack-to-delete | ||
|
||
### Repoinfo | ||
|
||
- Add options --json, --only-files, --only-index | ||
|
||
### Rest/rclone | ||
|
||
- Make # of retries cusomizable and use sensible default | ||
|
||
### Restore | ||
|
||
- Download multiple contiguous blobs in one request | ||
|
||
### Rustic_core | ||
|
||
- Add NoProgress and NoProgressBars (e.g. for examples) | ||
- Prepare v0.1.1 | ||
|
||
<!-- generated by git-cliff --> |