Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/agherzan/git-mirror-me
CLI tool that facilitates mirroring a source to a destination git repository
https://github.com/agherzan/git-mirror-me
cli git mirror
Last synced: 27 days ago
JSON representation
CLI tool that facilitates mirroring a source to a destination git repository
- Host: GitHub
- URL: https://github.com/agherzan/git-mirror-me
- Owner: agherzan
- License: mit
- Created: 2022-04-25T12:09:42.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-07-26T22:50:39.000Z (over 2 years ago)
- Last Synced: 2024-06-19T05:56:47.553Z (5 months ago)
- Topics: cli, git, mirror
- Language: Go
- Homepage:
- Size: 74.2 KB
- Stars: 11
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: FUNDING.yml
- License: COPYING.MIT
Awesome Lists containing this project
README
# Git Mirror-Me (`GMm`)
[](https://goreportcard.com/report/github.com/agherzan/git-mirror-me)
[](https://codecov.io/gh/agherzan/git-mirror-me)
[](/COPYING.MIT)
[](https://api.reuse.software/info/github.com/agherzan/git-mirror-me)
This CLI tool provides the ability to mirror a repository to any other git
repository with optional SSH authentication. For example, it can be used with
repositories on GitHub, GitLab, Bitbucket, etc.
Why "Me"? The name derives from the tool's "ability" to default the source
repository to the value computed from a GitHub action environment.
## Install
```
go install github.com/agherzan/git-mirror-me/cmd/git-mirror-me@latest
```
## Build
Use the provided `make` script by taking advantage of the `build` target:
```
make build
```
## Tool configuration
The tool can be configured via CLI arguments and/or environment variables.
Run the tool in `help` mode (`git-mirror-me -h`) to check its full description.
### Arguments/Flags
#### `-source-repository`
* Sets the source repository for the mirror operation.
* Can also be set via environment variables.
#### `-destination-repository`
* Sets the destination repository for the mirror operation.
* Can also be set via environment variables.
#### `-ssh-known-hosts-path`
* Defines the path to the `known_hosts` file.
* This is an alternative to providing the host public keys via the
`GMM_SSH_KNOWN_HOSTS` environment variable (see below).
#### `-debug`
* Runs the tool in debug mode.
* Can also be enabled via an environment variable.
### Environment variables
This tool uses `GMM_` as prefix for all the environment variables defined in
its scope. That doesn't include the ones prefixed by `GITHUB_` as they are
expected to be provided directly by the GitHub CI environment.
#### `GMM_SRC_REPO`, `GITHUB_SERVER_URL` and `GITHUB_REPOSITORY`
* The source repository can be provided in three ways, listed below in the
descending order of their precedence:
* the `-source-repository` CLI argument
* the `GMM_SRC_REPO` environment variable
* using the `GITHUB_SERVER_URL` and `GITHUB_REPOSITORY` environment variables
as `GITHUB_SERVER_URL/GITHUB_REPOSITORY`
#### `GMM_DST_REPO`
* Sets the destination repository for the mirror operation.
#### `GMM_SSH_PRIVATE_KEY`
* The SSH private key used for SSH authentication during git push operation.
* Password protected SSH keys are not supported.
* When not defined, `git` operations will be executed without authentication.
* When defined, a host public key configuration is required.
#### `GMM_SSH_KNOWN_HOSTS`
* The hosts public keys used for host validation.
* The format needs to be based on the`known_hosts` file.
#### `GMM_DEBUG`
* When set to '1', runs the tools in debug mode.
## Tests and Linters
Use the provided `make` script. For tests, a `test` target is provided: `make
test`.
Linters can be executed using `make lint`. This make target has additional host
dependencies on
[golangci-lint](https://github.com/golangci/golangci-lint).
## Contributing
Contributions are more than welcome. You can send patches using [GitHub pull
requests](https://github.com/agherzan/git-mirror-me/pulls).
### Developer Certificate of Origin
The Developer Certificate of Origin (DCO) is a lightweight way for contributors
to certify that they wrote or otherwise have the right to submit the code they
are contributing to the project. Here is the full [text of the
DCO](https://developercertificate.org/), reformatted for readability:
> By making a contribution to this project, I certify that:
>
> a. The contribution was created in whole or in part by me and I have the
> right to submit it under the open source license indicated in the file; or
>
> b. The contribution is based upon previous work that, to the best of my
> knowledge, is covered under an appropriate open source license and I have the
> right under that license to submit that work with modifications, whether
> created in whole or in part by me, under the same open source license (unless
> I am permitted to submit under a different license), as indicated in the
> file; or
>
> c. The contribution was provided directly to me by some other person who
> certified (a), (b) or (c) and I have not modified it.
>
> d. I understand and agree that this project and the contribution are public
> and that a record of the contribution (including all personal information I
> submit with it, including my sign-off) is maintained indefinitely and may be
> redistributed consistent with this project or the open source license(s)
> involved.
Contributors _sign-off_ that they adhere to these requirements by adding a
`Signed-off-by` line to commit messages.
```
This is my commit message
Signed-off-by: Random J Developer
```
Git has a `-s` command line option to append this automatically to your
commit message based on your git configuration (name and email):
```
$ git commit -s -m 'This is my commit message'
```
## Maintainers
* Andrei Gherzan ``
## LICENSE
This repository is [reuse](https://reuse.software/) compliant and it is
released under the [MIT](COPYING.MIT) license.
For convenience, a `make` target is provided to validate this compliance: `make
reuse`. This `make` target has an additional but optional host dependency
on [reuse](https://github.com/fsfe/reuse-tool).