michaKFromParis/syncfork

Keep your git forks in sync with upstream remotes without headaches

Why ?

You start forking a project and hack into it, commit, push, happy.
The original project developped a cool feature you want to sync into your fork
headache

How ?

This script follows the github recommendations and:

overrides origin and upstream remotes to values defined in syncfork.conf
fetches the upstream modifications
merges the commits into your fork, optionally squashing them into one
invokes tower or github in case of conflicts and waits for you to resolve them manually
pushes the merged result to your fork
no headache

Usage

curl -fsSL https://raw.githubusercontent.com/michaKFromParis/syncfork/master/syncfork | bash -e

Configuration

Edit syncfork.conf at the root of your repository to define the following variables:

upstreamUrl='https://github.com/[UPSTREAM_USERNAME]/[UPSTREAM_REPOSITORY]'
upstreamBranch='master'
forkUrl='https://github.com/[FORK_USERNAME]/[FORK_REPOSITORY]'
forkBranch='master'
squashCommits=true
conflictEditor='tower'

upstreamUrl: The original url of the repo you forked and want to sync

upstreamBranch: The branch you want to merge into your repo

forkUrl: The url of your forked repo

forkBranch: The branch you want new changes to be synced into

squashCommits: If set to yes, the upstream commits will be squashed into a single commit

conflictEditor: The editor you want to call in case of a merge conflict. Valid values: tower or github

Warning!! Do not add spaces around the = sign or the script won't work!

The urls used point to github but there's nothing specific to github.

Any valid remote url will work

Contributing

If you find this script useful here's how you can help:

Send a Pull Request with your awesome new features and bug fixes
Help new users with Issues they may encounter

Licence

MIT Licence. See Licence

Reference

github official instructions

michakfromparis/syncfork