Skip to content

Commit c4d5ae6

Browse files
committed
Merge branch 'development' of github.com:bivas/rivi into development
2 parents e4f5be5 + b2af3df commit c4d5ae6

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,20 @@ Usage of rivi:
1414
-uri string
1515
Bot URI path (default "/")
1616
```
17+
### Example
18+
```
19+
$ rivi -port 9000 -config repo-x.yaml
20+
```
1721

1822
## Requirements
1923

2024
- Create a token with `repo` persmissions
2125
- Create a webhook and make sure the following are configured:
2226

2327

24-
- **content type** is `application/json`
25-
- Set a **secret** (this will be used by the bot to validate webhook content
26-
- Register the following event
28+
- Select **content type** as `application/json`
29+
- Optionally, set a **secret** (this will be used by the bot to validate webhook content)
30+
- Register the following events
2731
- Pull request
2832
- Pull request review
2933
- Pull request review comment
@@ -40,9 +44,9 @@ config:
4044
secret: my-hook-secret-shhhhh
4145
```
4246
43-
- `provider` (optional) - which client to use for git connection (currently only `github` is supported but other are on the way)
4447
- `token` (required) - the client OAuth token the bot will connect with (and assign issues, add comments and lables)
45-
- `secret` (required) - webhook secret to be used for content validation
48+
- `provider` (optional) - which client to use for git connection - the bot tries to figure out which client to use automatically (currently only `github` is supported but others are on the way)
49+
- `secret` (optional) - webhook secret to be used for content validation (recommended)
4650

4751
## Roles Section
4852

0 commit comments

Comments
 (0)