Update Advanced SAST documentation for C/C++ flag and the analyzer name
What does this MR do and why?
The primary purpose of
GITLAB_ADVANCED_SAST_ENABLEDis to get users from Semgrep to Lightz. Since using Advanced SAST for C/C++ will require some setup (a compilation DB), it would make sense to have a separate environment variable to enable C/C++ support.
Based on product feedback, this MR updates the documentation to introduce the new flag GITLAB_ADVANCED_SAST_CPP_ENABLED, distinct from GITLAB_ADVANCED_SAST_ENABLED.
My understanding from @connorgilbert , though i'm not sure whether it was noted down anywhere as part of this project, is that the intent was to not publicize the fact that we are using clang for our C/C++ support.
From a documentation standpoint, I would propose that we remove the mention of
clang static analyzerand replace occurrences ofclangsawithCPP Advanced SAST(I don't think we need to addGitLabin the documentation since ownership by GitLab is already implied).In the SAST.latest template, it would need to be named
cpp-gitlab-advanced-sast.
In addition, this MR replaces occurrences of clangsa with CPP Advanced SAST
References
Screenshots or screen recordings
| Before | After |
|---|---|
How to set up and validate locally
MR acceptance checklist
Evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.
/cc @cwidstrom1 @efeller