https://github.com/thejus-paul/bump-gem-action
The GitHub action to bump the gem or engine version.
https://github.com/thejus-paul/bump-gem-action
action bump engine gem version
Last synced: 3 months ago
JSON representation
The GitHub action to bump the gem or engine version.
- Host: GitHub
- URL: https://github.com/thejus-paul/bump-gem-action
- Owner: Thejus-Paul
- License: mit
- Created: 2023-02-23T17:57:44.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-13T03:07:25.000Z (about 1 year ago)
- Last Synced: 2026-02-11T08:34:57.422Z (4 months ago)
- Topics: action, bump, engine, gem, version
- Language: JavaScript
- Homepage: https://github.com/marketplace/actions/bump-gem
- Size: 407 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# bump-gem-action
[](https://deepscan.io/dashboard#view=project&tid=20541&pid=23984&bid=733494)
The GitHub action to bump the gem or engine version from the pull request labels.
## Inputs
### `labels`
**Required** The labels of the pull request separated by comma.
### `token`
**Required** The GitHub token to authenticate with GitHub API.
### `new_branch`
**Optional** The branch to push the changes to. Default `"bump-gem-version"`.
### `base_branch`
**Optional** The base branch to create the pull request from. Default `"main"`.
### `commit_message`
**Optional** The commit message to use. Default `"Updated gem version"`.
### `pr_title`
**Optional** The pull request title to use. Default `"Updated gem version"`.
### `pr_body`
**Optional** The pull request body to use. Default `"New version release"`.
### `default_bump_label`
**Optional** Provide a default bump label for cases when labels does not include a bump type label.
```yaml
- name: Bump gem version
uses: Thejus-Paul/bump-gem-action@main
with:
labels: ${{ join(github.event.pull_request.labels.*.name, ',') }}
token: ${{ secrets.GITHUB_TOKEN }}
default_bump_label: patch
```
### `bump_version_pr_labels`
**Optional** Provide a comma separated list of labels passed to the bump version PR.
```yaml
- name: Bump gem version
uses: Thejus-Paul/bump-gem-action@main
with:
labels: ${{ join(github.event.pull_request.labels.*.name, ',') }}
token: ${{ secrets.GITHUB_TOKEN }}
default_bump_label: patch
bump_version_pr_labels: mergepr
```
## Example usage
```yaml
- name: Bump gem version
uses: Thejus-Paul/bump-gem-action@main
with:
labels: ${{ join(github.event.pull_request.labels.*.name, ',') }}
token: ${{ secrets.GITHUB_TOKEN }}
```
## Local development
1. Install the dependencies.
```bash
pnpm install
```
2. Make the necessary changes to `action.yml` and/or `index.js`.
3. Compile the `index.js` with the dependencies into a single file.
```bash
pnpm run build
```
4. Commit the changes and push to the branch.
```bash
git add .
git commit -m "Commit message"
git tag -s -a v1.0.0 -m "v1.0.0"
git push --follow-tags
```