trigger 1.0.0

Yet another GitHub Webhook listener
Documentation 
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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

trigger.rs
==========

[![license](https://img.shields.io/github/license/RedL0tus/trigger.svg)](LICENSE)
[![crates.io](http://meritbadge.herokuapp.com/trigger)](https://crates.io/crates/trigger)
[![Travis-CI](https://travis-ci.org/RedL0tus/trigger.svg?branch=master)](https://travis-ci.org/RedL0tus/trigger)

Yet another GitHub Webhook listener, built with [rifling](https://crates.io/crates/rifling).

Install
-------

 - Use `cargo`:
   ```bash
   cargo install trigger
   ```

 - Download binary from [GitHub release](https://github.com/RedL0tus/trigger/releases), and move it to your `PATH`.

Usage
-----

Commandline help:
```bash
trigger --help
```

Start the program
```bash
trigger "<path to config file>"
```

Configuration
-------------

Trigger's configurations are in YAML format.

Example:

```yaml
# Sample config

settings:
  host: 0.0.0.0:4567    # Host address trigger is going to listen
  secret: "secret"      # Secret used to authenticate payload (Optional)
  print_commands: false # Print command or not (Optional, default: false)
  capture_output: false # Capture output of the commands (Optional, default: false)
  exit_on_error: true   # Exit on error in commands (Optional, default: false)

events:
  common: |
    set -e;
    PAYLOAD='{payload}';
    function get_prop {
      echo $(echo ${PAYLOAD} | jq $1 | tr -d '"');
    }
    SENDER=$(get_prop '.sender.login');
    SENDER_ID=$(get_prop '.sender.id');
  all: echo "This command will be executed in all the events, the current event is {event}";
  push: echo "User \"{SENDER}\" with ID \"{SENDER_ID}\" pushed to this repository";
  watch: |
    ACTION=$(get_prop '.action');
    echo "GitHub user \"${SENDER}\" with ID \"${SENDER_ID}\" ${ACTION} watching this repository";
  else: echo "\"${SENDER}\" with ID \"${SENDER_ID}\" sent {event} event";
```

 - Secret is not required, but it's strongly recommended.
 - Commands in `events.common` will be executed before the actual event.
 - Commands in `events.all` will be executed in all 
 - All available events are listed [here](https://developer.github.com/webhooks/#events).
 - Commands in `events.else` will be executed when no matching event defined.
 - Placeholder `{payload}` in commands will be replaced with unparsed payload.
   - Please use single quotation mark to wrap around it.
   - It is possible to use jq to parse it if needed.
 - Other placeholders (if not included in the delivery, they will be replaced with `unknown`):
   - `{id}` will be replaced with ID of the event(UUID).
   - `{event}` will be replaced with type of the event.
   - `{signature}` will be replaced with signature of the payload.
   - `{request_body}` will be replaced with body of the request.


It is also recommended to use it with a reverse proxy, such as nginx:
```nginx
location /hook {
    proxy_pass http://0.0.0.0:9999/;
}
```

       
Other Snippets
--------------
Systemd unit (`trigger.service`):
```systemd
[Unit]
Description=Yet another GitHub Webhook listener
After=network-online.target

[Service]
Type=simple
WorkingDirectory=/path/to/your/config/
ExecStart=/path/to/trigger /path/to/your/config/file.yaml
Restart=always
RestartSec=3

[Install]
WantedBy=multi-user.target

# 　ｓｙ
# ｓｔｅ
# ｍｄ
```

License and Credits
-------------------

This software is distributed under the terms of MIT license, for more details, please consult [LICENSE](LICENSE) file.

Trigger uses [pretty_env_logger](https://github.com/seanmonstar/pretty-env-logger) and [log](https://github.com/rust-lang-nursery/log) to log.  
Trigger uses [yaml-rust](https://github.com/chyh1990/yaml-rust) to parse configurations.  
Trigger uses [hyper](https://github.com/hyperium/hyper) to create web server.  
Trigger uses [run_script](https://github.com/sagiegurari/run_script) to run shell code.