actions
/
gh-action-bump-version
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #22 from dfantonio/improved_documentation 

Custom package.json dir documented
This commit is contained in:
Phil 2020-05-06 01:36:03 +02:00 committed by GitHub
parent e4fe6b5454 9485b19ed5
commit 28d81a6aa8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 21 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -13,7 +13,7 @@ Make sure you use the `actions/checkout@v2` action!
### Workflow
* Based on the commit messages, increment the version from the lastest release.
* Based on the commit messages, increment the version from the latest release.
* If the string "BREAKING CHANGE" or "major" 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
@ -21,3 +21,19 @@ Make sure you use the `actions/checkout@v2` action!
* 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:
```yaml
- name: 'Automated Version Bump'
uses: 'phips28/gh-action-bump-version@master'
with:
tag-prefix: ''
```
**PACKAGEJSON_DIR:** Param to parse the location of the desired package.json (optional). Example:
```yaml
- name: 'Automated Version Bump'
uses: 'phips28/gh-action-bump-version@master'
env:
PACKAGEJSON_DIR: 'frontend'
```

4
action.yml
View File

@ -11,3 +11,7 @@ inputs:
description: 'Prefix that is used for the git tag'
default: ''
required: false
PACKAGEJSON_DIR:
description: 'Custom dir to the package'
default: ''
required: false