Draft: Replace MR-specific CI_COMMIT_SHA with default value
What does this MR do?
A customer provided the following feedback internally. Context: Trying to scan containers while avoiding duplicate vulnerability findings.
I struggle to find the correct value for
CS_DEFAULT_BRANCH_IMAGE
.
- Setting it to
$CI_REGISTRY_IMAGE/$CI_DEFAULT_BRANCH:$CI_COMMIT_SHA
works, but an image with this image tag is not existing for the Default Branch. The Commit and its reference is exclusively to the branch until it is merged.
My emphasis. The inclusion of CI_COMMIT_SHA seems OK only in the context of MR pipelines, but I've not tested this: https://docs.gitlab.com/ee/user/application_security/index.html#use-security-scanning-tools-with-merge-request-pipelines
$CI_REGISTRY_IMAGE/$CI_DEFAULT_BRANCH
does not work, but would also make sense, as non existing tags does lead to a working widget [in MR with scanning results].
- Setting it to
$CI_REGISTRY_IMAGE/$CI_DEFAULT_BRANCH:latest
works as well. Its not given as example in the docs, but makes more sense to me, as an image withlatest
tag should exist for the default branch.
I'm short on time before OoO, so I'd like to quickly suggest discussing their 2 suggestions, starting with the most sensible & smallest.
Related issues
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding a new page, add the product tier badge under the H1 topic title. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
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 likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure 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.