Skip to content

Conversation

@jusiskin
Copy link
Contributor

What was the problem/requirement? (What/Why)

There is no development/release workflow for communicating performance improvements.

What was the solution? (How)

Conventional commits standardizes the perf: ... commit type for this purpose.

This followed a previous work in aws-deadline/deadline-cloud#870:

  1. adds a section to the changelog template for performance improvements
  2. adds perf commits to the patch_tags setting of python-semantic-release so that they are considered as part of bumping a version for release
  3. adds developer-facing documentation for using the perf: commit type for performance improvements

What is the impact of this change?

Developers can use perf: ... conventional commits to communicate performance improvements. The release process will automatically produce a changelog section for performance improvements where they will be listed.

How was this change tested?

  1. Set my local mainline branch to this commit
  2. Added example commits using the perf: ... commit summary message
  3. Ran:
    hatch run release:deps
    hatch run release:bump
    
  4. confirmed that rendered CHANGELOG.md contained the expected "Performance Improvements" section correctly

0.7.3 (2025-10-24)

Performance Improvements

  • a performance improvement (03dfa78)

Was this change documented?

Yes. I added documentation for the perf: commit type to CONTRIBUTING.md.

Is this a breaking change?

No

Does this change impact security?

No


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@jusiskin jusiskin requested a review from a team as a code owner October 24, 2025 14:50
@sonarqubecloud
Copy link

@jusiskin jusiskin merged commit 3be2661 into OpenJobDescription:mainline Oct 24, 2025
20 checks passed
@jusiskin jusiskin deleted the add_perf_improvement_changelog branch October 24, 2025 15:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants