bitbot-3.11-fork/modules/github/ghwebhook.md

54 lines
1.9 KiB
Markdown
Raw Normal View History

2019-01-18 13:13:01 +00:00
# !ghwebhook
2019-01-20 13:02:19 +00:00
## List registered web hooks
`!ghwebhook list`
2019-01-18 13:13:01 +00:00
## Adding a web hook
`!ghwebhook add [name]` where `[name]` is either a full repository name (e.g. `jesopo/bitbot`) to get a specific repository or a user/organisation name (e.g. `jesopo`) to get all repositories for that user/organisation
## Removing a web hook
Same as above but with `remove` instead of `add`
## Modifying shown events
`!ghwebhook events [hook] [events]` where `[hook]` is the `[name]` used in the `add` command and where `[events]` is a space-separated list of either raw events (see [here](https://developer.github.com/v3/activity/events/types/)) or the following (default: "ping code pr issue repo")
2019-01-18 13:13:01 +00:00
#### ping
2019-01-18 13:13:01 +00:00
Shows when a newly registered web hook first hits BitBot
#### code
2019-01-18 13:13:01 +00:00
Shows for commits and comments on commits
#### pr-minimal
2019-01-18 13:13:01 +00:00
Shows minimal pull request actions; opened, closed, reopened
#### pr
2019-01-18 13:13:01 +00:00
Shows the same actions as `pr-minimal` and also: edited, assigned, unassigned, review requests, comments on review requests
#### pr-all
Shows the same actions as `pr` and also: labeled, unlabeled, new commits
2019-01-18 13:13:01 +00:00
#### issue-minimal
2019-01-18 13:13:01 +00:00
Shows minimal issue actions; opened, closed, reopened, deleted
#### issue
2019-01-18 13:13:01 +00:00
Shows the same actions as `issue-minimal` and also: edited, assigned, unassigned, comments on issues
#### issue-all
2019-01-18 13:13:01 +00:00
Shows the same actions as `issue` and also: transferred, pinned, unpinned, labeled, unlabeled, milestoned, demilestoned
#### repo
2019-01-18 13:13:01 +00:00
Shows events related repositories themselves; repository/branch/tag created, repository/branch/tag deleted, release created, fork created
#### team
2019-01-18 13:13:01 +00:00
Shows when users are added or removed from teams
## List shown events
`!ghwebhook events [hook]`
## Modify shown branches
`!ghwebhook branches [hook] [branches]` where `[hook]` is the `[name]` used in the `add` command and where `[branches]` is a space-separated list of branch names
## List shown branches
`!ghwebhook branches [hook]`