Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tomerfi/version-bumper-action
Github action for automating semantic version bumps based on conventional commits
https://github.com/tomerfi/version-bumper-action
actions automation conventional-changelog conventional-commits semver
Last synced: 26 days ago
JSON representation
Github action for automating semantic version bumps based on conventional commits
- Host: GitHub
- URL: https://github.com/tomerfi/version-bumper-action
- Owner: TomerFi
- License: isc
- Created: 2021-09-13T20:13:49.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-08-09T16:14:02.000Z (3 months ago)
- Last Synced: 2024-10-09T00:49:56.676Z (about 1 month ago)
- Topics: actions, automation, conventional-changelog, conventional-commits, semver
- Homepage: https://github.com/marketplace/actions/version-bumper-action
- Size: 479 KB
- Stars: 4
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
Version Bumper Action
:package::rocket: Spice up your release workflows with automated version bumps! :rocket::package:
## About
The _Version Bumper Action_ uses the [version bumper tool][version-bumper] to figure out the next
[semantic version][semver] bump based on [conventional commits][conventional-commits], or plain instructions.
Upgrading from version 1 to 2? Click here.
Successful upgrades examples:
alexa-skills-tester,
github-viewer-stats,
auto-me-bot,
tomfi-archetypes,
shabbat-api,
Version 3 introduced breaking changes
- The action was rebuilt using Node.js.
-
Changes in the action flags:
-
changelog was removed. -
preset was removed. -
folder was changed to path. It's worth mentioning the folder/path requires a
full path and not a folder relative to the workspace. (folder will eventually be removed). -
bumpoverride was changed to bump (bumpoverride will eventually be removed).
-
## Usage example
```yaml
- uses: actions/checkout@v2
with:
# fetch-depth 0 will check out all the commits and tags needed for the bumper
fetch-depth: 0
- id: bumper
uses: tomerfi/[email protected]
# assuming previous tag was 1.2.4 and feat-type commits were made, this will print 1.3.0.
- run: echo ${{ steps.bumper.outputs.next }}
```
### Inputs
| Key | Description | Default value |
|-----------|-----------------------------------------------------------------------------------------------|---------------------------|
| `source` | Source for the bump, any semver string or 'git' to fetch from tags | `git` |
| `bump` | Target bump, 'major', 'minor', 'patch', 'auto'. An 'auto' bump only works with a 'git' source | `auto` |
| `label` | Development iteration build label | `-dev` |
| `path` | When source is 'git', set repository path | `${{ github.workspace }}` |
### Outputs
| Key | Description | Example |
|------------------|-----------------------------------------------------------------------------|-------------|
| `current` | The original version | `1.2.3` |
| `bump` | The bump performed | `patch` |
| `next` | The next version | `1.2.4` |
| `dev` | The next development iteration version | `1.2.5-dev` |
| `major_part` | The major part of the next version | `1` |
| `minor_part` | The minor part of the next version | `2` |
| `patch_part` | The patch part of the next version | `4` |
| `dev_patch_part` | The patch part of the development iteration | `5-dev` |
| `bump_object` | The original object returned from the [version bumper tool][version-bumper] | |
## Contributors [![all-contributors-badge]][all-contributors]
Jasper Vaneessen
💻 📖
Lucas Schmutzler
💻
mrdoodles
💻 📖
[semver]: https://semver.org/
[conventional-commits]: https://conventionalcommits.org
[all-contributors]: https://allcontributors.org/
[version-bumper]: https://github.com/TomerFi/version-bumper
[all-contributors-badge]: https://img.shields.io/github/all-contributors/tomerfi/version-bumper-action?style=plastic&label=%20&color=b7b1e3