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

document

This commit is contained in:
Kevin Mahoney 2021-07-13 15:43:33 -06:00
parent c9f74f6081
commit 14d1980003
2 changed files with 17 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -2,8 +2,8 @@
GitHub Action for automated npm version bump. GitHub Action for automated npm version bump.
This Action bumps the version in package.json and pushes it back to the repo. 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 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 you'll need to configured that workflow yourself. You can look to the
[`.github/workflows/push.yml`](./.github/workflows/push.yml) file in this project as an example. [`.github/workflows/push.yml`](./.github/workflows/push.yml) file in this project as an example.
@ -14,7 +14,7 @@ Make sure you use the `actions/checkout@v2` action!
### Workflow ### Workflow
* Based on the commit messages, increment the version from the latest release. * 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 * 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. 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 * 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"`. for most common commit metadata for feature additions: `"feat: new API"` and `"feature: new API"`.
@ -107,3 +107,13 @@ Make sure you use the `actions/checkout@v2` action!
with: with:
commit-message: 'CI: bumps version to {{version}} [skip ci]' commit-message: 'CI: bumps version to {{version}} [skip ci]'
``` ```
**push:** Set false you want to avoid pushing the new version tag/package.json. Example:
```yaml
- name: 'Automated Version Bump'
uses: 'phips28/gh-action-bump-version@master'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
push: false
```

6
index.js
View File

@ -105,8 +105,10 @@ Toolkit.run(async (tools) => {
return; return;
} }
// case: if user sets push == false // case: if user sets push to false, to skip pushing new tag/package.json
if ( process.env['INPUT_PUSH'] === "false" ) { const push = process.env['INPUT_PUSH']
if ( push === "false" || push === false ) {
tools.exit.success('User requested to skip pushing new tag and package.json. Finished.');
return; return;
} }