Skip to content

Commit

Permalink
Add documentation of versioning/branches to main README (jupyter-serv…
Browse files Browse the repository at this point in the history
…er#163)

* update readme to explain versioning

* add detail to versioning docs

* clarify language in README on versioning and bump version
  • Loading branch information
Zsailer authored and echarles committed Jan 10, 2020
1 parent 54325dc commit 9512485
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,23 @@ 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

### 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 and patch versions. Different minor versions likely include API-changes while patch versions do not change API.

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.

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 install jupyter_server>=0.2

## Usage - Running Jupyter Server

### Running in a local installation
Expand Down
2 changes: 1 addition & 1 deletion jupyter_server/_version.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:])

0 comments on commit 9512485

Please sign in to comment.