This document guides a contributor through creating a release of JupyterLab.
Review CONTRIBUTING.md
. Make sure all the tools needed to generate the
built JavaScript files are properly installed.
You can remove all non-tracked files with:
git clean -xfdi
This would ask you for confirmation before removing all untracked files. Make
sure the dist/
folder is clean and avoid stale build from
previous attempts.
We publish the npm packages, a Python source package, and a Python universal binary wheel. We also publish a conda package on conda-forge (see below). See the Python docs on package uploading for twine setup instructions and for why twine is the recommended method.
The command below ensures the latest dependencies and built files,
then prompts you to select package versions. When one package has an
effective major release, the packages that depend on it should also get a
major release, to prevent consumers that are using the ^
semver
requirement from getting a conflict.
npm run publish
- Update
jupyterlab/_version.py
with anrc
version - Prep the static assets for release:
cd jupyterlab && npm run publish && cd ..
- Commit and tag and push the tag
- Create the python release artifacts:
rm -rf dist
python setup.py sdist
python setup.py bdist_wheel --universal
twine upload dist/*
- Test the
rc
in a clean environment - Make sure the CI builds pass
- The build will fail if we publish a new package because by default it is
private. Use
npm access public @jupyterlab/<name>
to make it public. - The build will fail if we forget to include
style/
in thefiles:
of a package (it will fail on thejupyter lab build
command because webpack cannot find the referenced styles to import.
- The build will fail if we publish a new package because by default it is
private. Use
- Update
jupyterlab/_version.py
with a final version - Make another Python release
- Get the sha256 hash for conda-forge release:
shasum -a 256 dist/*.tar.gz
- Fork https://github.com/conda-forge/jupyterlab-feedstock
- Create a PR with the version bump
- Update
recipe/meta.yaml
with the new version and md5 and reset the build number to 0.