Skip to content
chevrons-up

GitHub Action

Bump Gem

v1.1.3 Latest version

Bump Gem

chevrons-up

Bump Gem

The GitHub action to bump the gem or engine version

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Bump Gem

uses: Thejus-Paul/bump-gem-action@v1.1.3

Learn more about this action in Thejus-Paul/bump-gem-action

Choose a version

bump-gem-action

DeepScan grade

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.

- 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

Example usage

- 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

    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.

    pnpm run build
  4. Commit the changes and push to the branch.

    git add .
    git commit -m "Commit message"
    git tag -s -a v1.0.0 -m "v1.0.0"
    git push --follow-tags