Skip to content

Commit f989e61

Browse files
committed
docs: all tables to 3 column layout
1 parent 330dc8f commit f989e61

File tree

1 file changed

+25
-25
lines changed

1 file changed

+25
-25
lines changed

documentation/config_docs.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,12 @@ Refer [here](https://docs.github.com/en/free-pro-team@latest/developers/webhooks
2727
}
2828
```
2929

30-
| value | description | optional | 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 | Yes | - |
33-
| `label_rules` | label rules config object | No | - |
34-
| `prefix_rules` | prefix rules config object | No | - |
35-
| `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 |
33+
| `label_rules` | label rules config object | required field |
34+
| `prefix_rules` | prefix rules config object | required field |
35+
| `status_rules` | status rules config object | required field |
3636

3737
## Label Options
3838

@@ -74,20 +74,20 @@ Refer [here](https://docs.github.com/en/free-pro-team@latest/developers/webhooks
7474
},
7575
```
7676

77-
| value | description | optional | default |
78-
|-|-|-|-|
79-
| `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 |
8181

8282
### Label Rule
8383

8484
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.
8585

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 |
9191

9292
## Prefix Options
9393

@@ -122,7 +122,7 @@ A **label rule** specifies whether or not a Slack channel should be notified, ba
122122
| value | description | default |
123123
|-|-|-|
124124
| `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` |
126126
| `rules` | list of `prefix_rule` objects | required field |
127127

128128
### Prefix Rule
@@ -185,10 +185,10 @@ Internally, the bot keeps track of the status of the last allowed payload, for a
185185
}
186186
```
187187

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 |
192192

193193
### Status Rules
194194

@@ -206,11 +206,11 @@ is interpreted as:
206206

207207
> "on a notification with a build state in `A`, when condition `B` is met, adopt the policy `C`".
208208
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 |
214214

215215
### Status Conditions
216216

0 commit comments

Comments
 (0)