trigger.rs

Yet another GitHub Webhook listener, built with rifling.

Usage

• Install bash cargo install trigger

• Prepare your trigger.yaml
  Example: ```yaml listen: host: 0.0.0.0:9999 secret: asdasdasd

  events: push: bash -c generate.sh watch: echo Yooooooooooooooooooo ``` In this example, trigger will:

  • Bind 0.0.0.0:9999
  • Execute bash -c generate after receiving a valid payload with secret asdasdasd and event push.
  • Echo Yooooooooooooooooooo after receiving a valid payload with event watch.
• Prepare reverse proxy, for example, nginx: location /hook { proxy_pass http://0.0.0.0:9999/; } Note: It's always recommended to use a reverse proxy.
• Start trigger bash trigger
• And that's it.

Details

• In trigger.yaml:
  • In listen section:
    • secret isn't necessary, but without it trigger won't be able to check payload's validity.
  • In events section:
    • Available events:
    • checkrun
    • checksuite
    • commitcomment
    • contentreference
    • create
    • delete
    • deployment
    • deploymentstatus
    • fork
    • gollum
    • installation
    • installationrepository
    • issuecomment
    • issues
    • label
    • marketplacepurchase
    • member
    • membership
    • milestone
    • orgblock
    • organization
    • pagebuild
    • ping
    • project
    • projectcard
    • projectcolumn
    • public
    • pullrequest
    • pullrequestreview
    • pullrequestreviewcomment
    • push
    • release
    • repository
    • repositoryimport
    • repositoryvulnerabilityalert
    • securityadvisory
    • status
    • team
    • team_add
    • watch
    • unknown (Events undefined in the configuration file go here)
    • Commands:
    • It's okay to use POSIX shell syntax in the commands here.
    • {payload} will be replaced with unparsed payload

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/file ExecStart=/path/to/trigger Restart=always RestartSec=3

[Install] WantedBy=multi-user.target ```

Future Plans

• [ ] ~~Migrate afterparty to newer version of hyper if possible.~~
  • Switched to rifling.
• [x] Command line helper.

License and Credits

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

Trigger uses prettyenvlogger and log to log.
Trigger uses yaml-rust to parse configurations.
Trigger uses hyper to create web server.
Trigger uses run_script to run shell code.