Skip to content

Add the need for successful pipelines to update security dashboard

Jamie Reid requested to merge add-pipeline-guidance-for-sec-dashboards into master

What does this MR do?

Our docs should make it clear that Security Dashboards are only updated when a successfully completed pipeline, containing security scanner artifacts has been run on the default branch of a project.

Some development and/or deployment workflows may leverage manual blocking jobs, which can derail vulnerabilities from being considered part of main branch, potentially leading to duplicate vulnerabilities being presented within merge requests.

This MR adds that caveat, and offers a suggested workaround if manual jobs are present (Line 29).

I also suggest we point users to Scan Execution Policies in lieu of, or in addition to, scheduled pipelines.

Related issues

#330042 (closed)

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by Jamie Reid

Merge request reports

Loading