From b561e734fcf47c19be60f03fd79e2670fbd1f397 Mon Sep 17 00:00:00 2001 From: Steven Silvester Date: Sat, 9 May 2020 05:34:07 -0500 Subject: [PATCH] Add release instructions cleanup Add more instructions formatting cleanup formatting --- RELEASE.md | 72 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 72 insertions(+) create mode 100644 RELEASE.md diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 000000000..7739f4a31 --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,72 @@ +# Making a Release of Notebook + +## Start from a fresh git checkout and conda environment + +### Set the release branch + +```bash +export release_branch=master +``` + +### Create the git checkout + +```bash +git clone git@github.com:jupyter/notebook.git +cd notebook +git checkout ${release_banch} +``` + +### Create and activate the conda environment + +```bash +conda create -n notebook-release -c conda-forge jupyter +conda activate notebook-release +``` + +## Perform a local dev install + +```bash +pip install -ve . +``` + +## Install release dependencies + +```bash +conda install -c conda-forge nodejs babel twine +npm install -g po2json +``` + +## Update the version + +```bash +vim notebook/_version.py +git commit -am "Release $(python setup.py --version)" +git tag $(python setup.py --version) +``` + +## Create the artifacts + +```bash +rm -rf dist +python setup.py sdist +python setup.py bdist_wheel +``` + +## Upload the artifacts + +```bash +twine check dist/* && twine upload dist/* +``` + +## Change back to dev version + +```bash +vim notebook/_version.py +git commit -am "Back to dev version" +``` + +## Push the commits and tags + +```bash +git push origin ${release_branch} --tags +```