gh-action-bump-version

Go to file

Johan LAJILI 1742335df7 Fix not default to patch anymore Hi, I'm using the last version of this github action and it doesn't resolve to patch anymore, it says ``` Couldn't find any commits in this event, incrementing patch version... messages: [] ✔ success No version keywords found, skipping bump. ``` I believe this is because patchWords is an empty array, which then makes it enter the condition line 54, and since it's written negatively version will be set to null. I don't really understand why patchWords is an empty array, but I'm guessing `process.env['INPUT_PATCH-WORDING']` results in an empty string. (if that wasn't the case it would crash line 31 saying `cannot read property split of undefined`).		2020-11-17 17:24:16 +00:00
.github/workflows	Added output of the tag to the action	2020-11-16 16:24:15 +00:00
.gitignore	added package lock	2019-10-26 21:09:42 +02:00
Dockerfile	revert Dockerfile changes	2020-10-23 13:45:37 +02:00
README.md	Update README.md	2020-10-24 13:03:19 -04:00
action.yml	Added output of the tag to the action	2020-11-16 16:24:15 +00:00
index.js	Fix not default to patch anymore	2020-11-17 17:24:16 +00:00
package-lock.json	ci: version bump to v8.0.15	2020-11-16 19:27:31 +00:00
package.json	ci: version bump to v8.0.15	2020-11-16 19:27:31 +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'
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  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'
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  with:
    skip-tag:  'true'

default: Set a default version bump to use (optional - defaults to patch). Example:

- name:  'Automated Version Bump'
  uses:  'phips28/gh-action-bump-version@master'
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  with:
    default: prerelease

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'
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  with:
    minor-wording:  'add,Adds,new'
    major-wording:  'MAJOR,cut-major'
    patch-wording:  'patch,fixes'     # Providing patch-wording will override commits
                                      # defaulting to a patch bump.
    rc-wording:     'RELEASE,alpha'

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:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
    PACKAGEJSON_DIR:  'frontend'