ci: add action to enforce conventional commit messages #281
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
adhering to the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) format is vital to make our automatic release process with [release please](https://www.npmjs.com/package/release-please/v/11.14.2) work. - Automatically generating CHANGELOGs. - Automatically determining a semantic version bump (based on the types of commits landed). - Communicating the nature of changes to teammates, the public, and other stakeholders. - Triggering build and publish processes. - Making it easier for people to contribute to our projects, by allowing them to explore a more structured commit history. I will make this action a mandatory one. To follow the conventional commit format you only have to begin your commit message with: ```md <type>[optional scope]: <description> [optional body] [optional footer(s)] ``` where `<type>` is one of: ```js [ "feat", "fix", "docs", "style", "refactor", "test", "build", "perf", "ci", "chore", "revert", "merge", "wip", ] ``` 1. fix: a commit of the type fix patches a bug in your codebase (this correlates with PATCH in Semantic Versioning). 2. feat: a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning). 3. BREAKING CHANGE: a commit that has a footer BREAKING CHANGE:, or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type. It is also possible to have multiple fixes and features in one commit message. Please consult the [conventional commits doc](https://www.conventionalcommits.org/en/v1.0.0/)
patricebender
requested review from
danjoa,
johannes-vogel and
stewsk
as code owners
patricebender
changed the title
patricebender
commented
Oct 13, 2023
patricebender
force-pushed
the
conventional-commits
branch
from
fb928ec to
61c79d0
Compare
patricebender
added a commit
that referenced
this pull request
Oct 20, 2023
Add all types which are acceptable for our commits according to #281
johannes-vogel
approved these changes
Oct 26, 2023
johannes-vogel
pushed a commit
that referenced
this pull request
Oct 31, 2023
adhering to the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) format is vital to make our automatic release process with [release please](https://www.npmjs.com/package/release-please/v/11.14.2) work. - Automatically generating CHANGELOGs. - Automatically determining a semantic version bump (based on the types of commits landed). - Communicating the nature of changes to teammates, the public, and other stakeholders. - Triggering build and publish processes. - Making it easier for people to contribute to our projects, by allowing them to explore a more structured commit history. I will make this action a mandatory one. To follow the conventional commit format you only have to begin your commit message with: ```md <type>[optional scope]: <description> [optional body] [optional footer(s)] ``` where `<type>` is one of: ```js [ "feat", "fix", "docs", "style", "refactor", "test", "build", "perf", "ci", "chore", "revert", "merge", "wip", ] ``` 1. fix: a commit of the type fix patches a bug in your codebase (this correlates with PATCH in Semantic Versioning). 2. feat: a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning). 3. BREAKING CHANGE: a commit that has a footer BREAKING CHANGE:, or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type. It is also possible to have multiple fixes and features in one commit message. Please consult the [conventional commits doc](https://www.conventionalcommits.org/en/v1.0.0/)
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.
adding new workflow: https://github.com/marketplace/actions/semantic-pull-request
adhering to the conventional commits format is vital to make our automatic release process with release please work.
Why Use Conventional Commits
I will make this action a mandatory one. To follow the conventional commit format you only have to begin your commit message with:
where
<type>is one of:It is also possible to have multiple fixes and features in one commit message. Please consult the conventional commits doc