diff --git a/RELEASE.md b/RELEASE.md index 0531898b9019..f5c91ebb5811 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -15,6 +15,8 @@ setup instructions and for why twine is the recommended method. ## Getting a clean environment +### Clean environment with Conda + For convenience, here are commands for getting a completely clean repo. This makes sure that we don't have any extra tags or commits in our repo (especially since we will push our tags later in the process), and that we are on the master @@ -28,13 +30,40 @@ rm -rf jupyterlab conda create -c conda-forge -y -n jlabrelease notebook nodejs twine conda activate jlabrelease -git clone git@github.com:jupyterlab/jupyterlab.git +``` + +### Clean environment with Docker + +Instead of following the conda instructions above, you can use Docker to create a new container with a fresh clone of JupyterLab. + +First, build a Docker base image. This container is customized with your git commit information. The build is cached so rebuilding it is fast and easy. + +```bash +docker build -t jlabreleaseimage release/ --build-arg "GIT_AUTHOR_NAME=`git config user.name`" --build-arg "GIT_AUTHOR_EMAIL=`git config user.email`" +``` + +Note: if you must rebuild your Docker image from scratch without the cache, you can run the same build command above with `--no-cache --pull`. + +Then run a new instance of this container: + +```bash +docker rm jlabrelease # delete any old container +docker run -it --name jlabrelease -w /usr/src/app jlabreleaseimage bash +``` + +Now you should be at a shell prompt as root inside the docker container (the prompt should be something like `root@20dcc0cdc0b4:/usr/src/app`). + +## Set up JupyterLab + +Now clone the repo and build it + +```bash +git clone https://github.com/jupyterlab/jupyterlab.git cd jupyterlab ``` Check out the branch you are doing the release from, if different from master. - -Then build and install jlpm: +Then build and install jupyterlab: ```bash pip install -ve . diff --git a/examples/cell/index.html b/examples/cell/index.html index dad7819b0908..587220dc1b74 100644 --- a/examples/cell/index.html +++ b/examples/cell/index.html @@ -5,11 +5,11 @@ - {% set page_config_full = {'baseUrl': base_url, 'token': token} %} + {% set page_config_full = {'baseUrl': base_url, 'token': token} %} - +