Skip to content

Doc: Add version rule to avoid surpises #249

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
merged 1 commit into from
May 13, 2020
Merged

Doc: Add version rule to avoid surpises #249

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 25 additions & 3 deletions docs/install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,25 @@
Installing semver
=================

Release Policy
--------------

As semver uses `Semantic Versioning`_, breaking changes are only introduced in major
releases (incremented X in "X.Y.Z").

For users who want to stay with major 2 releases only, add the following version
restriction::

semver>=2,<3

This line avoids surprises. You will get any updates within the major 2 release like
2.9.1, 2.10.0, or above. However, you will never get an update for semver 3.0.0.

Keep in mind, as this line avoids any major version updates, you also will never
get new exciting features or bug fixes.

You can add this line in your file :file:`setup.py`, :file:`requirements.txt`, or any other
file that lists your dependencies.

Pip
---
Expand All @@ -17,12 +36,12 @@ For Python 3:

pip3 install semver

If you want to install this specific version, you can use the command :command:`pip`
with an URL:
If you want to install this specific version (for example, 2.10.0), use the command :command:`pip`
with an URL and its version:

.. parsed-literal::

pip3 install git+https://github.com/python-semver/python-semver.git@|version|
pip3 install git+https://github.com/python-semver/python-semver.git@2.10.0


Linux Distributions
Expand Down Expand Up @@ -103,3 +122,6 @@ Ubuntu
2. Install the package::

$ sudo apt-get install python3-semver


.. _semantic versioning: http://semver.org/