# configuration file for git-cliff

# see https://github.com/orhun/git-cliff#configuration-file

[changelog]

# changelog header

header = """

# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),

and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

This changelog is automatically generated by [git-cliff](https://github.com/orhun/git-cliff),

which is configured [here](./cliff.toml).

Please do not manually edit this file.\n

"""

# template for the changelog body

# https://tera.netlify.app/docs/#introduction

body = """

{% if version %}\

## [{{ version | trim_start_matches(pat="ethers-") | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}

{% else %}\

## [Unreleased]

{% endif %}\

{% for group, commits in commits | group_by(attribute="group") %}

### {{ group | title }}

{% for commit in commits %}

- {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first | split(pat="\\n") | first }}\

{% endfor %}

{% endfor %}\n

"""

# remove the leading and trailing whitespace from the template

trim = true

# changelog footer

footer = """

<!-- generated by git-cliff -->

"""

[git]

# parse the commits based on https://www.conventionalcommits.org

conventional_commits = true

# filter out the commits that are not conventional

filter_unconventional = false

# process each line of a commit as an individual commit

split_commits = false

# regex for preprocessing the commit messages

commit_preprocessors = [

# replace issue numbers

{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/gakonst/ethers-rs/issues/${2}))" },

]

# regex for parsing and grouping commits

commit_parsers = [

{ message = "^feat", group = "Features" },

{ message = "^fix", group = "Bug Fixes" },

{ message = "^doc", group = "Documentation" },

{ message = "(.*deps)|(.*dependencies)|(.*[Bb]ump)", group = "Depedencies" },

{ message = "^perf", group = "Performance" },

{ message = "^refactor", group = "Refactor" },

{ message = "(^style)|(.*fmt)", group = "Styling" },

{ message = "^test", group = "Testing" },

{ message = ".*release", skip = true },

{ message = "^revert", skip = true },

{ message = "^chore", group = "Miscellaneous Tasks" },

{ message = ".*", group = "Other" },

]

# protect breaking changes from being skipped due to matching a skipping commit_parser

protect_breaking_commits = true

# filter out the commits that are not matched by commit parsers

filter_commits = false

# regex for matching git tags

tag_pattern = ".*"

# regex for skipping tagged commits entirely

# skip_tags = "v0.1.0-beta.1"

# regex for ignoring tags, but including the commits into the next one

ignore_tags = "^ethers-.*-.*"

# sort the tags topologically

topo_order = false

# sort the commits inside sections by oldest/newest order

sort_commits = "newest"

# limit the number of commits included in the changelog.

# limit_commits = 42