Skip to content

Document SEARCH_MAX_DEPTH option for SAST analyzers

Thiago Figueiró requested to merge sast-configuration-variables into master

What does this MR do?

The SEARCH_MAX_DEPTH variable defaults to 4 as discussed and decided in #209747 (comment 354248167).

It's important to document this variable because the rules to trigger an analyzer use glob patterns (example), which are not depth limited. This causes sast jobs to fail if a source file is in a directory depth greater than 4 because the analyzer will be run but it won't find any source files to process (example).

Therefore, it's important that this variable is in the documentation where users can find it.

Related issues

See above + internal slack thread.

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Russell Dickenson

Merge request reports

Loading