Discussion about the release process

I was interested in getting a release of the NPM package containing #174, so I figured I’ll look into this a bit.

References

• JupyterLab extension / NPM package: https://www.npmjs.com/package/@jupyterlab/server-proxy
• PyPI package: https://pypi.org/project/jupyter-server-proxy/
• Release instructions: https://jupyter-server-proxy.readthedocs.io/en/latest/contributing/release.html

Discussion

1. Do we want to maintain a changelog?

2. We try to keep the version numbers of all these packages in sync, even when there are no changes. This keeps reasoning about versions simple.

   Currently, the NPM Package is 2.0.0 and 4 months old, while the python package is 1.2.0 and 2-3 months old. What should we do on the next release?

3. Automatic deployment to PyPI on git tag pushes - is it okay for me to setup that? I have created travis PYPI_PASSWORD environment variables holding a PyPI deployment token for individual PyPI packages managed by the jupyterhub-bot PyPI account. I would like to do the same for this project. I would need to get the PyPI user jupyterhub-bot added as a PyPI package maintainer at https://pypi.org/project/jupyter-server-proxy/ to be able to do that.

4. I learned recently about python -m jupyterlab.browser_check, it may be useful in order to do some minimalistic test of the jupyterlab extension, it was used here: https://github.com/bokeh/jupyter_bokeh/blob/master/.travis.yml. The browser_check is meant to ensure jupyterlab can startup without errors, as I figured out from the scripts docstring: https://github.com/jupyterlab/jupyterlab/blob/master/jupyterlab/browser_check.py.

[manics]

Should we create a jupyterhub-bot npm user just for Travis deploys?

[consideRatio]

@ryanlovett I released npm package 2.1.0 now. i made it 2.1.0 rather than 2.0.2 since i saw quite a few commits and guessed that was appropriate.

Release guide

1. installed node/npm
2. cd jupyterlab-server-proxy
3. npm login -> npm install -> npm publish