Go to file
Bump Version ae80802e03 ci: version bump v1.0.4 2019-10-26 18:31:57 +00:00
.github/workflows fix git checkout 2019-10-26 20:11:31 +02:00
.gitignore feat: add git sha to package json 2019-05-23 18:13:42 +00:00
Dockerfile do not push to npm 2019-10-26 19:35:58 +02:00
LICENSE init: template from npm action 2019-01-26 21:51:06 +00:00
README.md do not push to npm 2019-10-26 19:35:58 +02:00
entrypoint.sh do not push to npm 2019-10-26 19:35:58 +02:00
gh-action-bump-version-run.js fix git push 2019-10-26 20:30:39 +02:00
package.json ci: version bump v1.0.4 2019-10-26 18:31:57 +00:00
yarn.lock fix git checkout 2019-10-26 20:11:31 +02:00

README.md

gh-action-bump-version

GitHub Action for automated npm version bump.

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/workflows/push.yml 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.
  • Push the bumped npm version in package.json back into the repo.
  • Push a tag for the new version to GitHub.