4.6 KiB
A written process alone is unlikely to be sufficient to navigate through many complexities. Please use this template as guidance with steps to take when deprecating functionality, but not as an exhaustive list designed to generate positive outcomes every time. Deprecations are often nuanced in their impact and the approach needed may not be fully covered in this template.
Deprecation Summary
Add a brief description of the feature or functionality that is deprecated. Clearly state the potential impact of the deprecation to end users.
Documentation
Reasons
_Describe why deprecation of this feature is necessary
- add links to the documentation - i.e. Decision-Matrix, etc.
Breaking Change?
Does this deprecation contain a breaking change? Yes / No
Affected Users
Who is affected by this deprecation: GitLab.com users, Self-managed users, or Dedicated users? (choose all that apply)
- GitLab.com
- Self-managed
- Dedicated
Deprecation Milestone
This deprecation will be announced in milestone: xx.xx If this deprecation
has already been announced, include information about when the initial
announcement went out and what follow-up announcements are scheduled.
Planned Removal Milestone
The feature / functionality will be removed in milestone: xx.xx
Links
Checklists
Timeline
Communication Plan
- DRI Product Manager:
@PM
An internal slack post and a release post are not sufficient notification for our customers or internal stakeholders. Plan to communicate proactively and directly with affected customers and the internal stakeholders supporting them.
Internal Communication Plan
- Internal announcement plan (timeline for notifications, audience, channels, etc)
External Communication Plan
- User announcement plan (timeline for notifications, audience, channels,
etc)
- Documentation has been updated to mark the feature as
deprecated. Add link to the relevant merge request.
- Documentation has been updated to mark the feature as
- On the major milestone:
- The deprecated item has been removed. Add link to the relevant merge request.
- If the removal of the deprecated item is a breaking change, the merge request is labeled ~"breaking change".
- Document the migration plan for users, clearly outlining the actions they need to take to mitigate the impact of the breaking change.
Labels
/label ~group: ~"Category:
- This issue is labeled ~deprecation, and with the relevant
~group::, and~Category:labels. - This issue is labeled ~"breaking change" if the removal of the deprecated item will be a breaking change.
/label ~"deprecation"