Skip to content

Commit 3f96cd1

Browse files
committed
docs: clean up prefix rule fields table
1 parent 86aa8f7 commit 3f96cd1

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

documentation/config_docs.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -119,11 +119,11 @@ A **label rule** specifies whether or not a Slack channel should be notified, ba
119119
]
120120
},
121121
```
122-
| value | description | optional | default |
123-
|-|-|-|-|
124-
| `default_channel` | default channel to notify if no rules match | Yes | don't notify any channel |
125-
| `default_branch_filters` | fallback branch filters (see below) if none are declared locally for a rule | Yes | don't apply branch filtering and show `distinct` commits only |
126-
| `rules` | list of `prefix_rule` objects | No | - |
122+
| value | description | if absent |
123+
|-|-|-|
124+
| `default_channel` | same behavior as label rule `default_channel` | |
125+
| `default_branch_filters` | fallback branch filters (see below) if none are declared locally for a rule | don't apply branch filtering and show `distinct` commits only |
126+
| `rules` | list of `prefix_rule` objects | required field |
127127

128128
### Prefix Rule
129129

@@ -134,12 +134,12 @@ Branch filters limit rule application to selected branches, and shows _all_ comm
134134
The filters can be declared globally with `default_branch_filters` (see above), or locally per rule with `branch_filters`, where the latter takes precedence.
135135
To ignore a globally declared filter for a single rule, declare one locally with an empty list, as shown in the example above.
136136

137-
| value | description | optional | default |
138-
|-|-|-|-|
139-
| `match` | if commit files have any prefix in this list, they should be routed to the channel | Yes | all prefixes matched if no list provided |
140-
| `ignore` | if commit files have any prefix in this list, they shouldn't be routed to the channel (even if they have any `match` prefixes) | Yes | - |
141-
| `branch_filters` | consider commits only if pushed ref branch is in this list | Yes | fall back on `default_branch_filters` behavior (see above) |
142-
| `channel` | channel to notify if the rule is matched | No | - |
137+
| value | description | if absent |
138+
|-|-|-|
139+
| `match` | if commit files have any prefix in this list, they should be routed to the channel | all prefixes matched |
140+
| `ignore` | if commit files have any prefix in this list, they shouldn't be routed to the channel (even if they have any `match` prefixes) | fall back on `match` field behavior |
141+
| `branch_filters` | consider commits only if pushed ref branch is in this list | fall back on `default_branch_filters` field behavior (see above) |
142+
| `channel` | channel to notify if the rule is matched | required field |
143143

144144
## Status Options
145145

0 commit comments

Comments
 (0)