RELEASE.md

Making a Release of Notebook

Using jupyter_releaser

The recommended way to make a release is to use jupyter_releaser.

Manual Release Process

Start from a fresh git checkout and conda environment

Set the release branch

export release_branch=master

Create the git checkout

git clone git@github.com:jupyter/notebook.git
cd notebook
git checkout ${release_banch}

Create and activate the conda environment

conda create -n notebook-release -c conda-forge jupyter
conda activate notebook-release

Perform a local dev install

pip install -ve .

Install release dependencies

conda install -c conda-forge nodejs babel
npm install -g po2json
pip install jupyter_releaser  # used for build dependencies (build, twine, tbump)

Update the version

tbump --only-patch <new_version> # set the new version
python setup.py jsversion
git commit -am "Release $(python setup.py --version)"
git tag $(python setup.py --version)

Create the artifacts

rm -rf dist
python -m build .

Upload the artifacts

twine check dist/* && twine upload dist/*

Change back to dev version

tbump --only-patch <dev_version>  # Add the .dev suffix
python setup.py jsversion
git commit -am "Back to dev version"

Push the commits and tags

git push origin ${release_branch} --tags