/action-commit-push-pr

Primary LanguageJavaScript

Actions Commit Push And Pull Request

This action is a commit push and open pull request.

Configuration with With

The following settings must be passed as environment variables as shown in the example.

Key Value Suggested Type Required Default
GITHUB_TOKEN Personal github token. secret env Yes N/A
PREFIX_BRANCHES Prefix branches that need to be created. env No tmp
DEFAULT_BRANCHES Branches that want to be open pull request. env No master
COMMIT_MESSAGE Commit message. env No chore: update file
TITLE_PR Title pull request. env No chore: update file
BODY_PR Description body pull request. env No ''

Example usage

name: Update branches
on:
  schedule:
    - cron: '0 0 * * *' # Daily
    - cron: '0 0 * * 0' # Weekly
    - cron: '0 0 1 * *' # Monthly
jobs:
  update:
    runs-on: ubuntu-latest
    steps:
      # Do something ex. yarn install and execute get some file.
      - name: Commit push and pr
        uses: golfzaptw/action-commit-push-pr
        with:
          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
          PREFIX_BRANCHES: 'update'
          DEFAULT_BRANCHES: 'develop'
          COMMIT_MESSAGE: 'update value'
          TITLE_PR: 'Chore: get some file update'
          BODY_PR: ''