https://github.com/lareii/autopull

🔄 A real-time GitHub auto-sync tool.
https://github.com/lareii/autopull

auto automation gin gin-gonic git git-sync go golang sync synchronisation

Last synced: 2 months ago
JSON representation

🔄 A real-time GitHub auto-sync tool.

• Host: GitHub
• URL: https://github.com/lareii/autopull
• Owner: lareii
• License: mit
• Created: 2023-12-03T18:21:39.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2024-01-02T18:02:46.000Z (12 months ago)
• Last Synced: 2024-09-30T07:21:47.098Z (3 months ago)
• Topics: auto, automation, gin, gin-gonic, git, git-sync, go, golang, sync, synchronisation
• Language: Go
• Homepage:
• Size: 295 KB
• Stars: 13
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


![Github Build Status](https://github.com/lareii/autopull/actions/workflows/build.yml/badge.svg)

[![Go Report Card](https://goreportcard.com/badge/github.com/lareii/autopull)](https://goreportcard.com/report/github.com/lareii/autopull)

![GitHub Contributors](https://img.shields.io/github/contributors/lareii/autopull?style=flat)

![GitHub Repo Stars](https://img.shields.io/github/stars/lareii/autopull?style=flat&color=yellow)

![GitHub Repo Size](https://img.shields.io/github/repo-size/lareii/autopull?style=flat)

🔄 A real-time GitHub auto-sync tool.

A simple HTTP server written in Go that monitors pushes to your GitHub repository in real-time, and pulls them from your GitHub repository.

![autopull Schema](./assets/schema.png)

## Getting Started

### Prerequisites

- Go >= 1.19

- Git

### Install autopull

You can install it via `go install` command.

```

go install github.com/lareii/autopull@latest

```

You can add the tool to path for quick access. (optional)

### Set Webhook

1. Choose a repository and click on the "Settings" tab at the top of the repository page.

2. Locate the "Webhooks" section in the left-hand sidebar.

3. In the Webhooks section, there is typically a button labeled "Add webhook" or "New webhook". Click on it to start creating a new webhook.

4. In the "Payload URL" field, enter the URL where you want GitHub to send the payload when an event occurs.

5. In the "Content type" field, select `application/json`.

6. Scroll down to the "Secret" section. Generate a secure secret key and enter it in the "Secret" field. This key will be used to secure the communication between GitHub and your server.

7. Select "Just the push event." as the event that should trigger the webhook.

8. After configuring the webhook settings, scroll down and click on the "Add webhook" or "Create webhook" button to save your changes.

9. Once the webhook is added, GitHub will send a test payload to the provided URL. Ensure that your server can receive and process this payload.

10. Back in the Webhooks section, you should see your newly added webhook. Verify that the "Recent Deliveries" section shows a successful delivery status.

### Usage

```

autopull  

```

Example usage:

```

autopull ~/website "mysupersecretoken"

```

🎉 Ta-da! Ready to use. Try to push something.

## Contributing

Contributions are welcome! To contribute, simply fork the repository, make your desired changes, and submit a pull request.

## License

This project is licensed under the MIT License. For more information, see the [LICENSE file](./LICENSE).