diff --git a/.semantic_release/CHANGELOG.md.j2 b/.semantic_release/CHANGELOG.md.j2 index 2fe5bc0..c1f6818 100644 --- a/.semantic_release/CHANGELOG.md.j2 +++ b/.semantic_release/CHANGELOG.md.j2 @@ -22,4 +22,11 @@ {% endfor %} {% endif %} + {% if "performance improvements" in release["elements"] %} +### Performance Improvements + {% for commit in release["elements"]["performance improvements"] %} +* {% if commit.scope %}**{{ commit.scope }}**: {% endif %}{{ commit.commit.summary[commit.commit.summary.find(":")+1:].strip() }} ([`{{ commit.short_hash }}`]({{ commit.commit.hexsha | commit_hash_url }})) + {% endfor %} + {% endif %} + {% endfor %} \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 99481c6..17a132d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -96,6 +96,7 @@ We ask that you use these commit types in your commit titles: * `refactor` - When the pull request is implementing only a refactor of existing code; * `ci` - When the pull request is implementing a change to the CI infrastructure of the packge; * `chore` - When the pull request is a generic maintenance task. +* `perf` - When the pull request is a performance improvement. We also require that the type in your conventional commit title end in an exclaimation point (e.g. `feat!` or `fix!`) if the pull request should be considered to be a breaking change in some way. Please also include a "BREAKING CHANGE" footer diff --git a/pyproject.toml b/pyproject.toml index 0e2accd..59afcac 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -190,6 +190,7 @@ patch_tags = [ "feat", "fix", "refactor", + "perf", ] [tool.semantic_release.publish]