59 lines
3.9 KiB
YAML
59 lines
3.9 KiB
YAML
# This is a template for a feature deprecation.
|
|
#
|
|
# Please refer to the deprecation guidelines to confirm your understanding of the
|
|
# definitions for "Deprecation", "End of Support", and "Removal":
|
|
# https://docs.gitlab.com/ee/development/deprecation_guidelines/#terminology
|
|
#
|
|
# Deprecations must be announced at least three releases prior to removal.
|
|
# See the OPTIONAL END OF SUPPORT FIELDS section below if an End of Support period also applies.
|
|
#
|
|
# Breaking changes must happen in a major release.
|
|
#
|
|
# For more information please refer to the handbook documentation here:
|
|
# https://about.gitlab.com/handbook/marketing/blog/release-posts/#deprecations
|
|
#
|
|
# Please delete this line and above before submitting your merge request.
|
|
#
|
|
# REQUIRED FIELDS
|
|
#
|
|
- title: "Feature A is deprecated" # (required) Clearly explain the change, or planned change. For example, "The `confidential` field for a `Note` is deprecated" or "The maximum number of characters in a job name will be limited to 250."
|
|
announcement_milestone: "XX.YY" # (required) The milestone when this feature was first announced as deprecated.
|
|
announcement_date: "YYYY-MM-DD" # (required) The date of the milestone release when this feature was first announced as deprecated. This should almost always be the 22nd of a month (YYYY-MM-22), unless you did an out of band blog post.
|
|
removal_milestone: "XX.YY" # (required) The milestone when this feature is planned to be removed
|
|
removal_date: # (required) The date of the milestone release when this feature is planned to be removed. This should almost always be the 22nd of a month (YYYY-MM-22), unless you did an out of band blog post.
|
|
breaking_change: false # (required) If this deprecation is a breaking change, set this value to true
|
|
reporter: exampleuser # (required) GitLab username of the person reporting the deprecation
|
|
stage: stage # (required) String value of the stage that the feature was created in. e.g., Growth
|
|
issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/000000 # (required) Link to the deprecation issue in GitLab
|
|
body: | # (required) Do not modify this line, instead modify the lines below.
|
|
<!-- START OF BODY COMMENT
|
|
|
|
Be clear and concise. Give a brief explanation of the details or reasons for the change.
|
|
|
|
Additionally, deprecations and other planned changes should be actionable, so add details that explain what users need to do to address the change. For example:
|
|
|
|
- "Use the `internal` keyword instead of `confidential`."
|
|
- "Reduce the number of characters in all jobs to be 250 characters or less."
|
|
- "Give an expiration date to any access tokens that have no expiration date."
|
|
- "Stop using the `omniauth_crowd` gem. It will be removed and will not be replaced."
|
|
|
|
When ready, assign to your tech writer for review. They will run `bin/rake gitlab:docs:compile_deprecations` to update the deprecations doc, then merge.
|
|
|
|
This area supports markdown. Delete this entire comment and replace it with your markdown content.
|
|
|
|
END OF BODY COMMENT -->
|
|
#
|
|
# OPTIONAL END OF SUPPORT FIELDS
|
|
#
|
|
# If an End of Support period applies, the announcement should be shared with GitLab Support
|
|
# in the `#spt_managers` channel in Slack, and mention `@gitlab-com/support` in this MR.
|
|
#
|
|
end_of_support_milestone: # (optional) Use "XX.YY" format. The milestone when support for this feature will end.
|
|
end_of_support_date: # (optional) The date of the milestone release when support for this feature will end.
|
|
#
|
|
# OTHER OPTIONAL FIELDS
|
|
#
|
|
tiers: # (optional - may be required in the future) An array of tiers that the feature is available in currently. e.g., [Free, Silver, Gold, Core, Premium, Ultimate]
|
|
documentation_url: # (optional) This is a link to the current documentation page
|
|
image_url: # (optional) This is a link to a thumbnail image depicting the feature
|
|
video_url: # (optional) Use the youtube thumbnail URL with the structure of https://img.youtube.com/vi/UNIQUEID/hqdefault.jpg
|