1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253 |
- # configuration file for git-cliff (0.1.0)
- [changelog]
- # changelog header
- header = """
- # Changelog
- All notable changes to this project will be documented in this file.\n
- """
- # template for the changelog body
- # https://tera.netlify.app/docs/#introduction
- 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 %}
- - {{ commit.message | upper_first }}\
- {% endfor %}
- {% endfor %}\n
- """
- # remove the leading and trailing whitespaces from the template
- trim = true
- # changelog footer
- footer = """
- <!-- generated by git-cliff -->
- """
- [git]
- # allow only conventional commits
- # https://www.conventionalcommits.org
- conventional_commits = true
- # 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", group = "Miscellaneous Tasks"},
- { body = ".*security", group = "Security"},
- ]
- # 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"
|