Go to file
Phil 79cd3bd5ee
Merge pull request #44 from gmaggiodev/master
Support for prerelease and --preId
2020-10-06 22:14:47 +02:00
.github/workflows revert test pr 2020-09-30 19:48:32 +02:00
.gitignore added package lock 2019-10-26 21:09:42 +02:00
Dockerfile Fix 2019-11-20 13:43:29 +01:00
README.md support for preId 2020-10-06 18:10:02 +02:00
action.yml Merge branch 'master' into customizable-wording 2020-09-08 08:46:49 +02:00
index.js use const instead of let 2020-10-06 21:50:00 +02:00
package-lock.json ci: version bump to v8.0.6 2020-10-06 13:24:22 +00:00
package.json ci: version bump to v8.0.6 2020-10-06 13:24:22 +00:00

README.md

gh-action-bump-version

GitHub Action for automated npm version bump.

This Action bumps the version in package.json and pushes 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.

Attention

Make sure you use the actions/checkout@v2 action!

Workflow

  • Based on the commit messages, increment the version from the latest release.
    • If the string "BREAKING CHANGE", "major" or the Attention pattern refactor!: drop support for Node 6 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" or includes "minor" then the minor version will be increased. This works for most common commit metadata for feature additions: "feat: new API" and "feature: new API".
    • If a commit message contains the word "pre-alpha" or "pre-beta" or "pre-rc" then the pre-release version will be increased (for example specifying pre-alpha: 1.6.0-alpha.1 -> 1.6.0-alpha.2 or, specifying pre-beta: 1.6.0-alpha.1 -> 1.6.0-beta.0)
    • 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.

Usage:

tag-prefix: Prefix that is used for the git tag (optional). Example:

- name:  'Automated Version Bump'
  uses:  'phips28/gh-action-bump-version@master'
  with:
    tag-prefix:  ''

skip-tag: The tag is not added to the git repository (optional). Example:

- name:  'Automated Version Bump'
  uses:  'phips28/gh-action-bump-version@master'
  with:
    skip-tag:  'true'

wording: Customize the messages that trigger the version bump. It must be a string, case sensitive, coma separated (optional). Example:

- name:  'Automated Version Bump'
  uses:  'phips28/gh-action-bump-version@master'
  with:
    minor-wording:  'add,Adds,new'
    major-wording:  'MAJOR,cut-major'

PACKAGEJSON_DIR: Param to parse the location of the desired package.json (optional). Example:

- name:  'Automated Version Bump'
  uses:  'phips28/gh-action-bump-version@master'
  env:
    PACKAGEJSON_DIR:  'frontend'