actions
/
gh-action-bump-version
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

readme

This commit is contained in:
phips28 2020-02-13 20:37:10 +01:00
parent 7ab154a5b8
commit c3fab77120
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -12,7 +12,7 @@ you'll need to configured that workflow yourself. You can look to the
* Based on the commit messages, increment the version from the lastest release. * Based on the commit messages, increment the version from the lastest release.
* If the string "BREAKING CHANGE" or "major" is found anywhere in any of the commit messages or descriptions the major * If the string "BREAKING CHANGE" or "major" is found anywhere in any of the commit messages or descriptions the major
version will be incremented. version will be incremented.
* If a commit message begins with the string "feat" or "minor" then the minor version will be increased. This works * If a commit message begins with the string "feat" or includes "minor" then the minor version will be increased. This works
for most common commit metadata for feature additions: `"feat: new API"` and `"feature: new API"`. for most common commit metadata for feature additions: `"feat: new API"` and `"feature: new API"`.
* All other changes will increment the patch version. * All other changes will increment the patch version.
* Push the bumped npm version in package.json back into the repo. * Push the bumped npm version in package.json back into the repo.