Skip to content

Commit e8f1f60

Browse files
Zsailerecharles
authored andcommitted
Add documentation of versioning/branches to main README (#163)
* update readme to explain versioning * add detail to versioning docs * clarify language in README on versioning and bump version
1 parent 45742d9 commit e8f1f60

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,23 @@ You can find the installation documentation for the
2121
The documentation for advanced usage of Jupyter notebook can be found
2222
[here](https://jupyter-server.readthedocs.io/en/latest/).
2323

24-
For a local installation, make sure you have
24+
To install the latest release locally, make sure you have
2525
[pip installed](https://pip.readthedocs.io/en/stable/installing/) and run:
2626

2727
$ pip install jupyter_server
2828

29+
### Versioning and Branches
30+
31+
If Jupyter Server is a dependency of your project/application, it is important that you pin it to a version that works for your application. Currently, Jupyter Server only has minor and patch versions. Different minor versions likely include API-changes while patch versions do not change API.
32+
33+
When a new minor version in released on PyPI, a branch for that version will be created in this repository, and the version of the master branch will be bumped to the next minor version number. That way, the master branch always reflects the latest un-released version.
34+
35+
To see the changes between releases, checkout the [CHANGELOG](https://github.com/jupyter/jupyter_server/blob/master/CHANGELOG.md).
36+
37+
To install the latest patch of a given version:
38+
39+
$ pip install jupyter_server>=0.2
40+
2941
## Usage - Running Jupyter Server
3042

3143
### Running in a local installation

jupyter_server/_version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@
99

1010
# Next beta/alpha/rc release: The version number for beta is X.Y.ZbN **without dots**.
1111

12-
version_info = (0, 2, 0, '.dev0')
12+
version_info = (0, 3, 0, '.dev')
1313
__version__ = '.'.join(map(str, version_info[:3])) + ''.join(version_info[3:])

0 commit comments

Comments
 (0)