From d13a3ce7bfb836559830ae7d160c69690eec2d0f Mon Sep 17 00:00:00 2001 From: Andrew Murray Date: Mon, 21 Dec 2020 20:45:59 +1100 Subject: [PATCH] Moved "Versioning" into "Release Notes" --- RELEASING.md | 28 +++------------------------- docs/releasenotes/index.rst | 4 +++- docs/releasenotes/versioning.rst | 30 ++++++++++++++++++++++++++++++ 3 files changed, 36 insertions(+), 26 deletions(-) create mode 100644 docs/releasenotes/versioning.rst diff --git a/RELEASING.md b/RELEASING.md index 5fe5a9b72..eb69f2699 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -1,30 +1,8 @@ -# Versioning - -Pillow follows Semantic Versioning. From https://semver.org/: - -> Given a version number MAJOR.MINOR.PATCH, increment the: -> 1. MAJOR version when you make incompatible API changes, -> 2. MINOR version when you add functionality in a backwards compatible manner, and -> 3. PATCH version when you make backwards compatible bug fixes. - -Quarterly releases (referred to as "Main Release" in the checklist below) bump at -least the MINOR version, as new functionality has likely been added in the prior three -months. - -A quarterly release bumps the MAJOR version when incompatible API changes are -made, such as removing deprecated APIs or dropping an EOL Python version. In practice, -these occur every 12-18 months, guided by [Python's EOL schedule](https://devguide.python.org/#status-of-python-branches), and any APIs that have -been deprecated for at least a year are removed at the same time. - -PATCH versions ("Point Release" or "Embargoed Release" in the checklist below) are for -security, installation or critical bug fixes. These are less common as it is preferred -to stick to quarterly releases. - -Between quarterly releases, ".dev0" is appended to the `master` branch, indicating that this is -not a formally released copy. - # Release Checklist +See https://pillow.readthedocs.io/en/stable/releasenotes/versioning.html for +information about how the version numbers line up with releases. + ## Main Release Released quarterly on January 2nd, April 1st, July 1st and October 15th. diff --git a/docs/releasenotes/index.rst b/docs/releasenotes/index.rst index 18d2d9576..cd73de814 100644 --- a/docs/releasenotes/index.rst +++ b/docs/releasenotes/index.rst @@ -3,7 +3,8 @@ Release Notes Pillow is released quarterly on January 2nd, April 1st, July 1st and October 15th. Patch releases are created if the latest release contains severe bugs, or if security -fixes are put together before a scheduled release. +fixes are put together before a scheduled release. See :ref:`versioning` for more +information. Please use the latest version of Pillow. Functionality and security fixes should not be expected to be backported to earlier versions. @@ -48,3 +49,4 @@ expected to be backported to earlier versions. 3.0.0 2.8.0 2.7.0 + versioning diff --git a/docs/releasenotes/versioning.rst b/docs/releasenotes/versioning.rst new file mode 100644 index 000000000..c69139600 --- /dev/null +++ b/docs/releasenotes/versioning.rst @@ -0,0 +1,30 @@ +.. _versioning: + +Versioning +========== + +Pillow follows Semantic Versioning. From https://semver.org/: + + Given a version number MAJOR.MINOR.PATCH, increment the: + + 1. MAJOR version when you make incompatible API changes, + 2. MINOR version when you add functionality in a backwards compatible manner, and + 3. PATCH version when you make backwards compatible bug fixes. + +Quarterly releases ("`Main Release `_") +bump at least the MINOR version, as new functionality has likely been added in the +prior three months. + +A quarterly release bumps the MAJOR version when incompatible API changes are +made, such as removing deprecated APIs or dropping an EOL Python version. In practice, +these occur every 12-18 months, guided by +`Python's EOL schedule `_, and +any APIs that have been deprecated for at least a year are removed at the same time. + +PATCH versions ("`Point Release `_" +or "`Embargoed Release `_") +are for security, installation or critical bug fixes. These are less common as it is +preferred to stick to quarterly releases. + +Between quarterly releases, ".dev0" is appended to the "master" branch, indicating that +this is not a formally released copy.