# Default CEMS cliff changelog generation configuration # # Remove this file to generate a new one with the defaults when releasing # # To manually run this just install git-cliff and run it in the root of the repo [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://keats.github.io/tera/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 %} - {% if commit.scope %}*({{ commit.scope }})* {% endif %}{% 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 = """ """ [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 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\\)", skip = true }, { message = "^chore: (release|bump) version", 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" }, ] # Glob pattern for matching git tags tag_pattern = "[0-9]*"