Skip to content

Add latest tag warning

Justin Farmiloe requested to merge jfarmiloe-add-latest-tag-warning into master

What does this MR do?

Adds a warning to not use the :latest tag when specifying a scanner image to use via the CS_ANALYZER_IMAGE variable.

This is due to the :latest tag being used by versions 4, 5 and 6 of the images and therefore not consistently mapping to the latest version 6 image.

Although the existing documentation is specific regarding the values that should be used for CS_ANALYZER_IMAGE it is not unreasonable for a customer to assume that :latest will map to the latest v6 image, and this is not necessarily the case.

I haven't added an explanation for the warning because it is a bit complicated to explain and the advice is clear on its own.

This arose in a customer support ticket where they were using :latest successfully for a time until an image publishing pipeline fault caused :latest to change from pointing to the v6 image to the v4 image, resulting in unexpected scan job errors, and it was suggested in the related issue below to add a specific warning to the docs.

Related issues

#436677 (comment 1713376198)

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 Justin Farmiloe

Merge request reports

Loading