macports/mpbot-github
0
0
Fork 0
mirror of https://github.com/macports/mpbot-github.git synced 2026-07-13 03:18:39 -07:00
Code Issues Packages Projects Releases Wiki Activity

Add README.md

Browse Source
This commit is contained in:
Zero King
2017-07-29 07:29:27 +00:00
parent cb544bc919
commit 8490cc38b3
1 changed files with 24 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+24
View File
@@ -0,0 +1,24 @@
# Bot to manage and test GitHub pull requests
The PR bot processes GitHub webhook events and can be built with `go get github.com/macports/mpbot-github/pr/prbot`.
The CI bot tests PRs on Travis CI and can be built with `go get github.com/macports/mpbot-github/ci/runner`,
it assumes that MacPorts is already installed and no cleanup is needed.
## PR bot
To run the PR bot, you need to set the following environment variables.
In `pr/db/dbutil.go`, [connection strings](https://godoc.org/github.com/lib/pq#hdr-Connection_String_Parameters) for the PostgreSQL databases:
- TRAC_DB: connection string for the Trac DB
- WWW_DB: connection string for the PortIndex DB (https://github.com/macports/macports-infrastructure/tree/master/jobs)
- PR_DB: connection string for the bot's own DB
In `pr/prbot/main.go`, secrets and production flag:
- HUB_WEBHOOK_SECRET: used to verify webhook events
- HUB_BOT_SECRET: used to comment and modify labels in PRs
- BOT_ENV: set to `production` to actually mention maintainers
You can use `-l addr:port` to set the listen address for GitHub webhook.