Skip to content

Commit e734c2e

Browse files
committed
reapply minor changes that escaped rebase
1 parent ae8fd7a commit e734c2e

File tree

5 files changed

+11
-11
lines changed

5 files changed

+11
-11
lines changed

documentation/config_docs.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ A json object with fields of bools for each status type.
105105

106106
| value | description | optional | default |
107107
|-|-|-|-|
108-
| `default_channel` | default channel to notify if no rules match | Yes | None |
108+
| `default_channel` | default channel to notify if no rules match | Yes | don't notify any channel |
109109
| `rules` | list of `label_rule` objects | No | - |
110110

111111
### Label Rule
@@ -114,8 +114,8 @@ A **label rule** specifies whether or not a Slack channel should be notified, ba
114114

115115
| value | description | optional | default |
116116
|-|-|-|-|
117-
| `allow` | whitelist of label values; if not provided, the rule is vacuously satisfied | Yes | - |
118-
| `ignore` | blacklist of label values; any labels matching will not match the rule | Yes | - |
117+
| `allow` | whitelist of labels that should match the rule | Yes | all labels allowed if no list provided |
118+
| `ignore` | blacklist of labels that shouldn't match the rule | Yes | - |
119119
| `channel` | channel to use as webhook if the rule is matched | No | - |
120120

121121
## Prefix Options
@@ -151,6 +151,6 @@ A **prefix rule** specifies whether or not a Slack channel should be notified, b
151151

152152
| value | description | optional | default |
153153
|-|-|-|-|
154-
| `allow` | whitelist of file prefixes that match the rule | Yes | - |
155-
| `ignore` | blacklist of file prefixes that do not match the rule | Yes | - |
154+
| `allow` | whitelist of file prefixes that should match the rule | Yes | all prefixes allowed if no list provided |
155+
| `ignore` | blacklist of file prefixes that shouldn't match the rule | Yes | - |
156156
| `channel` | channel to use as webhook if the rule is matched | No | - |

documentation/secret_docs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,12 +45,12 @@ A secrets file stores sensitive information. Unlike the repository configuration
4545
|-|-|-|-|
4646
| `slack_hooks` | list of channel names (`channel`) and their corresponding webhook endpoint (`url`) | No | - |
4747
| `gh_token` | specify to grant the bot access to private repositories; omit for public repositories | Yes | - |
48-
| `gh_webhook_secret` | specify to ensure the bot only receives GitHub notifications from pre-approved repositories | Yes | - |
48+
| `gh_hook_token` | specify to ensure the bot only receives GitHub notifications from pre-approved repositories | Yes | - |
4949

5050
## `gh_token`
5151

5252
Some operations, such as fetching a config file from a private repository, or the commit corresponding to a commit comment event, require a personal access token. Refer [here](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token) for detailed instructions on token generation.
5353

54-
## `gh_webhook_secret`
54+
## `gh_hook_token`
5555

5656
Refer [here](https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/securing-your-webhooks) for more information on securing webhooks with a token.

lib/config.atd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ type label_rule <ocaml from="Rule"> = abstract
44

55
(* This type of rule is used for CI build notifications. *)
66
type status_rules = {
7-
?allowed_pipelines: string list nullable; (* keep only status events with a title matching this list *)
7+
?allowed_pipelines : string list nullable; (* keep only status events with a title matching this list *)
88
rules: status_state;
99
}
1010

lib/rule.atd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ type status_state = {
3030
type prefix_rule = {
3131
?allow : string list nullable;
3232
?ignore : string list nullable;
33-
channel_name <json name="channel">: string;
33+
channel_name <json name="channel"> : string;
3434
}
3535

3636
(* A payload matches a label rule with a channel name if absent from the ignore list
@@ -39,5 +39,5 @@ type prefix_rule = {
3939
type label_rule = {
4040
?allow : string list nullable;
4141
?ignore : string list nullable;
42-
channel_name <json name="channel">: string;
42+
channel_name <json name="channel"> : string;
4343
}

test/notabot.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
"success": "once"
1414
}
1515
},
16-
"prefix_rules": {
16+
"prefix_rules": {
1717
"default_channel": "default",
1818
"rules": [
1919
{

0 commit comments

Comments
 (0)