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

doc: flow description in readme

This commit is contained in:
Mikeal Rogers 2019-06-04 12:38:29 -07:00 committed by GitHub
parent 640f58fd6e
commit 8567f9aa84
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -1,3 +1,21 @@
## merge-release ## merge-release
GitHub Action for automated npm publishing. GitHub Action for automated npm publishing.
This Action publishes a package to npm. It is meant to be used on every successful merge to master but
you'll need to configured that workflow yourself. You can look to the `.github/main.workflow` file in this
project as an example.
### Flow
* Check for the latest version number published to npm.
* Lookup all commits between the git commit that triggered the action and the latest publish.
* If the package hasn't been published or the prior publish does not include a git hash, we'll
only pull the commit data that triggered the action.
* Based on the commit messages, increment the version from the lastest release.
* If the string "BREAKING CHANGE" is found anywhere in any of the commit messages or descriptions the major
version will be incremented.
* If a commit message begins with the string "feat" then the minor version will be increased. This works
for most common commit metadata for feature additions: `"feat: new API"` and `"feature: new API"`.
* All other changes will increment the patch version.
* Publish to npm using the configured token.