actions
/
gh-action-bump-version
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
67 Commits 2 Branches 0 Tags 2.6 MiB
JavaScript 100%
Go to file
Mikeal Rogers c390f6d1d4
Update package.json 		2019-07-15 16:09:53 -07:00
.github feat: use npx for automdated dep install 2019-05-23 18:55:00 +00:00
.gitignore feat: add git sha to package json 2019-05-23 18:13:42 +00:00
Dockerfile fix: adding git to docker image 2019-05-23 19:12:30 +00:00
LICENSE init: template from npm action 2019-01-26 21:51:06 +00:00
README.md doc: flow description in readme 2019-06-04 12:38:29 -07:00
entrypoint.sh fix: don't run merge release in slash 2019-05-23 19:08:29 +00:00
merge-release-run.js feat: get full diff between releases 2019-05-23 18:43:01 +00:00
package.json Update package.json 2019-07-15 16:09:53 -07:00

README.md

merge-release

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.