Skip to main content

Keep all your git forks up to date with the remote main branch.

Project description

Forks Sync

Keep all your git forks up to date with the remote main branch.

Build Status Coverage Status PyPi Licence

If you manage more than a couple git forks, keeping them up to date with the remote default branch can be a pain. Forks Sync lets you avoid all the fuss by concurrently cloning each of your projects locally, adding the remote upstream, fetching new changes, rebasing your local default branch against the remote default branch, and force pushing to your origin repo's default branch - keeping all your forks up to date with the original repo.

By default, Forks Sync will save all your forks to ~/forks-sync where you can also find logs for this tool.

Note: Before proceeding, know that this tool will forcefully update the default branch of your fork to match the upstream default branch.

Install

# Install tool
pip3 install forks-sync

# Install locally
make install

# Get Makefile help
make help

Usage

# Setup your ssh agent to ensure the script runs continually
ssh-add

# Pass your GitHub API key/token here:
GITHUB_TOKEN=123... forks-sync

# Optional params:
# FORKS_SYNC_LOCATION="~/my-folder"

Development

# Lint the project
make lint

# Run tests
make test

# Run test coverage
make coverage

# Run the tool locally
venv/bin/python forks_sync/sync.py

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

forks-sync-2.2.0.tar.gz (5.7 kB view hashes)

Uploaded Source

Built Distribution

forks_sync-2.2.0-py3-none-any.whl (6.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page