Skip to content

Commit e0c2a4f

Browse files
committed
add detail to versioning docs
1 parent 225f345 commit e0c2a4f

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,19 @@ To install the latest release locally, make sure you have
2626

2727
$ pip install jupyter_server
2828

29-
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 releases and patch releases. Minor release may include API-breaking changes while patch release will never break API.
29+
### Versioning and Branches
3030

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 versions and patch versions. Different minor versions may include API-changes while patch versions do not change API.
32+
33+
Each minor version has its own branch in this repo, and patches are applied to their relevant minor version. The master branch of the latest minor version.
34+
35+
The available minor versions are:
3136
* [0.2.x](https://github.com/jupyter/jupyter_server/tree/0.2.x): Extension Application API added.
3237
* [0.3.x](https://github.com/jupyter/jupyter_server/tree/master) (master): Kernels API changed. Kernel Providers are the new way to interface with kernels.
3338

34-
To install the latest patch release of a given version:
39+
You can see which versions are released by going to the ["releases"](https://github.com/jupyter/jupyter_server/releases) tab.
40+
41+
To install the latest patch of a given version:
3542

3643
$ pip intall jupyter_server>=0.2
3744

0 commit comments

Comments
 (0)