From e5109687f2e2dce128116e590ed70100d9554c04 Mon Sep 17 00:00:00 2001 From: Zsailer Date: Fri, 3 Jan 2020 09:54:23 -0800 Subject: [PATCH 1/3] update readme to explain versioning --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2586dfa9c1..0bae57848b 100644 --- a/README.md +++ b/README.md @@ -21,11 +21,20 @@ You can find the installation documentation for the The documentation for advanced usage of Jupyter notebook can be found [here](https://jupyter-server.readthedocs.io/en/latest/). -For a local installation, make sure you have +To install the latest release locally, make sure you have [pip installed](https://pip.readthedocs.io/en/stable/installing/) and run: $ pip install jupyter_server +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. + +* [0.2.x](https://github.com/jupyter/jupyter_server/tree/0.2.x): Extension Application API added. +* [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. + +To install the latest patch release of a given version: + + $ pip intall jupyter_server>=0.2 + ## Usage - Running Jupyter Server ### Running in a local installation From 627cbccd687e7fdbd7ddc9bd8365fa2196f9b57d Mon Sep 17 00:00:00 2001 From: Zsailer Date: Fri, 3 Jan 2020 10:06:31 -0800 Subject: [PATCH 2/3] add detail to versioning docs --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0bae57848b..a84bef07d3 100644 --- a/README.md +++ b/README.md @@ -26,12 +26,19 @@ To install the latest release locally, make sure you have $ pip install jupyter_server -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. +### Versioning and Branches +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. + +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. + +The available minor versions are: * [0.2.x](https://github.com/jupyter/jupyter_server/tree/0.2.x): Extension Application API added. * [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. -To install the latest patch release of a given version: +You can see which versions are released by going to the ["releases"](https://github.com/jupyter/jupyter_server/releases) tab. + +To install the latest patch of a given version: $ pip intall jupyter_server>=0.2 From 89fe26ff1530f3225e6eebc9f63428c42620f5d6 Mon Sep 17 00:00:00 2001 From: Zsailer Date: Thu, 9 Jan 2020 13:27:23 -0800 Subject: [PATCH 3/3] clarify language in README on versioning and bump version --- README.md | 12 ++++-------- jupyter_server/_version.py | 2 +- 2 files changed, 5 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index a84bef07d3..0e3961c77a 100644 --- a/README.md +++ b/README.md @@ -28,19 +28,15 @@ To install the latest release locally, make sure you have ### Versioning and Branches -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. +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. -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. +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. -The available minor versions are: -* [0.2.x](https://github.com/jupyter/jupyter_server/tree/0.2.x): Extension Application API added. -* [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. - -You can see which versions are released by going to the ["releases"](https://github.com/jupyter/jupyter_server/releases) tab. +To see the changes between releases, checkout the [CHANGELOG](https://github.com/jupyter/jupyter_server/blob/master/CHANGELOG.md). To install the latest patch of a given version: - $ pip intall jupyter_server>=0.2 + $ pip install jupyter_server>=0.2 ## Usage - Running Jupyter Server diff --git a/jupyter_server/_version.py b/jupyter_server/_version.py index e1ca7b8e4c..5f99508428 100644 --- a/jupyter_server/_version.py +++ b/jupyter_server/_version.py @@ -9,5 +9,5 @@ # Next beta/alpha/rc release: The version number for beta is X.Y.ZbN **without dots**. -version_info = (0, 2, 0, '.dev0') +version_info = (0, 3, 0, '.dev') __version__ = '.'.join(map(str, version_info[:3])) + ''.join(version_info[3:])