A GitHub Action for syncing between two independent repositories using force push.
- Sync branches between two GitHub repositories
- Sync branches to/from a remote repository
- GitHub action can be triggered on a timer or on push
- To sync with current repository, please checkout Github Repo Sync
Always make a full backup of your repo (
git clone --mirror) before using this action.
- 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)
$ ssh-keygen -t rsa -b 4096 -C "your_email@example.com"-
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_KEYorSOURCE_SSH_PRIVATE_KEYandDESTINATION_SSH_PRIVATE_KEY)
# .github/workflows/repo-sync.yml
on: push
jobs:
repo-sync:
runs-on: ubuntu-latest
steps:
- name: repo-sync
uses: wei/git-sync@v3
with:
source_repo: "username/repository"
source_branch: "main"
destination_repo: "git@github.com:org/repository.git"
destination_branch: "main"
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`The ssh_private_key, source_ssh_private_key and destination_ssh_private_key can be omitted if using authenticated https urls.
source_repo: "https://username:personal_access_token@github.com/username/repository.git"To Sync all branches from source to destination, use source_branch: "refs/remotes/source/*" and destination_branch: "refs/heads/*". But be careful, branches with the same name including master will be overwritten.
source_branch: "refs/remotes/source/*"
destination_branch: "refs/heads/*"To Sync all tags from source to destination, use source_branch: "refs/tags/*" and destination_branch: "refs/tags/*". But be careful, tags with the same name will be overwritten.
source_branch: "refs/tags/*"
destination_branch: "refs/tags/*"$ docker run --rm -e "SSH_PRIVATE_KEY=$(cat ~/.ssh/id_rsa)" $(docker build -q .) \
$SOURCE_REPO $SOURCE_BRANCH $DESTINATION_REPO $DESTINATION_BRANCH