RELEASE.md

Making a jupyterlab_vega release

This document guides an extension maintainer through creating and publishing a release of jupyterlab_vega. This process creates a Python source package and a Python universal wheel and uploads them to PyPI.

Update version number

Update the version number in setup.py, labextension/package.json, and nbextension/package.json.

Commit your changes, add git tag for this version, and push both commit and tag to your origin/remote repo.

Remove generated files

Remove old Javascript bundle and Python package builds:

git clean -xfd

Build the package

Build the Javascript extension bundle, then build the Python package and wheel:

bash build.js
python setup.py sdist
python setup.py bdist_wheel --universal

Upload the package

Upload the Python package and wheel with twine. See the Python documentation on package uploading for twine setup instructions and for why twine is the recommended uploading method.

twine upload dist/*