Selaa lähdekoodia

Update release notes

Steven Silvester 7 vuotta sitten
vanhempi
commit
faaa099a2a
1 muutettua tiedostoa jossa 39 lisäystä ja 26 poistoa
  1. 39 26
      RELEASE.md

+ 39 - 26
RELEASE.md

@@ -1,17 +1,14 @@
 
-Making a JupyterLab release
-===========================
+# Making a JupyterLab release
 
 This document guides a contributor through creating a release of JupyterLab.
 
-Check installed tools
----------------------
+## Check installed tools
 
 Review ``CONTRIBUTING.md``. Make sure all the tools needed to generate the
 built JavaScript files are properly installed.
 
-Clean the repository
---------------------
+## Clean the repository
 
 You can remove all non-tracked files with:
 
@@ -23,45 +20,61 @@ 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.
 
-Create the release
-------------------
+## Create the release
 
 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](https://packaging.python.org/guides/tool-recommendations/)
 for twine setup instructions and for why twine is the recommended method.
 
+### Publish the npm packages
+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.
+
+```bash
+npm run publish
+```
+
+### Publish the python package
+
+- Update `jupyterlab/_version.py` with an `rc` version
+- Prep the static assets for release:
+
 ```bash
-# this ensures the latest builds of everything,
-# 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.
-#
-# Publish the npm packages:
-npm run publish  
-# Update jupyterlab/_version.py with an rc version
-# Prep the static assets for release:
 cd jupyterlab && npm run publish && cd ..
-# Commit and tag and push the tag
+```
+
+- Commit and tag and push the tag
+- Create the python release artifacts:
+
+```bash
 rm -rf dist
 python setup.py sdist
 python setup.py bdist_wheel --universal
 twine upload dist/*
-# Test the rc in a clean environment and make sure the CI builds pass
-# Update jupyterlab/_version.py with a final version and make another Python
-# release
-shasum -a 256 dist/*.tar.gz  # get the sha256 hash for conda-forge install
 ```
 
-Publish on conda-forge
+- Test the `rc` in a clean environment 
+- Make sure the CI builds pass
+- Update `jupyterlab/_version.py` with a final version 
+- Make another Python release
+- Get the sha256 hash for conda-forge release:
+
+```bash
+shasum -a 256 dist/*.tar.gz
+```
 
+### Publish to conda-forge
 - 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.
 
-Update the cookie cutters
+### Update the cookie cutters as necessary
 - Update https://github.com/jupyterlab/extension-cookiecutter-js
 - Update https://github.com/jupyterlab/extension-cookiecutter-ts
+- Update https://github.com/jupyterlab/mimerender-cookiecutter
 
-Update the extension example in the notebook docs:
+### Update the extension examples
 - https://github.com/jupyterlab/jupyterlab/blob/master/docs/notebook.md#adding-a-button-to-the-toolbar