This project uses Semantic-release
Github: https://github.com/semantic-release/semantic-release/
Semantic commit messages that will update the project version:
We follow ESlint version conventions. They base their release numbers on git commit tags (tags are the first word in the commit message followed by a colon, eg: Fix: bug in main menu
). These tags are: Breaking:
, Update:
, New:
, and Fix:
, and they should always be followed by a commit message.
IMPORTANT: Capitalization is really important. Notice that it is not breaking:
or BREAKING:
, it MUST be Breaking:
.
Here is an example of the release type that will be done based on a commit message:
Commit message | Release type |
---|---|
Breaking: change sass for less css preprocessor |
Major Release - a version that will break something in the user application after updating the package |
Update: improvements in uglify performance |
Minor Release - a version that changes things in the package without the need from the user to modify the code base |
New: JSDocs added for documentation |
Minor Release - a version that adds new components that wont damage the existing ones |
Fix: CI runs build correctly |
Patch Release - a version that wont break anything or add any new feature after updating, just fixes a bug |
More information about semantic releases: https://semver.org/