-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
8095097
commit bfe7822
Showing
2 changed files
with
13 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,28 +1,35 @@ | ||
<p align="center"> | ||
<a href="https://github.com/net-engine/github-action-repository-sync"><img alt="GitHub action build status" src="https://github.com/net-engine/github-action-repository-sync/workflows/build-test/badge.svg"></a> | ||
<a href="https://github.com/net-engine/github-repository-sync-action"><img alt="GitHub action build status" src="https://github.com/net-engine/github-repository-sync-action/workflows/build-test/badge.svg"></a> | ||
</p> | ||
|
||
# Git Repository Sync Action | ||
|
||
A [GitHub action](https://github.com/features/actions) to push changes to a branch in a current GitHub repository to any remote repository, i.e. another GitHub, GitLab, AWS CodeCommit repository. | ||
|
||
Check out a [sample workflow](https://github.com/net-engine/github-repository-sync-action/blob/master/.github/workflows/test.yml). | ||
|
||
Inspired by the following actions | ||
|
||
* [wei/git-sync](https://github.com/wei/git-sync) | ||
* [pixta-dev/repository-mirroring-action](https://github.com/pixta-dev/repository-mirroring-action) | ||
|
||
## Inputs | ||
|
||
### `who-to-greet` | ||
### `ssh_private_key` | ||
|
||
**Required** The SSH private key for SSH connection to the target repository. We strongly recommend saving this value within [GitHub secrets](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets). | ||
|
||
### `target_repo_url` | ||
|
||
**Required** The name of the person to greet. Default `"World"`. | ||
**Required** The SSH-based URL to the target repository, e.g. `git@github.com:net-engine/github-repository-sync-action.git` | ||
|
||
## Example usage | ||
|
||
uses: actions/hello-world-docker-action@v1 | ||
uses: netengine/github-repository-sync-action | ||
with: | ||
who-to-greet: 'Mona the Octocat' | ||
|
||
## TODO | ||
|
||
* Support for any branch, similar to [actions/checkout@v2](https://github.com/actions/checkout) | ||
* Support for any to and from branch, similar to [actions/checkout@v2](https://github.com/actions/checkout) | ||
* Make SSH key-based authentication optional to support username/password authentication |