mz0in/sync-fork-upstream

A GitHub Action to Keep Your Forked Repository Up to Date

Sync Fork Upstream

Github action to sync your forked repo with the upstream repository. This action uses octokit and Github API to automatically update branch

Example Workflow

You will have to provide a personal access token for a user. Make sure the token has 'public_repo' permissions and store the token inside of the repository secrets.

name: Sync Fork Upstream

on:
  schedule:
    - cron: '0 8 * * *' # every day 8am
  workflow_dispatch: # on button click

jobs:
  sync:

    runs-on: ubuntu-latest

    steps:
      - uses: AbdulmelikKalkan/[email protected]
        env:
          ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
        with:
          owner: repo_owner
          repo: repo_name
          branch: branch_name

Parameters

name	description
owner	The account owner of the repository.
repo	The name of the repository.
branch	The name of the branch which should be updated to match upstream.