Skip to content

docs: update versioning docs #13269

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Apr 30, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
@@ -59,8 +59,7 @@ At this time, do not use the merge queue option.
Backporting
-----------

Each minor version has its own branch. Bug fixes are "backported" from trunk to certain
minor version branches according to the :ref:`version support policy<versioning_release>`.
Each minor version has its own branch.

* **Fix PRs** are backported to all maintained release branches.
* **CI PRs** are backported to the maintained release branches.
2 changes: 1 addition & 1 deletion docs/releasenotes.rst
Original file line number Diff line number Diff line change
@@ -11,7 +11,7 @@ with the library.

A release note is **required** if a PR is user-impacting, or if it meets any of the following conditions:

* :ref:`Breaking change to the public API<versioning_release>`
* Breaking change to the public API
* New feature
* Bug fix
* Deprecations
110 changes: 1 addition & 109 deletions docs/versioning.rst
Original file line number Diff line number Diff line change
@@ -6,70 +6,7 @@ Versioning

Release support
===============

.. list-table::
:header-rows: 1

* - Release
- :ref:`Support level<versioning_support_levels>`
- Minimum Datadog Agent
* - ``<2``
- :ref:`End of Life<versioning_support_eol>`
-
* - ``>=2.0,<3``
- :ref:`Maintenance<versioning_support_maintenance>`
- 7.28
* - ``>=3.0,<4``
- :ref:`General Availability<versioning_support_ga>`
- 7.28

.. _versioning_support_levels:

Support levels
==============

.. list-table::
:header-rows: 1

* - Level
- Policy

.. _versioning_support_ga:
* - General Availability (GA)
- Bug fixes are released on the most recent General Availability minor release line. New features are released periodically
as minor version changes. Critical fixes are backported to the three most recent minor release lines.

.. _versioning_support_maintenance:
* - Maintenance
- The most recent Maintenance minor release line receives critical fixes.

.. _versioning_support_eol:
* - End-of-Life (EOL)
- Receives no updates or support

.. _versioning_release:

Release versions
================

The non-negative integer components of the **version format** (``v<MAJOR>.<MINOR>.<PATCH>``) are incremented by the criteria:

MAJOR
Incompatible changes to the public :ref:`interface<versioning_interfaces>`

Removing support for a :ref:`runtime<versioning_supported_runtimes>`.

MINOR
Backwards compatible changes to the public :ref:`interface<versioning_interfaces>`

Any backwards compatible or incompatible changes to the internal :ref:`interface<versioning_interfaces>`

Adding support for a :ref:`runtime<versioning_supported_runtimes>`

PATCH
Bug fixes that are backwards compatible

Security fixes that are backwards compatible
See our public documentation for versioning information. `public documentation <https://docs.datadoghq.com/tracing/trace_collection/compatibility/python/#releases>`_

.. _versioning_interfaces:

@@ -92,48 +29,3 @@ The definition of the **internal** interface:
Any module, function, class or attribute that is contained within an internal module is internal

Internal code may be subject to breaking changes in bug fix and minor releases.

.. _versioning_supported_runtimes:

Supported runtimes
==================


.. list-table::
:header-rows: 1

* - OS
- CPU
- Runtime
- Runtime version
- Supported Release
* - Linux
- x86-64, i686, AArch64
- CPython
- 3.7-3.13
- ``>=2.0,<3``
* - MacOS
- Intel, Apple Silicon
- CPython
- 3.7-3.13
- ``>=2.0,<3``
* - Windows
- 64bit, 32bit
- CPython
- 3.7-3.13
- ``>=2.0,<3``
* - Linux
- x86-64, i686, AArch64
- CPython
- 2.7, 3.5-3.11
- ``>=1.0,<2``
* - MacOS
- Intel, Apple Silicon
- CPython
- 2.7, 3.5-3.11
- ``>=1.0,<2``
* - Windows
- 64bit, 32bit
- CPython
- 2.7, 3.5-3.11
- ``>=1.0,<2``