file-sync

file-sync

A GitHub Action which synchronizes files from another repository

Features

• Keeps files across multiple repositories up to date automatically
• Opens a pull request for file sync updates
• Easily configurable

Example Usage

jobs:
  run:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
        with:
          token: ${{ secrets.GITHUB_TOKEN }}

      - uses: champ-oss/file-sync
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          repo: champ-oss/terraform-module-template
          files: |
            .gitignore
            LICENSE

Token

By default the GITHUB_TOKEN should be passed to the actions/checkout step as well as this action (see example usage). This is necessary for the action to be allowed to push changes to a branch as well as open a pull request.

Important:

If you are syncing workflow files (.github/workflows) then you will need to generate and use a Personal Access Token (PAT) with repo and workflow permissions.

Parameters

Contributing