Team members for review and approval: Engineer(s): @hbakergitlab | Tech Writer: @phillipwells
Engineering Manager to merge when the feature is deployed and enabled: @twoodham
Important note on tier labels: Until further notice, due to change management reasons, please leverage label core
to indicate 'free' tier in all code and templates.
Please review the guidelines for content block creation at https://handbook.gitlab.com/handbook/marketing/blog/release-posts/#content-blocks. They are frequently updated, and everyone should make sure they are aware of the current standards (PM, PMM, EM, and TW). There are separate (and slightly different) templates for primary and secondary features, bugs, removals, and upgrade notes. Please make sure to use the right template!
Please be aware deprecations follow a different process in a different project and you should not be using this MR template unless you are making edits to a release post prior to 14.4.
LinksIf you need to make a change or addition to a release post item after 11:59PM PT on the Friday the milestone ends, open a new MR targeting the release-X-Y
branch and assign to the Release Post Manager, with @mention
of the lead Tech Writer and PMM. Please do not re-target the existing MR. Revisions for content in the release post branch should be made with new MRs targeted to the release post branch. It is important you follow the instructions on how to create a new MR to the release X-Y branch in Adding, editing, or removing merged content blocks after the Monday of release week and before the release date. It's highly recommended the PM connect with the release post manager to make sure content can still be added prior to creating the new MR.
Notes: Drafting release post content well in advance of the Monday of the week the milestone ends is highly recommended so reviews/revisions can happen in a rolling fashion and not bottleneck against the merge due date which is the Friday the milestone ends.
Getting ready for mergeReminder: Make sure any feature flags have been enabled or removed!
Once all content is reviewed and complete, add the Ready label and set the Engineering Manager (EM) as the Assignee. The EM is responsible for merging as soon as the implementing feature is deployed to GitLab.com, after which this content will appear on the GitLab.com Release page and can be included in the next release post. All release post items must be merged on or before the Friday the milestone ends. If a feature is not ready by the due date of the Friday the milestone ends the EM should push the release post item to the next milestone.
PM release post item checklist Expand for DetailsPlease only mark a section as completed once you performed all individual checks!
image_noshadow: true
when an image already has a shadow./embed
, not /watch
, URLs (e.g. https://www.youtube-nocookie.com/embed/eH-GuoqlweM
) more info here.https://www.youtube-nocookie.com
domain as this will allow the video to render in the review app correctly.<figure class="video_container">
tags (for responsiveness).available_in:
) is correct: (Core, Premium, Ultimate). Make sure to set gitlab_com: false
when the feature isn't available for GitLab.com users. Settings are also available for features only available for GitLab.com users.add_ons: [ ]
field. Each entry adds a badge. For Duo Pro and Duo Enterprise, specify both. For example, add_ons: ["Duo Pro", "Duo Enterprise"
].documentation_link:
), and includes the anchor to the relevant section on the page if possible. If documentation is not yet available/merged for the feature in question, you may use a placeholder or use the link where the documentation will be added (often the engineer and tech writer know this ahead of time). Be sure to update this placeholder prior to publication if you do not use the final link.about.gitlab.com
content are relative URLs.www-gitlab-com
repo for "Release Post X.Y MVP Nominations" (example), or#release-post
channel in Slack for the most recent call for MVP Nominations.This is required as part of the release post workflow. However, since review/alignment on this may take longer than the release post allows, please use a separate MR to de-couple timeline dependencies.
Expand for DetailsIn the bottom right corner of this screen, copy the name of the "Source branch"
Paste the name of this branch into the name and append it with "-pricing-theme"
Select this branch name as the source from the "Create from" field
Click "Create Branch"
Click the "Create merge request" button that appears near the top of the UI
Choose the Pricing Theme template in the new MR and follow the steps in the template
When the above is complete and the content is ready for review, it must be reviewed by Tech Writing. It can also be reviewed by Product Marketing, Product Design, and the Product Leader for this area.
Use the Reviewers for Merge Requests feature in GitLab when adding team members for content reviews. Reviewers will then approve
the MR and remove themselves from Reviewers when their review is complete.
Tip: Try using the Review App in this MR to see exactly how the release post item is rendered. This can help you catch issues that are harder to spot in YAML. Once this MR is merged, you can also see it on the release preview page prior to content assembly.
After the technical writer from the corresponding group is added as a reviewer to this merge request, they will perform their review.
Please mark a section as complete only after you performed all individual checks!
top
or primary
, review changes to features.yml
. Ensure the category
field contains the relevant categories from categories.yml
.secondary
, updating features.yml
is optional.available_in:
and gitlab_com:
available_in:
is correct and matches the docs and features.yml
if applicable.gitlab_com:
is accurately set to true
or false
.add_ons: [ ]
accurately reflects if the feature needs an AI add-on subscription. For example, if it needs both Duo Pro and Duo Enterprise, add_ons: ["Duo Pro", "Duo Enterprise"
].documentation_link
links to the correct document and anchor, and is wrapped in single quotes. Not every release item links to an exact match in the documentation. Just ensure the link seems somewhat appropriate. Test the link in your browser.documentation_link
is wrapped in single quotes and name: "Lorem ipsum"
wrapped in double quotes (for example, 'https://docs.gitlab.com/ee/#amazing'
).top
and primary
features require an image (png
, jpg
, or gif
) or video./embed/
YouTube URL path and not the ?watch=
parameter.issue_url
or epic_url
is correct.about.gitlab.com
are given by the relative path, not absolute.features.yml
, etc.) should refer to the feature the same way, including capitalization.Notes:
PMM Review is Optional
Expand for DetailsPlease only mark this section as completed once you performed all individual checks! When your review is complete, please approve
this MR and remove yourself from Reviewers.
master
"does not guarantee that the feature will be in the release" (source).x-y-stable-ee
branch (for example, 13-12-stable-ee
).master
1+ day prior to x-y-stable-ee
branch being created will likely be included in the release and release post for those features can be merged, unless there are incident blocking pipelines or a broken master./chatops run release check [MR_URL] [RELEASE]
to check if the MR will be included in the release.master
branch. If after that time, but you believe this should be merged late, follow the process for late additions and be sure to inform the release post manager.RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4