Deprecation guidelines

This page includes information about how and when to remove or make breaking changes to GitLab features.

Terminology

It’s important to understand the difference between deprecation and removal:

Deprecation is the process of flagging/marking/announcing that a feature is no longer fully supported and may be removed in a future version of GitLab.

Removal is the process of actually removing a feature that was previously deprecated.

When can a feature be deprecated?

Deprecations should be announced on the Deprecated feature removal schedule.

For steps to create a deprecation entry, see Deprecations.

When can a feature be removed/changed?

Generally, feature or configuration can be removed/changed only on major release. It also should be deprecated in advance.

For API removals, see the GraphQL and GitLab API guidelines.

For configuration removals, see the Omnibus deprecation policy.

For versioning and upgrade details, see our Release and Maintenance policy.

Update the deprecations and removals documentation

The deprecations and removals documentation is generated from the YAML files located in gitlab/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 project.
  2. Create, edit, or remove the YAML file under deprecations or removals.
  3. Compile the deprecation or removals documentation with the appropriate command:

    • For deprecations:

      bin/rake gitlab:docs:compile_deprecations
      
    • For removals:

      bin/rake gitlab:docs:compile_removals
      
  4. If needed, you can verify the docs are up to date with:

    • For deprecations:

      bin/rake gitlab:docs:check_deprecations
      
    • For removals:

      bin/rake gitlab:docs:check_removals
      
  5. Commit the updated documentation and push the changes.
  6. Create a merge request using the Deprecations or Removals templates.

Related Handbook pages: