ci: enable commitlint for PRs #56
Merged
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
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.
Description of changes:
This lints incoming commits in PRs to conform to conventional commits. The commit style already follows conventional commits, but this will codify it as required to merge changes.
Conventional commits make it easier to automate the process of generating changelogs and cutting releases. Ideally this change will enable us to use a release automation tool like release-plz to publish SDK crates.
Limitations
This doesn't yet enforce conventional style on PR titles. This would be a useful place to add conventional commit-style messages to be included in a changelog if multiple underlying commits are used to contribute something that should only have one notable changelog entry.
Testing:
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.