Skip to content

Added versioning documentation #5117

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.

Sign up for GitHub

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
radarhere merged 6 commits into from
Dec 21, 2020
Merged

Added versioning documentation #5117

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
967d214
Added versioning documentation [ci skip]
radarhere Dec 21, 2020
3583453
Fixed wording [ci skip]
radarhere Dec 21, 2020
cf26a10
Added link [ci skip]
radarhere Dec 21, 2020
a0f8004
Specify branch [ci skip]
radarhere Dec 21, 2020
d13a3ce
Moved "Versioning" into "Release Notes"
radarhere Dec 21, 2020
1777aad
Reformatted link [ci skip]
radarhere Dec 21, 2020
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: 3 additions & 0 deletions RELEASING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# 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.
Expand Down
4 changes: 3 additions & 1 deletion docs/releasenotes/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -48,3 +49,4 @@ expected to be backported to earlier versions.
3.0.0
2.8.0
2.7.0
versioning
30 changes: 30 additions & 0 deletions docs/releasenotes/versioning.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
.. _versioning:

Versioning
==========

Pillow follows [Semantic Versioning](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 <https://github.com/python-pillow/Pillow/blob/master/RELEASING.md#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 <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 <https://github.com/python-pillow/Pillow/blob/master/RELEASING.md#point-release>`_"
or "`Embargoed Release <https://github.com/python-pillow/Pillow/blob/master/RELEASING.md#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.