/fork-sync

🔄 Github action to sync your forks

Primary LanguageJavaScriptMIT LicenseMIT

Fork Sync

Build Version

Github action to sync your Forks. This action uses octokit and the GitHub API to automatically creates and merges a pull request with the head defined by ownwer:head into the base defined by base. If you create a PR in the same repository you can omit the owner parameter.

Example Workflow

name: Sync Fork

on:
  schedule:
    - cron: '*/30 * * * *'

jobs:
  sync:

    runs-on: ubuntu-latest

    steps:
      - uses: TG908/fork-sync@v1.1
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          owner: llvm
          base: master
          head: master

Parameters

name Optional Default description
owner ✅ $current_repo_owner Owner of the forked repository
github_token ❌ Token to access the Github API
head ✅ master Head branch
base ✅ master Base branch
merge_method ✅ merge merge, rebase or squash
pr_title ✅ Fork Sync Title of the created pull request
pr_message ✅ Message of the created pull request