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

# This is a template for a feature removal.
#
# 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.
#
# For more information please refer to the handbook documentation here:
# https://about.gitlab.com/handbook/marketing/blog/release-posts/#removals
#
# 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.
  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.
  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.

    Removals must be actionable.

    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.

    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.

    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