A GitHub Action for syncing between two independent repositories using force push.
- Sync two GitHub repositories
- Sync a remote repository
- GitHub action can be triggered on a timer or on push
- To sync with current repository, please checkout Github Repo Sync
- To sync only selected branches, please checkout Wei's Git Sync
This is based on Wei's Git Sync,
but differs by using gits --mirror
flag, thus reproducing all branches and
tags on the destination.
WARNING: This will also delete branches and tags at the destination if they don't exist at the source!
Always make a full backup of your repo (
git clone --mirror
) before using this action.
# .github/workflows/git-sync.yml
on: push
jobs:
git-sync:
runs-on: ubuntu-latest
steps:
- name: git-sync
uses: uFahrrad/git-sync@v4
with:
source_repo: "source_org/repository"
destination_repo: "destination_org/repository"
ssh_private_key: ${{ secrets.SSH_PRIVATE_KEY }} # optional
source_ssh_private_key: ${{ secrets.SOURCE_SSH_PRIVATE_KEY }} # optional, will override `SSH_PRIVATE_KEY`
destination_ssh_private_key: ${{ secrets.DESTINATION_SSH_PRIVATE_KEY }} # optional, will override `SSH_PRIVATE_KEY`
You can use GitHub repo shorthand like username/repository
.
The
ssh_private_key
, orsource_ssh_private_key
anddestination_ssh_private_key
must be supplied if using ssh clone urls.
source_repo: "[email protected]:username/repository.git"
or
source_repo: "[email protected]:username/repository.git"
The
ssh_private_key
,source_ssh_private_key
anddestination_ssh_private_key
can be omitted if using authenticated https urls.
source_repo: "https://username:[email protected]/username/repository.git"
You only need to set up deploy keys if repository is private and ssh clone url is used.
- Either generate different ssh keys for both source and destination repositories or use the same one for both, leave passphrase empty (note that GitHub deploy keys must be unique for each repository)
$ ssh-keygen -t rsa -b 4096 -C "[email protected]"
-
In GitHub, either:
- add the unique public keys (
key_name.pub
) to Repo Settings > Deploy keys for each repository respectively and allow write access for the destination repository
or
- add the single public key (
key_name.pub
) to Personal Settings > SSH keys
- add the unique public keys (
-
Add the private key(s) to Repo > Settings > Secrets for the repository containing the action (
SSH_PRIVATE_KEY
, orSOURCE_SSH_PRIVATE_KEY
andDESTINATION_SSH_PRIVATE_KEY
)
$ docker run --rm -e "SSH_PRIVATE_KEY=$(cat ~/.ssh/id_rsa)" $(docker build -q .) \
$SOURCE_REPO $DESTINATION_REPO
Adapted by Daniel Wagenknecht