aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 3bf21f9497df2e291d23902a408936eff2a773aa (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# ghpatch

A simple server that listens to pull requests from GitHub Webhooks and
converts them to emailed patches.

## Warning

```go
/*
NOTE: Do not use this in production yet as GitHub secrets validation,
      replay attack prevention, quite a lot of error checking, etc., are not
      implemented yet.
*/
```

## Configuration

Modify `main.go` to configure the program. (This will change once I'm a
bit more comfortable with Go.)

Run this behind a reverse proxy.

## Copyright status

Public domain, or CC0-1.0 as an alternative. A parent grant applies,
check the LICENSE file for details.

## Mirrors

- <https://git.sr.ht/~runxiyu/ghpatch> is the "canonical" repository
- <https://git.runxiyu.org/runxiyu/current/ghpatch.git> also exists and could
  be potentially be used for automatic deployment in the future
- <https://github.com/runxiyu/ghpatch> exists; however, pull requests are
  currently hooked to the GitHub endpoint of
  [Hybrid](https://git.sr.ht/~runxiyu/hybrid) rather than `ghpatch` itself