Docs
GitHub Integration

GitHub Integration

Learn how to integrate your GitHub repositories with Repo File Sync for automated repository synchronization.

Setting Up GitHub Integration

Repo File Sync operates as a GitHub App, making it easy to synchronize changes across multiple repositories. This guide will walk you through the integration process.

Installation

  1. Login to repofilesync organization and navigate to the "integrations" page
  2. select your git source control provider, this will redirect you to the github page
  3. Click "Install" or "Configure" if you've previously installed the app
  4. Select the organization or account where you want to install Repo File Sync
  5. Choose the repositories you want to grant access to:
    • Select "All repositories" for organization-wide access
    • Or choose "Only select repositories" and pick specific ones

Permissions

Repo File Sync requires the following permissions:

  • Repository Contents: Read & write
  • Pull Requests: Read & write
  • Workflows: Read & write (if syncing GitHub Actions)

Usage

Once configured, Repo File Sync will:

  1. Monitor your source repository for changes
  2. Create pull requests in target repositories when changes are detected
  3. Keep target repositories in sync with automated updates

Troubleshooting

If you encounter issues:

  1. Verify your .github/repofilesync.yml configuration
  2. Check repository permissions
  3. Ensure target repositories are accessible
  4. Review pull request logs for detailed error messages

For additional support, visit our documentation or create an issue.