Skip to content

Clarify instructions in the docs for adding excluded paths

Becka Lippert requested to merge beckalippert-master-patch-47346 into master

What does this MR do?

For one of the given scenarios as part of the Category Maturity Scorecard testing, we had a customer go to the docs and copy/paste the SAST_EXCLUDED_PATHS variable into their gitlab-ci.yml template (after which they added a docs path to exclude). In the process, he overrode the defaults (spec, test, tests, tmp). These defaults are listed in the docs, but I think we can do a better job of explaining that including this variable in the yml will override those defaults, and that if they want to add more paths, they'll have to , in addition, copy/paste the default paths as well.

See Slack thread (internal)

Screenshots (strongly suggested)

Does this MR meet the acceptance criteria?

Conformity

Availability and Testing

Security

If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:

  • Label as security and @ mention @gitlab-com/gl-security/appsec
  • The MR includes necessary changes to maintain consistency between UI, API, email, or other methods
  • Security reports checked/validated by a reviewer from the AppSec team

cc @rdickenson @tmccaslin @twoodham @theoretick @rossfuhrman @ssarka @nmccorrison @markrian @jannik_lehmann @zrice

Edited by Becka Lippert

Merge request reports