feat(build-tools): Add conventional commits deps and helper script #12261
Conversation
This file contains 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
tylerbutler
commented
Oct 5, 2022
sonalivdeshpande
approved these changes
Oct 5, 2022
|
This commit is queued for merging with the |
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.
Conventional commits help us automate changelog generation and generally make the commit log more useful. This PR adds dependencies and configuration for commitizen and commitlint to the build-tools release group.
Commitizen provides an interactive prompt to select the type of change and walks through the process step by step.
Commitlint, on the other hand, checks the resulting commit message before it's committed. These configurations are important as groundwork for CI enforcement, too.
Finally, I added a script to the root build-tools project that invokes commitizen. Now you can OPTIONALLY use
npm run committo commit a build-tools change with a compliant commit message.IMPORTANT: this PR does not add checks in CI or any enforcement. This change is only helpful if people choose to use it. A future PR will add enforcement in CI.