diff options
Diffstat (limited to 'data/removals/templates/example.yml')
| -rw-r--r-- | data/removals/templates/example.yml | 27 |
1 files changed, 13 insertions, 14 deletions
diff --git a/data/removals/templates/example.yml b/data/removals/templates/example.yml index e7c0268c182..3645c407e25 100644 --- a/data/removals/templates/example.yml +++ b/data/removals/templates/example.yml @@ -1,43 +1,42 @@ -# This is a template for a feature removal. +# This is a template for announcing a feature removal or other important change. # # Please refer to the deprecation guidelines to confirm your understanding of GitLab's definitions. # https://docs.gitlab.com/ee/development/deprecation_guidelines/#terminology # -# If this removal is a breaking change, it must take place in a major release. +# If this is a breaking change, it 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/#removals +# 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: "X is removed. Do Y instead." # (required) Actionable title. e.g., The `confidential` field for a `Note` is deprecated. Use `internal` instead. +- title: "Feature A is removed." # (required) Clearly explain the change. For example, "The `confidential` field for a `Note` is removed" or "CI/CD job names are limited to 250 characters." announcement_milestone: "XX.YY" # (required) The milestone when this feature was deprecated. announcement_date: "YYYY-MM-DD" # (required) The date of the milestone release when this feature was deprecated. This should almost always be the 22nd of a month (YYYY-MM-DD), unless you did an out of band blog post. removal_milestone: "XX.YY" # (required) The milestone when this feature is being removed. removal_date: "YYYY-MM-DD" # (required) This should almost always be the 22nd of a month (YYYY-MM-DD), the date of the milestone release when this feature will be removed. - breaking_change: false # (required) Change to true if this removal is a breaking change. + breaking_change: true # (required) Change to false if this is not a breaking change. reporter: exampleuser # (required) GitLab username of the person reporting the removal 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 - This area supports markdown. Delete this entire comment and replace it with your markdown content. + Be clear and concise. Give a brief explanation of the details or reasons for the change. - Removals must be actionable. + Additionally, removals and other planned changes should be actionable, so add details that explain what users need to do to address the change. For example: - Use terms such as "removed in favor of" or "use X instead." If no replacement is available, the action would be, "Discontinue use of foo immediately." - - For example: - - - The `confidential` field for a `Note` is removed. Use `internal` instead. - - The `merge_status` field in the merge request API has been removed in favor of `detailed_merge_status`. - - The `notable` endpoint has been removed. Discontinue use of `notable` immediately. + - "Use the `internal` keyword instead of `confidential`." + - "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 has been removed and will not be replaced." When ready, assign to your tech writer for review. When ready, they will run `bin/rake gitlab:docs:compile_removals` to update the removals doc, then merge. + This area supports markdown. Delete this entire comment and replace it with your markdown content. + END OF BODY COMMENT --> # # OPTIONAL FIELDS |