Skip to content

Commit c552a59

Browse files
committed
Clarify version policy for semver
1 parent 9391f8a commit c552a59

File tree

3 files changed

+48
-13
lines changed

3 files changed

+48
-13
lines changed

README.rst

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,8 @@ A Python module to simplify `semantic versioning`_.
1212
1313
.. note::
1414

15-
This project works for Python 3.7 and greater only. If you are
16-
looking for a compatible version for Python 2, use the
17-
maintenance branch |MAINT|_.
18-
19-
The last version of semver which supports Python 2.7 to 3.5 will be
20-
2.x.y However, keep in mind, the major 2 release is frozen: no new
21-
features nor backports will be integrated.
22-
23-
We recommend to upgrade your workflow to Python 3 to gain support,
24-
bugfixes, and new features.
25-
26-
.. |MAINT| replace:: ``maint/v2``
27-
.. _MAINT: https://github.com/python-semver/python-semver/tree/maint/v2
15+
This project works for Python 3.7 and greater only.
16+
Refer to :ref:`version-policy` for more details.
2817

2918

3019
The module follows the ``MAJOR.MINOR.PATCH`` style:

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Semver |version| -- Semantic Versioning
1212

1313
build-semver
1414
install
15+
version-policy
1516
usage/index
1617
migration/index
1718
advanced/index

docs/version-policy.rst

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
.. _version-policy:
2+
3+
Version Policy
4+
==============
5+
6+
.. |MAINT| replace:: ``maint/v2``
7+
.. _MAINT: https://github.com/python-semver/python-semver/tree/maint/v2
8+
.. |CHANGELOG| replace:: ``Changelog``
9+
.. _CHANGELOG: https://github.com/python-semver/python-semver/blob/maint/v2/CHANGELOG.rst
10+
11+
12+
semver v2
13+
---------
14+
15+
Active development of major version 2 has stopped. No new features nor
16+
backports will be integrated.
17+
We recommend to upgrade your workflow to Python 3 to gain support,
18+
bugfixes, and new features.
19+
20+
If you still need this old version, use the |MAINT|_ branch.
21+
22+
Refer to the |CHANGELOG|_ if you need some details.
23+
24+
25+
semver v3
26+
---------
27+
28+
We will not intentionally make breaking changes in minor releases of V3.
29+
30+
Methods marked as ``deprecated`` and raise a warning when used.
31+
32+
33+
semver v3 and beyond
34+
--------------------
35+
36+
Methods that were marked as deprecated will be very likely be removed.
37+
38+
39+
Support for Python versions
40+
---------------------------
41+
42+
This project will drop support for a Python version when the
43+
following conditions are met:
44+
45+
* The Python version has reached `EOL <https://devguide.python.org/versions/>`_.

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy