1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
|
# Use this template to announce a feature deprecation or other
# important planned changes at least three releases prior to removal.
# Breaking changes must happen in a major release.
#
# Copy this template into a new file in /data/deprecations, and name the file similar to:
# `16-9-deprecated-feature.yml`, where `16-9` is the announcement milestone,
# not the removal milestone.
#
# See the deprecation guidelines to confirm your understanding of GitLab's definitions:
# https://docs.gitlab.com/ee/development/deprecation_guidelines/#terminology
#
# If an End of Support period applies, see the OPTIONAL section below.
#
# For more information, see the handbook:
# https://handbook.gitlab.com/handbook/marketing/blog/release-posts/#deprecations-and-other-planned-breaking-change-announcements
# ===================
# REQUIRED FIELDS
# ===================
# ----- DELETE EVERYTHING ABOVE THIS LINE -----
- title: "Feature A is deprecated"
# The milestones for the deprecation announcement, and the removal.
removal_milestone: "XX.YY"
announcement_milestone: "XX.YY"
# Change breaking_change to false if needed.
breaking_change: true
window: # Can be 1, 2, or 3 - The window when the breaking change will be deployed on GitLab.com
reporter: exampleuser # The GitLab username of the person reporting the change
stage: stage
issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/000000
# Use the impact calculator https://gitlab-com.gitlab.io/gl-infra/breaking-change-impact-calculator/?
impact: # Can be one of: [critical, high, medium, low]
scope: # Can be one or a combination of: [instance, group, project]
resolution_role: # Can be one of: [Admin, Owner, Maintainer, Developer]
manual_task: # Can be true or false. Use this to denote whether a resolution action must be performed manually (true), or if it can be automated by using the API or other automation (false).
body: | # (required) Don't change this line.
<!-- START OF BODY COMMENT
This area supports markdown. Replace this comment with your markdown content.
Explain, *briefly*, the details or reasons for the change. Deprecations and other planned changes should be actionable, so tell users how to address the change. For example:
- "Use the `internal` keyword instead of `confidential`."
- "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.
END OF BODY COMMENT -->
# ==============================
# OPTIONAL END-OF-SUPPORT FIELDS
# ==============================
#
# If an End of Support period applies:
# 1) Share this announcement in the `#spt_managers` Support channel in Slack
# 2) Mention `@gitlab-com/support` in this merge request.
#
# When support for this feature ends, in XX.YY milestone format.
end_of_support_milestone:
# Array of tiers the feature is currently available to,
# like [Free, Silver, Gold, Core, Premium, Ultimate]
tiers:
# Links to documentation and thumbnail image
documentation_url:
image_url:
# Use the youtube thumbnail URL with the structure of https://img.youtube.com/vi/UNIQUEID/hqdefault.jpg
video_url:
|
