git-sync

README

Git-Sync

⭐ Star this repository if you find it valuable and worth maintaining.

👁 Watch this repository to get notified about new releases, issues, etc.

Description

This is an application with the intention of making sure that a git repository is up to date with its origin.

This is done by the following:

• Polling of the origin repository.
• Immediate Pull and reset by api endpoint.

If the local repository does not exist it will be cloned.

The repository is only updated during polling if the latest remote commit has a different hash than the last pulled, or upon application startup.

Arguments

Command Argument	Environment Variable	Description
--repo <uri>	GIT_REPO	The uri (url, file, ssh) for the git repository. (Required)
--path <dir_path>	TARGET_PATH	The local target file path for the git repository. (Required)
--branch <name>	BRANCH	The branch to track. (Default: main)
--ca-bundle-file <file_path>	CA_BUNDLE	The path to a CA Certificate bundle file.
--interval <interval>	POLL_INTERVAL	The polling interval. (Default: 900s)
--username <string>	GIT_USERNAME	The username/token for the remote git repository.
--password <string>	GIT_PASSWORD	The password for the remote git repository.
--password-file <file_path>	GIT_PASSWORD_FILE	The path to a file containing the passord for the remote git repository. This is ignored if --password is provided.
--ssh-file <file_path>	GIT_SSHKEY_FILE	The path to a file containing a SSH Private Key for the remote git repository.
--insecure <bool>	INSECURE_TLS	If set to true insecure TLS connections are allowed. (Default: false)
--known-hosts-file <file_path>	KNOWN_HOSTS_FILE	The path to a file containing known hosts for SSH.
--webhook-enabled <bool>	WEBHOOK_ENABLED	Indicates if the webhook api is enalbed. Even if webhook is not enabled the web server will still run. (Default: true)
--webhook-username <string>	WEBHOOK_USERNAME	The username for authentication to the webhook api.
--webhook-password <string>	WEBHOOK_PASSWORD	The password for authentication to the webhook api.
--webhook-password-file <file_path>	WEBHOOK_PASSWORD_FILE	The path to a file containing the password for authentication to the webhook api.
--server-address <string>	SERVER_ADDRESS	The server address for webhook/status/liveness apis. (Default: :8080)

Build

Terminal

• make - execute the build pipeline.
• make help - print help for the Make targets.

Release

The release workflow is triggered each time a tag with v prefix is pushed.

CAUTION: Make sure to understand the consequences before you bump the major version. More info: Go Wiki, Go Blog.

Maintenance

Notable files:

• .github/workflows - GitHub Actions workflows,
• .github/dependabot.yml - Dependabot configuration,
• .vscode - Visual Studio Code configuration files,
• .golangci.yml - golangci-lint configuration,
• .goreleaser.yml - GoReleaser configuration,
• Dockerfile - Dockerfile used by GoReleaser to create a container image,
• Makefile - Make targets used for development, CI build and .vscode/tasks.json,

FAQ

How can I build on Windows

Install tdm-gcc and copy C:\TDM-GCC-64\bin\mingw32-make.exe to C:\TDM-GCC-64\bin\make.exe. Alternatively, you may install mingw-w64 and copy mingw32-make.exe accordingly.

Take a look here, if you have problems using Docker in Git Bash.

You can also use WSL (Windows Subsystem for Linux) or develop inside a Remote Container. However, take into consideration that then you are not going to use "bare-metal" Windows.

Consider using goyek for creating cross-platform build pipelines in Go.

How can I customize the release

Take a look at GoReleaser docs as well as its repo how it is dogfooding its functionality. You can use it to add deb/rpm/snap packages, Homebrew Tap, Scoop App Manifest etc.

If you are developing a library and you like handcrafted changelog and release notes, you are free to remove any usage of GoReleaser.

Contributing

Feel free to create an issue or propose a pull request.

Follow the Code of Conduct.