Skip to content

Commit c90d087

Browse files
Update custom-rules.md with additional notes about (#3673)
optional BBR rules
1 parent b3c7dc1 commit c90d087

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

docs/custom-rules.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,9 @@ directories:
6262
exceptions_dir: exceptions
6363
```
6464
65-
* Note: the paths in this file are relative to the custom rules directory (CUSTOM_RULES_DIR/)
65+
* Note: The paths in this file are relative to the custom rules directory (CUSTOM_RULES_DIR/)
6666
* Note: Refer to each original source file for purpose and proper formatting
67+
* Note: You can also add an optional `bbr_rules_dirs` section for custom BBR rules.
6768

6869
When using the repo, set the environment variable `CUSTOM_RULES_DIR=<directory-with-_config.yaml>`
6970

@@ -101,13 +102,15 @@ class RulesConfig:
101102
deprecated_rules: Dict[str, dict]
102103
packages_file: Path
103104
packages: Dict[str, dict]
105+
rule_dirs: List[Path]
104106
stack_schema_map_file: Path
105107
stack_schema_map: Dict[str, dict]
108+
test_config: TestConfig
106109
version_lock_file: Path
107110
version_lock: Dict[str, dict]
108-
test_config: TestConfig
109111
110112
action_dir: Optional[Path] = None
113+
bbr_rules_dirs: Optional[List[Path]] = field(default_factory=list)
111114
exception_dir: Optional[Path] = None
112115
113116
# using the stack_schema_map

0 commit comments

Comments
 (0)