Skip to content

Latest commit

 

History

History
115 lines (82 loc) · 2.29 KB

README.md

File metadata and controls

115 lines (82 loc) · 2.29 KB
Raw

Bump Action

Bump allows you to..well...bump an npm package version using a commit message, and push the package.json update back to the repository.

Create an action from this template

Click the Use this Template and provide the new repo details for your action

Options

inputs:

github_token

required
github access token

user

user name
default: the user of the current push)

email

user email
default: current user email

branch

branch to work against
default: master

unrelated

use --allow-unrelated-histories deafult: false

outputs:

version

the version being tagged and pushed.

Bump strategy

If your head (latest) commit has the keywords #patch, #minor or #major - this action will use that to perform the bump. Defaults to patch.

Usage

You can use this action by referencing any branch or git tag:

bump:
  runs-on: ubuntu-latest
  steps:
    - uses: tool3/bump@master #latest
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        user: "First Last"
        email: "user.email@gmail.com"

⚠️ Important usage notes

  • this action requires @actions/checkout to be defined in a previous step. e.g:
bump:
  runs-on: ubuntu-latest
  steps:
    - uses: actions/checkout@master
    - uses: tool3/bump@master
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        user: "First Last"
        email: "user.email@gmail.com"
  • this action pushes the package.json version update back to the repo (defaults to master).

See the actions tab for runs of this action! 🚀

Example

name: release

on:
  push:
    branches:
      - release

jobs:
  tag:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@master
      - uses: tool3/bump@master
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          unrelated: true

  publisher:
    needs: tag
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: tool3/publisher@master
        with:
          npm_token: ${{ secrets.NPM_TOKEN }}
          github_token: ${{ secrets.GITHUB_TOKEN }}
          scope: "@tool3"