diff options
Diffstat (limited to 'data/deprecations/templates/example.yml')
| -rw-r--r-- | data/deprecations/templates/example.yml | 24 |
1 files changed, 11 insertions, 13 deletions
diff --git a/data/deprecations/templates/example.yml b/data/deprecations/templates/example.yml index 619810f1e7e..dcb78fa434b 100644 --- a/data/deprecations/templates/example.yml +++ b/data/deprecations/templates/example.yml @@ -1,28 +1,27 @@ -# This is a template for a feature deprecation. +# This is a template for announcing a feature deprecation or other important planned change. # -# Please refer to the deprecation guidelines to confirm your understanding of the -# definitions for "Deprecation", "End of Support", and "Removal": +# Please refer to the deprecation guidelines to confirm your understanding of GitLab's definitions. # 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. +# Deprecations and other future breaking changes must be announced at least +# three releases prior to removal. # # Breaking changes must happen in a major release. # +# See the OPTIONAL END OF SUPPORT FIELDS section below if an End of Support period also applies. +# # For more information please refer to the handbook documentation here: -# https://about.gitlab.com/handbook/marketing/blog/release-posts/#deprecations +# https://about.gitlab.com/handbook/marketing/blog/release-posts/#deprecations-and-other-planned-breaking-change-announcements # # 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." +- title: "Feature A is deprecated" # (required) Clearly explain the change, or planned change. For example, "The `confidential` field for a `Note` is deprecated" or "CI/CD job names will be limited to 250 characters." 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 + breaking_change: true # (required) Change to false if this is not a breaking change. + reporter: exampleuser # (required) GitLab username of the person reporting the change 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. @@ -33,7 +32,7 @@ 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." + - "Reduce the number of characters in all job names 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." @@ -49,7 +48,6 @@ # 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 # |