📦🚀 + 📓 A continuous integration build tool to ensure all new commits meet your commit message format!
- 📦🚀 semantic-release depends on properly formatted commit messages
- 📓 commitlint is awesome, but it doesn't know which commits occurred since your last release
- semantic-commitlint fills the gap by
providing a hook for
semantic-releasethat askscommitlintto lint new commit messages that have not been included in a previous release
- Run in CI on all branches to ensure that only builds with valid commit messages pass
- Wraps
semantic-releaseandcommitlintfor an easy install - No config
npm install semantic-commitlint --save-devAdd the following to your semantic-release release block (e.g. in the release field of your
package.json)
{
"verifyRelease": ["semantic-commitlint"]
}Setup semantic-release authentication for CI
semantic-commitlint currently only supports @commitlint/config-conventional - please open a PR
if you need support for other configurations!
Simply run semantic-release as normal as part of your CI build process
If there are unreleased commits that shouldn't fail a build, then add them to the
SEMANTIC_COMMITLINT_SKIP environment variable as comma-separated GIT SHAs. This should be
uncommon, provided your development workflow lints the commits before they get added to the release
branch.
// This is the package.json of the package you're trying to publish.
// Just add the SEMANTIC_COMMITLINT_SKIP prefix to the semantic-release command!
{
"scripts": {
"semantic-release": "SEMANTIC_COMMITLINT_SKIP=a1be371 semantic-release"
}
}This project just ties together some functionality from two external projects. For all other config options make sure to read through the docs.
Not all features implemented in semantic-release and commitlint are currently available when
using semantic-commtlint. If you have a suggestion, please
open an issue. Thanks!
semantic-commitlint is licensed under the MIT Open Source license. For more information, see the LICENSE file in this repository.