Skip to content

Commit

Permalink
docs: add tag syncing documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
wei authored Apr 21, 2020
1 parent 000571b commit aa73859
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 .) \
Expand Down

0 comments on commit aa73859

Please # to comment.