Skip to content

ci: add changelog section for performance improvements #193

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jusiskin merged 1 commit into from
Oct 24, 2025
Merged

ci: add changelog section for performance improvements #193

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .semantic_release/CHANGELOG.md.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}
1 change: 1 addition & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,7 @@ patch_tags = [
"feat",
"fix",
"refactor",
"perf",
]

[tool.semantic_release.publish]
Expand Down