Skip to content

Latest commit

 

History

History
171 lines (127 loc) · 6.51 KB

cep-9.md

File metadata and controls

171 lines (127 loc) · 6.51 KB
Raw
Title Conda Deprecation Schedule
Status Accepted
Author(s) Ken Odegard <kodegard@anaconda.com>, Jannis Leidel <jleidel@anaconda.com>, Travis Hathaway <thathaway@anaconda.com>
Created May 20, 2022
Updated September 20, 2022
Discussion #27
Implementation NA

Abstract

This CEP describes a deprecation schedule to properly warn about upcoming removals from the codebase. This policy expands on ideas and terminology defined in the Conda Release Schedule (CEP-8).

Note This CEP is only applicable for projects that have adopted the Conda Release Schedule (CEP-8).

Specification

We propose a deprecation schedule that is slower than the Conda Release Schedule (CEP-8). This is in acknowledgment of our diverse user groups (e.g. everything from per user per machine installs to multi-user installs on shared clusters).

We define a new type of release, a deprecation release, to augment regular releases. A deprecation release occurs twice every year in March and September:

Version Release Type
YY.1.0 regular
YY.2.0 optional
YY.3.0 regular, deprecation
YY.4.0 optional
YY.5.0 regular
YY.6.0 optional
YY.7.0 regular
YY.8.0 optional
YY.9.0 regular, deprecation
YY.10.0 optional
YY.11.0 regular
YY.12.0 optional

All deprecations will need to transition through three (3) states:

  1. Pending deprecation: when a feature is marked for future deprecation
    • Any feature can be marked as pending deprecation in any release
    • This state is also a comment period where community concerns or disputes may be raised, see Disputing a Deprecation
  2. Deprecated: when a feature is marked for future removal
    • All pending deprecations that have been through at least two (2+) regular release (4-9 months after being marked as pending deprecation) are relabeled as deprecated in the next deprecation release
    • This state is considered final, the deprecation will occur, disputes are no longer possible, see Disputing a Deprecation
  3. Removed: when a feature is removed from the codebase
    • All deprecations are removed in the next deprecation release

This would result in the following schedule:

gantt
    dateFormat  YYYY-MM
    axisFormat YY.%_m
    title       June-November (YX.6-YX.11) Pending → March (YY.3) Deprecations → September (YY.9) Removals

    section Jun
    Pending     :           2023-06, 2024-03
    Deprecated  :active,    2024-03, 2024-09
    Removed     :milestone, 2024-09

    section Jul
    Pending     :           2023-07, 2024-03
    Deprecated  :active,    2024-03, 2024-09
    Removed     :milestone, 2024-09

    section Aug
    Pending     :           2023-08, 2024-03
    Deprecated  :active,    2024-03, 2024-09
    Removed     :milestone, 2024-09

    section Sep
    Pending     :           2023-09, 2024-03
    Deprecated  :active,    2024-03, 2024-09
    Removed     :milestone, 2024-09

    section Oct
    Pending     :           2023-10, 2024-03
    Deprecated  :active,    2024-03, 2024-09
    Removed     :milestone, 2024-09

    section Nov
    Pending     :           2023-11, 2024-03
    Deprecated  :active,    2024-03, 2024-09
    Removed     :milestone, 2024-09

gantt
    dateFormat  YYYY-MM
    axisFormat YY.%_m
    title       December-May (YX.12-YY.5) Pending → September (YY.9) Deprecations → March (YZ.3) Removals

    section Dec
    Pending     :           2022-12, 2023-09
    Deprecated  :active,    2023-09, 2024-03
    Removed     :milestone, 2024-03

    section Jan
    Pending     :           2023-01, 2023-09
    Deprecated  :active,    2023-09, 2024-03
    Removed     :milestone, 2024-03

    section Feb
    Pending     :           2023-02, 2023-09
    Deprecated  :active,    2023-09, 2024-03
    Removed     :milestone, 2024-03

    section Mar
    Pending     :           2023-03, 2023-09
    Deprecated  :active,    2023-09, 2024-03
    Removed     :milestone, 2024-03

    section Apr
    Pending     :           2023-04, 2023-09
    Deprecated  :active,    2023-09, 2024-03
    Removed     :milestone, 2024-03

    section May
    Pending     :           2023-05, 2023-09
    Deprecated  :active,    2023-09, 2024-03
    Removed     :milestone, 2024-03

Occasionally, there may be changes to the codebase that warrant a longer deprecation schedule. If that occurs, the deprecation warning will clearly specify that a deviation is occurring and what the expected schedule will be instead.

Disputing a Deprecation

The pending deprecation state is also a comment period whereby disputes for the deprecation may be raised.

To raise a dispute, open an issue on the relevant repository with the following details:

  1. Which pending deprecation feature to dispute
  2. Details and explanation for why the pending deprecation shouldn't proceed

It's up to the repository maintainers to engage in the discussion, resolve concerns, or ultimately revert the pending deprecation status.

Should the dispute reach an impasse, the steering council must vote on the resolution following the standard voting procedure of an enhancement proposal.

Motivation

This CEP will help prevent unexpected breakage of downstream tooling as the codebase evolves.

Backwards Compatibility

This is backwards compatible and will also encourage better backwards compatibility.

Alternatives

  1. Ad hoc deprecations.
    • Unpredictable and unreliable.
  2. Mark as pending deprecation in one release, mark as a deprecated in the next release, and remove in third release.
    • Rejected for being too rapid given the sprawling ecosystem and unknown number of downstream applications.

Resolution

This section contains the final decision on this issue.

Reference

Copyright

All CEPs are explicitly CC0 1.0 Universal.