From aa73859b298106d4143d7f0ec50deea79249056c Mon Sep 17 00:00:00 2001 From: Wei He Date: Tue, 21 Apr 2020 12:42:33 -0400 Subject: [PATCH] docs: add tag syncing documentation --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 9fc9f72..6b591f9 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,8 @@ A GitHub Action for syncing between two independent repositories using **force p ## Usage +Always make a full backup of your repo (`git clone --mirror`) before using this action. + ### GitHub Actions ``` # File: .github/workflows/repo-sync.yml @@ -38,6 +40,10 @@ jobs: 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. +#### Advanced: Sync all tags + +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. + ### Docker ``` docker run --rm -e "SSH_PRIVATE_KEY=$(cat ~/.ssh/id_rsa)" $(docker build -q .) \