diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8e36c61fb..f947f2bb0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -290,6 +290,8 @@ Must be one of the following: * **feat**: A new feature * **fix**: A bug fix * **docs**: Documentation only changes +* **update**: A dependency update (when a core dependency, especially + `tonic`, gets a breaking update) * **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) * **refactor**: A code change that neither fixes a bug or adds a feature diff --git a/cliff.toml b/cliff.toml index 2b0b9d38d..d460b99a0 100644 --- a/cliff.toml +++ b/cliff.toml @@ -67,6 +67,7 @@ split_commits = false # regex for preprocessing the commit messages commit_preprocessors = [ { pattern = '^(feat|fix|doc|perf)\((api|subscriber|console)\) ', replace = '${1}(${2}): '}, # fix missing colon after commit type + { pattern = '^chore: bump tonic', replace = 'update: bump tonic' }, # Upgrading tonic is a breaking change and hence, not a chore { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/tokio-rs/console/issues/${2}))"}, # replace issue numbers ] # regex for parsing and grouping commits @@ -75,6 +76,7 @@ commit_parsers = [ { message = "^fix", group = "Fixed" }, { message = "^doc", group = "Documented" }, { message = "^perf", group = "Performance" }, + { message = "^update", group = "Updated" }, { message = "^refactor", skip = true }, { message = "^refac", skip = true }, { message = "^style", skip = true },