Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/haya14busa/action-bumpr
💥 Bump semantic version tag on merging Pull Requests with specific lables.
https://github.com/haya14busa/action-bumpr
github-actions
Last synced: about 2 months ago
JSON representation
💥 Bump semantic version tag on merging Pull Requests with specific lables.
- Host: GitHub
- URL: https://github.com/haya14busa/action-bumpr
- Owner: haya14busa
- License: mit
- Created: 2020-01-19T16:10:56.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-12-08T12:53:34.000Z (10 months ago)
- Last Synced: 2024-07-10T09:54:44.707Z (3 months ago)
- Topics: github-actions
- Language: Shell
- Homepage: https://github.com/marketplace/actions/bumpr-bump-version-when-merging-pull-request-with-specific-labels
- Size: 61.5 KB
- Stars: 79
- Watchers: 6
- Forks: 24
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# action-bumpr
**action-bumpr** bumps semantic version tag on merging Pull Requests with
specific labels (`bump:major`,`bump:minor`,`bump:patch`).
[](https://github.com/haya14busa/action-bumpr/actions?query=workflow%3ATest)
[](https://github.com/haya14busa/action-bumpr/actions?query=workflow%3Areviewdog)
[](https://github.com/haya14busa/action-bumpr/actions?query=workflow%3Arelease)
[](https://github.com/haya14busa/action-bumpr/releases)
[](https://github.com/haya14busa/action-bumpr)
[](https://github.com/haya14busa/action-bumpr/pull/18)
## Input
```yaml
inputs:
default_bump_level:
description: "Default bump level if labels are not attached [major,minor,patch]. Do nothing if it's empty"
required: false
dry_run:
description: "Do not actually tag next version if it's true"
required: false
github_token:
description: 'GITHUB_TOKEN to list pull requests and create tags'
default: '${{ github.token }}'
required: true
tag_as_user:
description: "Name to use when creating tags"
required: false
tag_as_email:
description: "Email address to use when creating tags"
required: false
outputs:
current_version:
description: "current version"
next_version:
description: "next version"
skip:
description: "True if release is skipped. e.g. No labels attached to PR."
message:
description: "Tag message"
```
## Usage
### Simple
```yaml
name: release
on:
push:
branches:
- master
pull_request:
types:
- labeled
jobs:
release:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
# Bump version on merging Pull Requests with specific labels.
# (bump:major,bump:minor,bump:patch)
- uses: haya14busa/action-bumpr@v1
```
### Integrate with other release related actions.
Integrate with
[haya14busa/action-update-semver](https://github.com/haya14busa/action-update-semver)
to update major and minor tags on semantic version tag release (e.g. update v1
and v1.2 tag on v1.2.3 release).
```yaml
name: release
on:
push:
branches:
- master
tags:
- 'v*.*.*'
pull_request:
types:
- labeled
jobs:
release:
if: github.event.action != 'labeled'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
# Bump version on merging Pull Requests with specific labels.
# (bump:major,bump:minor,bump:patch)
- id: bumpr
if: "!startsWith(github.ref, 'refs/tags/')"
uses: haya14busa/action-bumpr@v1
# Update corresponding major and minor tag.
# e.g. Update v1 and v1.2 when releasing v1.2.3
- uses: haya14busa/action-update-semver@v1
if: "!steps.bumpr.outputs.skip"
with:
github_token: ${{ secrets.github_token }}
tag: ${{ steps.bumpr.outputs.next_version }}
release-check:
if: github.event.action == 'labeled'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Post bumpr status comment
uses: haya14busa/action-bumpr@v1
```
### Badge
```md
[](https://github.com/haya14busa/action-bumpr)
```
### Note
action-bumpr uses push on master event to run workflow instead of pull_request
closed (merged) event because github token doesn't have write permission
for pull_request from fork repository.