Skip to content

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 028f6b1

Browse filesBrowse files
committed
Doc: Add version rule to avoid surpises
Add a new section "Release Policy" to give a recommendation. As with the upcoming major 3 release of semver, a lot of things have been changed. To avoid any surprises for our users or even break their code base, a short version restriction can solve that. This should help users who wants to stay with release 2. Basically, it boils down to a line like `semver>=2,<3`. This can be added in any file which lists dependencies.
1 parent 1f0d49b commit 028f6b1
Copy full SHA for 028f6b1

File tree

1 file changed

+25
-3
lines changed
Filter options

1 file changed

+25
-3
lines changed

‎docs/install.rst

Copy file name to clipboardExpand all lines: docs/install.rst
+25-3Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,25 @@
11
Installing semver
22
=================
33

4+
Release Policy
5+
--------------
6+
7+
As semver uses `Semantic Versioning`_, breaking changes are only introduced in major
8+
releases (incremented X in "X.Y.Z").
9+
10+
For users who want to stay with major 2 releases only, add the following version
11+
restriction::
12+
13+
semver>=2,<3
14+
15+
This line avoids surprises. You will get any updates within the major 2 release like
16+
2.9.1, 2.10.0, or above. However, you will never get an update for semver 3.0.0.
17+
18+
Keep in mind, as this line avoids any major version updates, you also will never
19+
get new exciting features or bug fixes.
20+
21+
You can add this line in your file :file:`setup.py`, :file:`requirements.txt`, or any other
22+
file that lists your dependencies.
423

524
Pip
625
---
@@ -17,12 +36,12 @@ For Python 3:
1736
1837
pip3 install semver
1938
20-
If you want to install this specific version, you can use the command :command:`pip`
21-
with an URL:
39+
If you want to install this specific version (for example, 2.10.0), use the command :command:`pip`
40+
with an URL and its version:
2241

2342
.. parsed-literal::
2443
25-
pip3 install git+https://github.com/python-semver/python-semver.git@|version|
44+
pip3 install git+https://github.com/python-semver/python-semver.git@2.10.0
2645
2746
2847
Linux Distributions
@@ -103,3 +122,6 @@ Ubuntu
103122
2. Install the package::
104123

105124
$ sudo apt-get install python3-semver
125+
126+
127+
.. _semantic versioning: http://semver.org/

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.