Skip to content

Commit b978cb1

Browse files
committed
start working on readme
1 parent 588739f commit b978cb1

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# LitePipe
2+
3+
LitePipe is a simple CI/CD program written in Go using only the standard library. It's goal is to be lightweight and reliable. Put simply, it's job is to receive a webhook POST request, verify it, and then if some user-defined parameters are met, run arbitrary commands. It currently exclusively supports GitHub pull request webhooks, but in the future I aim to add more flexibility.
4+
5+
## Setup
6+
7+
After cloning this repo, (assuming you have Go installed) simply run `go build litepipe.go`. Then, you must create a configuration file.
8+
9+
### The configuration file
10+
11+
The configuration file should looks something like this:
12+
13+
```{
14+
"port": 3001,
15+
"webhookSecret": "secret",
16+
"triggerDirectories": [
17+
"directory/*",
18+
"directory2/*.html",
19+
"directory2/*/*.css"
20+
],
21+
"tasks": ["echo Hello, World"],
22+
"tasksDirectory": "directory/another_directory"
23+
}
24+
```
25+
26+
The `port` argument sets the localhost port LitePipe should listen on. The
27+
28+
The `port`, `triggerDirectories`, and `tasksDirectory` are optional, and default to `3001`, `["*"]`, and `""` (current directory) if unspecified.
29+
30+
By default, LitePipe looks for `config.json` in the same directory it is in. The configuration file should looks something like this:
31+
If necessary (for example, if LitePipe is running in a `systemctl` environment) you can specify a custom path for the configuration file with the `-config` flag. For example, on a UNIX/UNIX-like system you could run `./litepipe -config "/home/user/litepipe/config.json"`.
32+
33+
After creating the configuration file, you simply need to execute the LitePipe binary. By default

0 commit comments

Comments
 (0)