You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|`main_branch_name`| main branch used for the repo; filtering notifications about merges of main into other branches, and constraining prefix rule application |Yes | -|
|`status_rules`| status rules config object |No | -|
30
+
| value | description | default |
31
+
|-|-|-|
32
+
|`main_branch_name`| main branch used for the repo; filtering notifications about merges of main into other branches, and constraining prefix rule application |main branch related features disabled|
|`default_channel`| default channel to notify if no rules match |Yes | don't notify any channel|
80
-
|`rules`| list of `label_rule` objects |No | -|
77
+
| value | description | default |
78
+
|-|-|-|
79
+
|`default_channel`| default channel to notify when no rules match |no channels notified when no rules match|
80
+
|`rules`| list of `label_rule` objects |required field|
81
81
82
82
### Label Rule
83
83
84
84
A **label rule** specifies whether or not a Slack channel should be notified, based on the labels present in the given payload. For each rule, `ignore` is a blacklist of labels that should not notify the rule's channel, and `match` is a whitelist of labels that should. If a label exists in both lists, the `ignore` list takes precedence. If an empty `ignore` list is provided, nothing is ignored. If an empty `match` list is provided, everything is matched. Both are optional; if neither are provided, the rule will always generate a notification for its channel.
85
85
86
-
| value | description |optional |default |
87
-
|-|-|-|-|
88
-
|`match`| if notifications have any label in this list, they should be routed to the channel |Yes |all labels matched if no list provided|
89
-
|`ignore`| if notifications have any label in this list, they shouldn't be routed to the channel (even if they have any `match` labels) |Yes | -|
90
-
|`channel`| channel to notify if the rule is matched |No | -|
86
+
| value | description | default |
87
+
|-|-|-|
88
+
|`match`| if notifications have any label in this list, they should be routed to the channel | all labels matched |
89
+
|`ignore`| if notifications have any label in this list, they shouldn't be routed to the channel (even if they have any `match` labels) |fall back on `match` field behavior|
90
+
|`channel`| channel to notify if the rule is matched |required field|
91
91
92
92
## Prefix Options
93
93
@@ -122,7 +122,7 @@ A **label rule** specifies whether or not a Slack channel should be notified, ba
122
122
| value | description | default |
123
123
|-|-|-|
124
124
|`default_channel`| same behavior as label rule `default_channel`||
125
-
|`filter_main_branch`| if true and `main_branch_name` is declared, use main branch to filter rules that have no local filter; otherwise, don't apply branch filtering and show `distinct` commits only | false |
125
+
|`filter_main_branch`| if true and `main_branch_name` is declared, use main branch to filter rules that have no local filter; otherwise, don't apply branch filtering and show `distinct` commits only |`false`|
126
126
|`rules`| list of `prefix_rule` objects | required field |
127
127
128
128
### Prefix Rule
@@ -185,10 +185,10 @@ Internally, the bot keeps track of the status of the last allowed payload, for a
185
185
}
186
186
```
187
187
188
-
| value | description |optional |default |
189
-
|-|-|-|-|
190
-
|`allowed_pipelines`| a list of pipeline names; if specified, payloads whose pipeline name is not in the list will be ignored immediately, without checking the **status rules**; otherwise, all pipelines will be included in the status rule check| Yes | -|
191
-
|`rules`| a list of **status rules** to determine whether to *allow* or *ignore* a payload for further processing |No | -|
188
+
| value | description | default |
189
+
|-|-|-|
190
+
|`allowed_pipelines`| a list of pipeline names; if specified, payloads whose pipeline name is not in the list will be ignored immediately, without checking the **status rules**| all pipelines included in the status rule check |
191
+
|`rules`| a list of **status rules** to determine whether to *allow* or *ignore* a payload for further processing |required field|
192
192
193
193
### Status Rules
194
194
@@ -206,11 +206,11 @@ is interpreted as:
206
206
207
207
> "on a notification with a build state in `A`, when condition `B` is met, adopt the policy `C`".
208
208
209
-
| value | description |optional |default |
210
-
|-|-|-|-|
211
-
|`on`| a list of build states that can trigger this rule |No | -|
212
-
|`when`| a **status condition** object which, if specified, must be true for the rule to match |Yes | -|
213
-
|`policy`| a policy option (one of `allow`, `ignore`, `allow_once`) |No | -|
209
+
| value | description | default |
210
+
|-|-|-|
211
+
|`on`| a list of build states that can trigger this rule |required field|
212
+
|`when`| a **status condition** object which, if specified, must be true for the rule to match |no status condition applied|
213
+
|`policy`| a policy option (one of `allow`, `ignore`, `allow_once`) |required field|
0 commit comments