aboutsummaryrefslogtreecommitdiff
path: root/modules/github/ghwebhook.md
blob: bf68d0540656c478cce2ea6c1bbabba4172795d3 (about) (plain) (blame)
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
# !ghwebhook

## List registered web hooks
`!ghwebhook list`

## 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")

#### ping
Shows when a newly registered web hook first hits BitBot

#### code
Shows for commits and comments on commits

#### pr-minimal
Shows minimal pull request actions; opened, closed, reopened

#### pr
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

#### issue-minimal
Shows minimal issue actions; opened, closed, reopened, deleted

#### issue
Shows the same actions as `issue-minimal` and also: edited, assigned, unassigned, comments on issues

#### issue-all
Shows the same actions as `issue` and also: transferred, pinned, unpinned, labeled, unlabeled, milestoned, demilestoned

#### repo
Shows events related repositories themselves; repository/branch/tag created, repository/branch/tag deleted, release created, fork created

#### team
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]`