Skip to content

Create docs page listing CWE coverage for GitLab Advanced SAST

The original description of this issue was moved to Provide public documentation on SAST rule coverage (&15343).

This issue has the scope of the first iteration.

Gather the right data, and transform it into something digestible by other sources (JSON file, etc.). That could be the input for the script that generates the markdown table.

In the first iteration, we can accept the publishing to be a manual process, as long as the artifact is automatically available, since we want to publish it as a GitLab docs page to start.

In the future, we could work on this with a designer/FE team member to design a more robust UI/UX around the same information (we can enrich that further if necessary). Then this can be published in docs or on a custom page/site or other medium.

Format

  1. Each row is a CWE.
  2. Columns are:
    • CWE, in the format CWE-#
    • CWE title
    • Programming languages:
      • With headers that are user-friendly names, capitalized in the usual way for the language, in alphabetical order:
        • C# (not csharp)
        • Go
        • Java
        • JavaScript, TypeScript (use a comma, not a slash, so that the column does not become too wide)
        • Python
        • Ruby
      • With coverage listed in cells. We will use booleans because the rule count is an implementation detail that doesn't reflect much about coverage.
      • Per docs style, the cells should be **{dotted-circle}** No or **{check-circle}** Yes. For example, see the raw content of the SAST features table.
Edited by Connor Gilbert