debian-mirror-gitlab/doc/development/deprecation_guidelines/index.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

105 lines
3.9 KiB
Markdown
Raw Normal View History

2021-01-29 00:20:46 +05:30
---
stage: none
group: unassigned
2021-02-22 17:27:13 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
2021-01-29 00:20:46 +05:30
---
2020-10-24 23:57:45 +05:30
# Deprecation guidelines
2022-04-04 11:22:00 +05:30
This page includes information about how and when to remove or make [breaking
changes](../contributing/index.md#breaking-changes) to GitLab features.
2020-10-24 23:57:45 +05:30
## Terminology
2022-07-23 23:45:48 +05:30
**Deprecation**:
2020-10-24 23:57:45 +05:30
2022-07-23 23:45:48 +05:30
- Feature not recommended for use.
- Development restricted to Priority 1 / Severity 1 bug fixes.
- Will be removed in a future major release.
- Begins after a deprecation announcement outlining an end-of-support date.
- Ends after the end-of-support date or removal date has passed.
2020-10-24 23:57:45 +05:30
2022-07-23 23:45:48 +05:30
**End of Support**:
- Feature usage strongly discouraged.
- No support or fixes provided.
- No longer tested internally.
- Will be removed in a future major release.
- Begins after an end-of-support date has passed.
- Ends after all relevant code has been removed.
**Removal**:
- Feature usage impossible.
- Happens in a major release in line with our
[semantic versioning policy](../../policy/maintenance.md).
- Begins after removal date has passed.
![Deprecation, End of Support, Removal process](img/deprecation_removal_process.png)
2020-10-24 23:57:45 +05:30
## When can a feature be deprecated?
2022-01-26 12:08:38 +05:30
Deprecations should be announced on the [Deprecated feature removal schedule](../../update/deprecations.md).
For steps to create a deprecation entry, see [Deprecations](https://about.gitlab.com/handbook/marketing/blog/release-posts/#deprecations).
2021-09-04 01:27:46 +05:30
2020-10-24 23:57:45 +05:30
## When can a feature be removed/changed?
2021-09-04 01:27:46 +05:30
Generally, feature or configuration can be removed/changed only on major release.
It also should be [deprecated in advance](https://about.gitlab.com/handbook/marketing/blog/release-posts/#deprecations).
2021-09-30 23:02:18 +05:30
For API removals, see the [GraphQL](../../api/graphql/index.md#deprecation-and-removal-process) and [GitLab API](../../api/index.md#compatibility-guidelines) guidelines.
2021-04-29 21:17:54 +05:30
2021-11-11 11:23:49 +05:30
For configuration removals, see the [Omnibus deprecation policy](../../administration/package_information/deprecation_policy.md).
2021-04-29 21:17:54 +05:30
For versioning and upgrade details, see our [Release and Maintenance policy](../../policy/maintenance.md).
2022-07-16 23:28:13 +05:30
## Update the deprecations and removals documentation
The [deprecations](../../update/deprecations.md) and [removals](../../update/removals.md)
documentation is generated from the YAML files located in
[`gitlab/data/`](https://gitlab.com/gitlab-org/gitlab/-/tree/master/data).
To update the deprecations and removals pages when an entry is added,
edited, or removed:
1. From the command line, navigate to your local clone of the [`gitlab-org/gitlab`](https://gitlab.com/gitlab-org/gitlab) project.
1. Create, edit, or remove the YAML file under [deprecations](https://gitlab.com/gitlab-org/gitlab/-/tree/master/data/deprecations)
or [removals](https://gitlab.com/gitlab-org/gitlab/-/tree/master/data/removals).
1. Compile the deprecation or removals documentation with the appropriate command:
- For deprecations:
```shell
bin/rake gitlab:docs:compile_deprecations
```
- For removals:
```shell
bin/rake gitlab:docs:compile_removals
```
1. If needed, you can verify the docs are up to date with:
- For deprecations:
```shell
bin/rake gitlab:docs:check_deprecations
```
- For removals:
```shell
bin/rake gitlab:docs:check_removals
```
1. Commit the updated documentation and push the changes.
1. Create a merge request using the [Deprecations](https://gitlab.com/gitlab-org/gitlab/-/blob/master/.gitlab/merge_request_templates/Deprecations.md)
or [Removals](https://gitlab.com/gitlab-org/gitlab/-/blob/master/.gitlab/merge_request_templates/Removals.md) templates.
Related Handbook pages:
- <https://about.gitlab.com/handbook/marketing/blog/release-posts/#deprecations-removals-and-breaking-changes>
- <https://about.gitlab.com/handbook/marketing/blog/release-posts/#update-the-deprecations-and-removals-docs>