diff --git a/RELEASE.md b/RELEASE.md index 995759f..cf06551 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -1,15 +1,12 @@ -# Making a new release of jupyter-resource-usage +# Making a new release of `jupyter-resource-usage` ## Getting a clean environment Creating a new environment can help avoid pushing local changes and any extra tag. ```bash -conda create -n jupyter-resource-usage-release -c conda-forge twine keyring jupyter-packaging python +mamba create -n jupyter-resource-usage-release -c conda-forge twine keyring jupyter-packaging=0.7 jupyterlab=3 python conda activate jupyter-resource-usage-release - -# install JupyterLab to build the extension -python -m pip install --pre jupyterlab ``` Alternatively, the local repository can be cleaned with: @@ -23,13 +20,14 @@ git clean -fdx Make sure the `dist/` folder is empty. 1. Update the version in `setup.py` -2. `python setup.py sdist bdist_wheel` -3. Double check the size of the bundles in the `dist/` folder -4. Run the tests +2. If the JupyterLab extension has changed, make sure to bump the version number in `packages/labextension/package.json` +3. `python setup.py sdist bdist_wheel` +4. Double check the size of the bundles in the `dist/` folder +5. Run the tests - `pip install "dist/jupyter-resource-usage-X.Y.Z-py3-none-any.whl[dev]"` - `python -m pytest` -5. `export TWINE_USERNAME=mypypi_username` -6. `twine upload dist/*` +6. `export TWINE_USERNAME=mypypi_username` +7. `twine upload dist/*` ## Releasing on conda-forge