ci: add changelog section for performance improvements#279
Merged
jusiskin merged 1 commit intoOpenJobDescription:mainlinefrom Oct 24, 2025
Merged
Conversation
Signed-off-by: Josh Usiskin <56369778+jusiskin@users.noreply.github.com>
|
miabatta
approved these changes
Oct 24, 2025
moorec-aws
approved these changes
Oct 24, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.



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:
perfcommits to thepatch_tagssetting ofpython-semantic-releaseso that they are considered as part of bumping a version for releaseperf:commit type for performance improvementsWhat 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?
mainlinebranch to this commitperf: ...commit summary messageCHANGELOG.mdcontained the expected "Performance Improvements" section correctlyWas this change documented?
Yes. I added documentation for the
perf:commit type toCONTRIBUTING.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.