-
Notifications
You must be signed in to change notification settings - Fork 96
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Integrate additional topic that describes an high level overview about semver v2, v3, and v3 and beyond. Also revise section about "Release Policy" which is related. First mention semver3 and use semver2 later.
- Loading branch information
Showing
5 changed files
with
63 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
Clarify version policy for the different semver versions (v2, v3, >v3) | ||
and the supported Python versions. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
.. _version-policy: | ||
|
||
Version Policy | ||
============== | ||
|
||
.. |MAINT| replace:: ``maint/v2`` | ||
.. _MAINT: https://github.com/python-semver/python-semver/tree/maint/v2 | ||
.. |CHANGELOG| replace:: ``Changelog`` | ||
.. _CHANGELOG: https://github.com/python-semver/python-semver/blob/maint/v2/CHANGELOG.rst | ||
|
||
The move from v2 to v3 introduced many changes and deprecated module functions. | ||
The main functionality is handled by the :class:`~semver.version.Version` class | ||
now. Find more information in the section :ref:`semver2-to-3`. | ||
|
||
|
||
semver Version 2 | ||
---------------- | ||
|
||
Active development of major version 2 has stopped. No new features nor | ||
backports will be integrated. | ||
We recommend to upgrade your workflow to Python 3 to gain support, | ||
bugfixes, and new features. | ||
|
||
If you still need this old version, use the |MAINT|_ branch. There you | ||
can look for the |CHANGELOG|_ if you need some details about the history. | ||
|
||
|
||
semver Version 3 | ||
---------------- | ||
|
||
We will not intentionally make breaking changes in minor releases of V3. | ||
|
||
Methods marked as ``deprecated`` raise a warning message when used from the :py:mod:`warnings` module. | ||
Check section :ref:`sec_replace_deprecated_functions` to make your code | ||
ready for future major releases. | ||
|
||
|
||
semver Version 3 and beyond | ||
--------------------------- | ||
|
||
Methods that were marked as deprecated will be very likely be removed. | ||
|
||
|
||
Support for Python versions | ||
--------------------------- | ||
|
||
This project will drop support for a Python version when the | ||
following conditions are met: | ||
|
||
* The Python version has reached `EOL <https://devguide.python.org/versions/>`_. |