Skip to content

Commit 3345494

Browse files
authored
ci: add changelog section for performance improvements (#238)
Signed-off-by: Josh Usiskin <[email protected]>
1 parent 8bc8857 commit 3345494

File tree

3 files changed

+9
-0
lines changed

3 files changed

+9
-0
lines changed

.semantic_release/CHANGELOG.md.j2

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,11 @@
2222
{% endfor %}
2323
{% endif %}
2424

25+
{% if "performance improvements" in release["elements"] %}
26+
### Performance Improvements
27+
{% for commit in release["elements"]["performance improvements"] %}
28+
* {% if commit.scope %}**{{ commit.scope }}**: {% endif %}{{ commit.commit.summary[commit.commit.summary.find(":")+1:].strip() }} ([`{{ commit.short_hash }}`]({{ commit.commit.hexsha | commit_hash_url }}))
29+
{% endfor %}
30+
{% endif %}
31+
2532
{% endfor %}

CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,7 @@ We ask that you use these commit types in your commit titles:
9696
* `refactor` - When the pull request is implementing only a refactor of existing code;
9797
* `ci` - When the pull request is implementing a change to the CI infrastructure of the packge;
9898
* `chore` - When the pull request is a generic maintenance task.
99+
* `perf` - When the pull request is a performance improvement.
99100

100101
We also require that the type in your conventional commit title end in an exclaimation point (e.g. `feat!` or `fix!`)
101102
if the pull request should be considered to be a breaking change in some way. Please also include a "BREAKING CHANGE" footer

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -209,6 +209,7 @@ patch_tags = [
209209
"feat",
210210
"fix",
211211
"refactor",
212+
"perf",
212213
]
213214

214215
[tool.semantic_release.publish]

0 commit comments

Comments
 (0)