yoichiro_gh-action-increment-value's Introduction

Increment a value GitHub Actions

This GitHub Actions increments a value written in a file specified by condition automatically.

How to Use

If you have the build-number.json file below in the foobar/baz directory:

{"buildNumber":3}

The example of the increment.yaml YAML file in the .github/workflows directory is the following:

name: Increment value test
on:
  push:
    branches:
      - main
    paths-ignore:
      - 'foobar/baz/build_number.json'
jobs:
  test:
    name: Increment value test
    runs-on: ubuntu-latest
    steps:
      - name: Check out source code
        uses: actions/checkout@v2
        with:
          ref: ${{ github.ref }}
          token: ${{ secrets.YOUR_PERSONAL_ACCESS_TOKEN }}
      - name: Increment value
        uses: yoichiro/gh-action-increment-value@main
        with:
          target_directory: 'foobar/baz'
          target_file: 'build_number.json'
          prefix: 'buildNumber":'
          suffix: '}'
          commit_message: 'Increment the build number to '

target_directory - The directory path where there is the target file.
target_file - The target file name.
prefix - The prefix string to determine the start position of the target number.
suffix - The suffix string to determine the end position of the target number.
commit_message - The commit message (automatically the number appended.).

To push the commit of updating the number successfully, you may specify the personal access token who has a permission (which has a repo scope) to push the commit. For example, if there are some rules to protect the branch, you need to specify the token to avoid the rules.

Also, you need to specify the paths-ignore to avoid executing the same job continuously.

Recommend Projects