Skip to content

Commit 67dbbca

Browse files
committed
Add release docs & remove automated publish to PyPI
We can add it back later if we wish - especially once we get more packages into `contrib/`
1 parent 8f0799d commit 67dbbca

File tree

3 files changed

+88
-12
lines changed

3 files changed

+88
-12
lines changed

.travis.yml

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,4 @@ script:
77
- pip3 install pytest
88
- JUPYTER_TOKEN=secret jupyter-notebook --config=./tests/resources/jupyter_server_config.py &
99
- sleep 5
10-
- pytest
11-
12-
deploy:
13-
provider: pypi
14-
user: nbserverproxy
15-
password:
16-
secure: R06qgVAIrQ9u4D/Z7aiELMGddZypeorBFZ5sj/u0IrrGmrxGekxgV1NtWTzuTBKDHrnBKewNQTKyrwrcdDeU09Q4RgbyBmctX7u1UUQQdLSYfpbIh30SshuP57EiqGOo4wPXHOzBDtQg0SWtTVWqJAogymT0s7m3MOcFzbbVCReIX1uMFiG6X7TWKMB72WFN65rEtDa/Myq4hMvKOgcf+MWGnZzqNdaKFs+BHxfEc7MsJB6NooxQchiBqs0nJ3rfLAKblIPVdRx9ErpaUR0Z+VBuML8Hs0KCJyKh+H9POEBonPp+cVN/sOmFy39tESKhKJ5KNjfBxr/1GS9de8HeFwxwbz4/BVmbCzpXdNpRTD08JUGhia2xda4L8I/wNWGuj/SC0Y80tJ2FmauPrF9eL0AE1VGfwhCoXa4LFClBrzKyFsld0Gr4+mekxBvYrPtswPuTd1hGhhjui0DH62QxRIdQvWT7wWMzvxSH1dROQAu2OhzLKH8v/S/UnstT74wqEmPldH0R5zDVM75viKPpijv4USt0XwjgUwdIPlO1rDK/aRBIqyEb2eAI9U3f0zhGi4PImLlc9hSfXmYLT1TOgU7X/A+I1eBuMBSwg5poZICELCcEYod9wKXP3Xx91hoAksWnFAwUA9yoeu5Tmx7cSXbruIbws8EZRCeeB/ROHRU=
17-
on:
18-
tags: true
19-
repo: jupyterhub/nbserverproxy
20-
distributions: sdist bdist_wheel
10+
- pytest

docs/contributing/release.rst

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
.. _contributing/release:
2+
3+
================
4+
Making a release
5+
================
6+
7+
We should release early & often, following `semver <https://semver.org/>`_ wherever possible.
8+
9+
Packages in this repository
10+
===========================
11+
12+
This repo has more than one package.
13+
14+
#. The primary ``jupyter-server-proxy`` python package. This contains the actual proxying
15+
code, and the classic notebook extension. This is published on `PyPI <https://pypi.org>`_.
16+
17+
#. The JupyterLab plugin, ``jupyterlab-server-proxy``. This provides the launcher icons in
18+
JupyterLab.
19+
20+
#. Various python packages in ``contrib/``. These are convenience packages that help set up
21+
a particular application for use - such as RStudio or Theia.
22+
23+
We try to keep the version numbers of all these packages in sync, even when there are no
24+
changes. This keeps reasoning about versions simple.
25+
26+
Gaining Access Privileges
27+
=========================
28+
29+
Before making a release, you need access privileges for the following.
30+
31+
#. Write access to the `GitHub repo <https://github.com/jupyterhub/jupyter-server-proxy>`_.
32+
33+
#. Publish access to the various python packages on PyPI.
34+
35+
#. Publish access to the JupyterLab plugin on `NPM <https://www.npmjs.com/>`_.
36+
37+
Release checklist
38+
=================
39+
40+
#. Update the package version number in ``setup.py``.
41+
42+
#. Update the JupyterLab plugin's version to match, in ``jupyterlab-server-proxy/package.json``.
43+
We keep these two versions in sync to avoid figuring out a matrix of 'which version of
44+
the python package is compatible with which version of the JupyterLab plugin?'
45+
46+
#. Commit these changes and make a pull request with it.
47+
48+
#. Once pull request is merged, make a tag of form ``v<version-number>``:
49+
50+
.. code::
51+
52+
git tag -a v<version-number>
53+
54+
And push it to the official repository
55+
56+
.. code::
57+
58+
git push git@github.com:jupyterhub/jupyter-server-proxy --tags
59+
60+
#. Publish the package on PyPI
61+
62+
.. code::
63+
64+
pip install twine
65+
rm -rf dist/*
66+
python3 setup.py sdist bdist_wheel
67+
twine upload dist/*
68+
69+
#. Publish the JupyterLab plugin on npm
70+
71+
.. code::
72+
73+
cd jupyterlab-server-proxy
74+
npm publish
75+

docs/index.rst

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,19 @@ Contents
2828
========
2929

3030
.. toctree::
31+
:maxdepth: 2
3132

3233
install
3334
server-process
3435
launchers
35-
arbitrary-ports
36+
arbitrary-ports
37+
38+
Contributing
39+
============
40+
41+
Contributions of all kinds - documentation, issues, blog posts, code, are most welcome!
42+
43+
.. toctree::
44+
:maxdepth: 2
45+
46+
contributing/release

0 commit comments

Comments
 (0)