go-gitea-webhook

command module
v0.0.0-...-497a623 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 26, 2021 License: MIT Imports: 13 Imported by: 0

README

go-gitea-webhook

Simple webhook receiver implementation for Gitea/Gogs. Based on go-gitlab-webhook.

Installation guide

First get and build go-gitea-webhook:

go get github.com/mrexodia/go-gitea-webhook
cd $GOPATH/src/github.com/mrexodia/go-gitea-webhook
go build

Then set up your configuration in config.json:

{
  "logfile": "go-gitea-webhook.log",
  "address": "0.0.0.0",
  "port": 3344,
  "repositories": [
    {
      "secret": "verysecret123",
      "name": "user/repo",
      "commands": [
        "/home/user/update_repo.sh"
      ]
    }
  ]
}

Running ./go-gitea-webhook should create go-gitea-webhook.log with content like this:

2018/02/15 06:05:29 Listening on 0.0.0.0:3344

Example use case

In my case I want to pull the changes to my server when someone pushes a new commit. I use Caddy and supervisor to setup a simple service.

Contents of update_repo.sh (this will update a clone of user/repo to the latest master when executed, credentials are stored in the clone URL):

#!/bin/bash
old_pwd=$(pwd)
cd /home/user/repo
rm -rf .git/refs/heads/*
git fetch --prune origin
for branch in `git branch -a | grep remotes/origin | grep -v HEAD`; do
   git branch --track ${branch#remotes/origin/} $branch
done
git checkout -q origin/master
cd $old_pwd

Supervisor config (/etc/supervisor/conf.d/webhook.conf):

[program:webhook]
directory=/home/user/go/src/github.com/mrexodia/go-gitea-webhook
command=/home/user/go/src/github.com/mrexodia/go-gitea-webhook/go-gitea-webhook
autostart=true
autorestart=true
startsecs=10
user=user
environment=HOME="/home/user", USER="user"
minfds=8192

Contents of the Caddyfile (see documentation on how to setup a Caddy service):

webhook.example.com {
	proxy / http://127.0.0.1:3344 {
                transparent
        }
}

To set up the webhook, add a Gitea webhook with the following configuration:

Payload URL: https://webhook.example.com
Content Type: application/json
Secret: verysecret123
When should this webhook be triggered? Just the push event

When the webhook is triggered (either by pushing or by using the Test delivery button) something along these lines should be appended to go-gitea-webhook.log:

2018/02/15 06:28:51 RemoteAddr: 127.0.0.1:53778
2018/02/15 06:28:51 received webhook on user/repo
2018/02/15 06:28:55 Executed: /home/user/update_repo.sh
2018/02/15 06:28:55 Output: Branch 'master' set up to track remote branch 'master' from 'origin'.

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL