Document how to release a new version of an analyzer
Problem to solve
Now that we've updated the release process for SAST and its analyzers we should document how and when to release a new version.
This is different than the Monthly release process which has been updated.
Proposal
WHERE:
-
add a dedicated release process
section to the common's README: https://gitlab.com/gitlab-org/security-products/analyzers/common/blob/master/README.md -
update the analyzer template README to point to that doc instead of the main RP (monthly): https://gitlab.com/gitlab-org/security-products/analyzers/common/blob/master/template/README.md
HOW:
-
Explain that we need to create a git tag that will trigger the creation of the docker image.
WHEN:
-
Document when it's time to release, see gitlab-org/security-products/analyzers/common!26 (closed)
What does success look like, and how can we measure that?
Release process documentation is updated.
Links / references
Edited by Daniel Paul Searles