Update Files Action

A GitHub action for updating files.

This GitHub action commits changed files to a new or an existing branch and can create a pull request with the changes.

Usage

Basic usage

This example updates package-lock.json by executing npm i.

steps:
  - name: Update the lock file
    run: rm package-lock.json && npm i
  - name: Create a pull request with the updated file
    uses: branoholy/update-files-action
    with:
      token: ${{ secrets.GITHUB_TOKEN }}
      branch.name: update-lock-file
      branch.recreate: true
      commit.paths: package-lock.json
      commit.message: Update lock file

Usage with all arguments

uses: branoholy/update-files-action
with:
  token: ${{ secrets.GITHUB_TOKEN }}
  branch.name: branch-name
  branch.base: develop
  branch.recreate: false
  commit: true
  commit.paths: |
    path/to/file/*.txt
    path/to/file/*.yaml
  commit.message: Commit message
  commit.token: ${{ secrets.ANOTHER_TOKEN }}
  commit.amend: false
  pull-request: true
  pull-request.title: Pull request title
  pull-request.body: Pull request body
  pull-request.base: develop
  pull-request.labels: |
    label1
    label2
  pull-request.assignees: |
    assignee1
    assignee2
  pull-request.reviewers: |
    reviewer1
    reviewer2
  pull-request.team-reviewers: |
    team1
    team2
  pull-request.milestone: 1
  pull-request.draft: false

Example of workflow

The following workflow runs this action to update package-lock.json when it was updated by something else. This happens when a new dependency is installed or updated (for example by a tool like Dependabot).

name: Update lock file

on:
  push:
    branches: develop
    paths: package-lock.json

jobs:
  update-lock-file:
    name: Update lock file
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v2.1.0
      - name: Setup Node.js
        uses: actions/setup-node@v1.4.0
        with:
          node-version: 13.12.0
      - name: Update the lock file
        run: rm package-lock.json && npm i
      - name: Create a pull request with the updated file
        uses: branoholy/update-files-action
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          branch.name: update-lock-file
          branch.recreate: true
          commit.paths: package-lock.json
          commit.message: Update lock file

Inputs

See the action.yaml file.