Draft: Announce removal/consolidation of SAST analyzers
Be sure to link this MR to the relevant issues.
- Deprecation issue: #352554 (closed)
- Removal issue: #355952 (closed), #352666 (closed)
- Docs MR: !87209 (closed)
- MR that removed (or will remove) the feature: !86013 (closed)
Note: This is a moderately edited version of https://docs.gitlab.com/ee/update/deprecations#sast-analyzer-consolidation-and-cicd-template-changes
If there is no relevant deprecation issue, hit pause and:
- Review the process for deprecating and removing features.
- Connect with the Product Manager DRI.
Removals must be announced as deprecations at least 2 milestones in advance of the planned removal date.
If the removal creates a breaking change, it can only be removed in a major "XX.0" release.
By the 10th: Assign this MR to these team members as reviewers, and for approval:
- Required:
- Product Group Manager or Director: @hbenson
- Engineering Manager: @twoodham
- Technical writer: @rdickenson
- Optional:
By 7:59 AM UTC 18th (11:59 PM PT 17th): TW Reviewer updates Docs by merging this MR to master
: @TW
Please review the guidelines for removals.
EM/PM release post item checklist
-
Set yourself as the Assignee, meaning you are the DRI. -
If the removal is a breaking change, add label breaking change
. -
Follow the process to create a removal YAML file. -
Add reviewers by the 10th. -
When ready to be merged and not later than the 15th, add the ~ready label and @ message the TW for final review and merge. - Removal notices should not be merged before the code is removed from the product. Do not mark ~ready until the removal is complete, or you are certain it will be completed within the current milestone and released. If PMs are not sure, they should confirm with their Engineering Manager.
Reviewers
When the content is ready for review, the Technical Writer and Engineering Manager must
review it. Optional reviewers can include Product Marketing, Product Design, and the Product Leaders
for this area. Use the
Reviewers for Merge Requests
feature for all reviews. Reviewers will approve
the MR and remove themselves from the reviewers list when their review is complete.
-
(Recommended) PMM -
(Optional) Product Designer -
(Optional) Group Manager or Director -
Required review and approval: Technical Writer designated to the corresponding DevOps stage/group.
Tech writer review
The TW should review according to the criteria listed below. Review a removal MR with the same process as regular docs MRs. Add suggestions as needed, @ message the PM to inform them the first review is complete, and remove yourself as a reviewer if it's not yet ready for merge.
Removal notices should not be merged before the code is removed from the product.
Expand for Details
-
Title: - Length limit: 7 words (not including articles or prepositions).
- Capitalization: ensure the title is sentence cased.
- No Markdown
`code`
formatting in the title, as it doesn't render correctly in the release post.
-
Consistency: - Ensure that all resources (docs, removal, etc.) refer to the feature with the same term / feature name.
-
Content: - Make sure the removal is accurate based on your understanding. Look for typos or grammar mistakes. Work with PM and PMM to ensure a consistent GitLab style and tone for messaging, based on other features and removals.
- Review use of whitespace and bullet lists. Will the removal item be easily scannable when published? Consider adding line breaks or breaking content into bullets if you have more than a few sentences.
- Make sure there aren't acronyms readers may not understand per https://about.gitlab.com/handbook/communication/#writing-style-guidelines.
-
Links: - All links must be full URLs, as the removal YAML files are used in multiple projects. Do not use relative links. The generated doc is an exception to the relative link rule and currently uses absolute links only.
- Make sure all links and anchors are correct. Do not link to the H1 (top) anchor on a docs page.
-
Code. Make sure any included code is wrapped in code blocks. -
Capitalization. Make sure to capitalize feature names. Stay consistent with the Documentation Style Guidance on Capitalization. -
Blank spaces. Remove unnecessary spaces (end of line spaces, double spaces, extra blank lines, and lines with only spaces).
When the PM indicates it is ready for merge and all issues have been addressed, start the merge process.
Technical writer merge process
The removals doc's .md
file
must be updated before this MR is merged:
- Check out the MR's branch (in the
gitlab-org/gitlab
project). - From the command line (in the branch), run
bin/rake gitlab:docs:compile_removals
. If you want to double check that it worked, you can runbin/rake gitlab:docs:check_removals
to verify that the doc is up to date. - Commit the updated file and push the changes.
- Set the MR to merge when the pipeline succeeds (or merge if the pipeline is already complete).
If you have trouble running the rake task, check the troubleshooting steps.
Merge request reports
Activity
changed milestone to %15.0
requested review from @hbenson, @rdickenson, and @twoodham
assigned to @connorgilbert
Suggested Reviewers (beta)
This is an experimental ML-based code reviewer recommendation system created by ~"group::applied ml".
The individuals below may be good candidates to participate in the review based on various factors.
After you review all recommendations, please assign reviewers manually, as this is not done automatically.
You can use slash commands in comments to quickly assign
/assign_reviewer @user1
.Reviewers @marcel.amirault
,@cnorris
,@axil
,@eread
,@sselhorn
If you do not believe these recommendations are useful or if you do not want to use any of the suggestions, please apply the label Bad Suggested Reviewer. You can also provide feedback for this feature on this issue:
https://gitlab.com/gitlab-org/gitlab/-/issues/357923
.Automatically generated by Suggested Reviewers Bot
@connorgilbert thanks for adding the breaking change label!
This merge request introduces breaking changes. Learn more about breaking changes.
It's important to identify how the breaking change was introduced. To estimate the impact, try to assess the following:
- Are there existing users depending on this feature?
- Are self-managed customers affected?
- To verify and quantify usage, use Grafana or Kibana.
- If you're not sure about how to query the data, contact the infrastructure team on their Slack channel, #infrastructure-lounge
- Was sufficient time given to communicate the change?
- Changes in the permissions, the API schema, and the API response might affect existing 3rd party integrations.
- Reach out to the Support team or Technical Account Managers and ask about the possible impact of this change.
- Are there existing users depending on this feature?
added Bad Suggested Reviewer label
mentioned in merge request gitlab-com/www-gitlab-com!104088 (merged)
I've removed review requests because we are evaluating the likelihood of !82538 (merged) merging in time for %15.0.
This content will still be usable in any case, but the timing may not align for %15.0.
removed review request for @twoodham, @rdickenson, and @hbenson
removed breaking change label
mentioned in merge request !97450 (merged)