Go to file
Fadee kannah 5213521185 feat: Add tag to github repo for the commit used for the npm release 2019-09-05 21:54:08 -07:00
.github/workflows converted main.workflow to Actions V2 yml files 2019-08-14 19:19:25 +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: s/flow/workflow 2019-07-16 17:12:34 -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: Add tag to github repo for the commit used for the npm release 2019-09-05 21:54:08 -07: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.

Workflow

  • 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.