Skip to content
git-merge

GitHub Action

Sync Upstream

v2 Latest version

Sync Upstream

git-merge

Sync Upstream

Sync changes from the uppstream repo you had forked from

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Sync Upstream

              
  uses: zhangnew/sync-upstream@v2
Learn more about this action in zhangnew/sync-upstream

Choose a version

Sync Upstream

Sync changes from an upstream repository branch into a current repository branch. For example, updating changes from the repository that was forked from.

Current limitations:

  • only merge only selected branch
  • only work with public upstream Github repository
  • command is git rebase upstream/branch

To sync multiple branches, create multiple jobs.

Usage

Set up for scheduled trigger

copy and commit this to .github/workflows/sync-upstream.yml in your default branch of your repository.

name: Sync Upstream

permissions: write-all              # grant write permission

on: 
  schedule:
    - cron: '0 0 * * 1'             # scheduled for 00:00 every Monday
  workflow_dispatch:                # trigger manually

jobs:
  sync-upstream:
    runs-on: ubuntu-latest
    steps: 
      - name: Checkout
        uses: actions/checkout@v3
        with:
          ref: upstream             # set the branch to merge to
          fetch-depth: 0 
      - name: Sync Upstream
        uses: zhangnew/sync-upstream@v1
        with:
          upstream: owner/repo      # set the upstream repo
          upstream-branch: master   # set the upstream branch to merge from
          branch: upstream          # set the branch to merge to

  # set up another job to merge another branch
  sync-upstream-another-branch:
    runs-on: ubuntu-latest
    steps: 
      - name: Checkout
        uses: actions/checkout@v3
        with:
          ref: another-branch       # set the branch to merge to
          fetch-depth: 0 
      - name: Sync Upstream
        uses: zhangnew/sync-upstream@v1
        with:
          upstream: owner/repo              # set the upstream repo
          upstream-branch: another-branch   # set the upstream branch to merge from
          branch: another-branch            # set the branch to merge to

Reference: