debian-mirror-gitlab/data/removals/templates/example.yml

# 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 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/#deprecations-and-other-planned-breaking-change-announcements
#
# Please delete this line and above before submitting your merge request.
#
# REQUIRED FIELDS
#
- 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: 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

    Be clear and concise. Give a brief explanation of the details or reasons for the change.

    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 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
#
  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