actions
/
gh-action-bump-version
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
182 Commits 2 Branches 0 Tags 2.6 MiB
JavaScript 100%
Go to file
phips28 20091815db checkout the current branch 2019-10-27 01:39:43 +02:00
.github/workflows checkout the current branch 2019-10-27 01:39:43 +02:00
.gitignore added package lock 2019-10-26 21:09:42 +02:00
Dockerfile RUN apt-get update 2019-10-26 22:12:01 +02:00
README.md README 2019-10-26 21:10:38 +02:00
action.yml name 2019-10-26 22:32:18 +02:00
index.js checkout the current branch 2019-10-27 01:39:43 +02:00
package-lock.json "ci: version bump to v5.0.5" 2019-10-26 23:35:11 +00:00
package.json "ci: version bump to v5.0.5" 2019-10-26 23:35:11 +00:00

README.md

gh-action-bump-version

GitHub Action for automated npm version bump.

This Action bumps the version in package.json and push it back to the repo. 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.
  • 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.
  • Push the bumped npm version in package.json back into the repo.
  • Push a tag for the new version back into the repo.