2019-10-26 17:35:58 +00:00
|
|
|
## gh-action-bump-version
|
2019-01-26 23:08:05 +00:00
|
|
|
|
2019-10-26 17:35:58 +00:00
|
|
|
GitHub Action for automated npm version bump.
|
2019-06-04 19:38:29 +00:00
|
|
|
|
2019-10-26 19:09:42 +00:00
|
|
|
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
|
2019-09-06 18:26:57 +00:00
|
|
|
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.
|
2019-06-04 19:38:29 +00:00
|
|
|
|
2020-04-03 11:08:03 +00:00
|
|
|
Make sure you use the `actions/checkout@v2` action!
|
|
|
|
|
|
2019-07-17 00:12:34 +00:00
|
|
|
### Workflow
|
2019-06-04 19:38:29 +00:00
|
|
|
|
|
|
|
|
* Based on the commit messages, increment the version from the lastest release.
|
2020-02-13 19:36:18 +00:00
|
|
|
* If the string "BREAKING CHANGE" or "major" is found anywhere in any of the commit messages or descriptions the major
|
2019-06-04 19:38:29 +00:00
|
|
|
version will be incremented.
|
2020-02-13 19:37:10 +00:00
|
|
|
* If a commit message begins with the string "feat" or includes "minor" then the minor version will be increased. This works
|
2019-06-04 19:38:29 +00:00
|
|
|
for most common commit metadata for feature additions: `"feat: new API"` and `"feature: new API"`.
|
|
|
|
|
* All other changes will increment the patch version.
|
2019-09-09 19:10:07 +00:00
|
|
|
* Push the bumped npm version in package.json back into the repo.
|
2019-10-26 19:10:38 +00:00
|
|
|
* Push a tag for the new version back into the repo.
|
