chore: add CHANGELOG.md and git-cliff config (#31)
Reviewed-on: #31 Co-authored-by: Felipe Contreras Salinas <felipe@bstr.cl> Co-committed-by: Felipe Contreras Salinas <felipe@bstr.cl>
This commit is contained in:
parent
4685e0a6c6
commit
23f3307599
2 changed files with 105 additions and 0 deletions
28
CHANGELOG.md
Normal file
28
CHANGELOG.md
Normal file
|
|
@ -0,0 +1,28 @@
|
|||
# Changelog
|
||||
|
||||
## [unreleased]
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- Docker build ([#24](https://oolong.ludwig.dog/pitbuster/huellas/issues/24))
|
||||
|
||||
### Miscellaneous Tasks
|
||||
|
||||
- Add docker-compose.yml file for testing ([#25](https://oolong.ludwig.dog/pitbuster/huellas/issues/25))
|
||||
- Update sqlx offline files ([#28](https://oolong.ludwig.dog/pitbuster/huellas/issues/28))
|
||||
- Update rust version in docker to 1.71 ([#29](https://oolong.ludwig.dog/pitbuster/huellas/issues/29))
|
||||
|
||||
## [0.2.1] - 2023-05-23
|
||||
|
||||
### Miscellaneous Tasks
|
||||
|
||||
- Add tests ([#19](https://oolong.ludwig.dog/pitbuster/huellas/issues/19))
|
||||
- Update sqlx to 0.7.0-alpha3 ([#21](https://oolong.ludwig.dog/pitbuster/huellas/issues/21))
|
||||
- Axum -> 0.6.18, tracing-subscriber -> 0.3.17, tokio -> 1.28.1, serde ->1.0.163,serde_json -> 1.0.96 ([#22](https://oolong.ludwig.dog/pitbuster/huellas/issues/22))
|
||||
|
||||
## [0.1.1] - 2022-11-23
|
||||
|
||||
### Features
|
||||
|
||||
- Add and Edit places through Leaflet.contextmenu ([#4](https://oolong.ludwig.dog/pitbuster/huellas/issues/4))
|
||||
|
||||
77
cliff.toml
Normal file
77
cliff.toml
Normal file
|
|
@ -0,0 +1,77 @@
|
|||
[changelog]
|
||||
# changelog header
|
||||
header = """
|
||||
# Changelog\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 = """
|
||||
"""
|
||||
# postprocessors
|
||||
postprocessors = [
|
||||
{ pattern = '<REPO>', replace = "https://oolong.ludwig.dog/pitbuster/huellas" },
|
||||
]
|
||||
[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" },
|
||||
{ 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" },
|
||||
]
|
||||
# extract external references
|
||||
link_parsers = [
|
||||
{ pattern = "#(\\d+)", href = "https://oolong.ludwig.dog/pitbuster/huellas/issues/$1" },
|
||||
]
|
||||
# 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 = "[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
|
||||
Loading…
Add table
Reference in a new issue