Skip to content

[FR] [DAC] Update custom-rules.md with Additional Notes #3673

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 15, 2024
Merged

[FR] [DAC] Update custom-rules.md with Additional Notes #3673

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs/custom-rules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,9 @@ directories:
exceptions_dir: exceptions
```

* Note: the paths in this file are relative to the custom rules directory (CUSTOM_RULES_DIR/)
* Note: The paths in this file are relative to the custom rules directory (CUSTOM_RULES_DIR/)
* Note: Refer to each original source file for purpose and proper formatting
* Note: You can also add an optional `bbr_rules_dirs` section for custom BBR rules.

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

Expand Down Expand Up @@ -101,13 +102,15 @@ class RulesConfig:
deprecated_rules: Dict[str, dict]
packages_file: Path
packages: Dict[str, dict]
rule_dirs: List[Path]
stack_schema_map_file: Path
stack_schema_map: Dict[str, dict]
test_config: TestConfig
version_lock_file: Path
version_lock: Dict[str, dict]
test_config: TestConfig

action_dir: Optional[Path] = None
bbr_rules_dirs: Optional[List[Path]] = field(default_factory=list)
exception_dir: Optional[Path] = None

# using the stack_schema_map
Expand Down
Loading