feat: Deprecate and remove scm commit title configuration #7570
Conversation
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
2 participants
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.
Fix #1699
Remove the
titlefield from SCM commit message configuration. Commit titles now always use the target name (or description as fallback), removing the ability to override the commit title.Breaking Change: Configurations using
commitMessage.titlewill need to remove that field. Ensure targets have meaningfulnamefields (which should already be the case).Test
To test this pull request, you can run the following commands:
Tradeoff
Removing the title configuration field reduces flexibility but simplifies the API and enforces consistency. Users who relied on custom commit titles will need to ensure their target names are descriptive enough for commit messages.
Potential improvement
Consider adding validation to ensure target names are always set and meaningful, since they now directly impact commit messages.