Timeline

We released JupyterLab 3.0 on 24 Dec 2020. The changelog is in the documentation.

Major features

We want major features in 3.0 to entice users to upgrade.

• [@blink1073, @jasongrout] Extension system rework, allowing extensions to be installed without rebuilding JupyterLab: Extension Development Wishlist #7468 Project Board
• [@blink1073, @goanpeca, @afshin] Internationalization: Internationalization and localization #3965 PR: Localize strings in JLab #8800 (PR)
• [@Zsailer, @blink1073, @echarles] Jupyter server is the underlying server implementation: JupyterLab as Server Extension #7416
  • The changelog entry for this should highlight that it should be a dropin replacement with some deprecation warnings, and to please report otherwise.
• [@Zsailer, @blink1073] JupyterHub integration - need to bring back labhubapp: Doc change of labhubapp back to jupyterhub-singleuser #8356. Bring back the labhub entry point #8704 Reinstate the labhubapp #8806 (PR)
• [@marthacryan, @ajbozarth] Table of Contents extension: Merge ToC Extension into core #8538
• [@ellisonbg, @afshin ] Single document mode enhancements: Proposal: master plan for single document mode #8567 Improved URL scheme, state, interactions for single document mode #8715 (PR)
• [@afshin, @jtpio] Put debugger in core: Add JupyterLab debugger to core #8747
• [@echarles] Replace usage of insensitive terms : Replace usage of insensitive terms #8533
• [@blink1073] Use json5 for settings Change JSON5 payload to JSON payload #8225

Some other possibilities included (deferred):

• Remove content factory pattern: Remove content factory pattern #8266
• Accessibility: Accessibility Enhancements lumino#81, Accessibility audit #911
• UI refresh (for example, reimagining how notebook tools are accessed in a notebook document)

Known Breaking API Changes

• The semantics of dynamic extensions will be different from regular extensions
• Url semantics will change due to single document mode
• Upgrade from TS 3.7 -> 3.9 affects typing APIs
• Many APIs take an optional ITranslator object

Checklist

Beta

• Update extension guide to use module federation
• Update dependencies in various package.json files and refresh the yarn.lock to pull in latest versions

Release checklist

• Document in changelog that the property inspector moved to the right sidebar. I spent a long time looking for it, and trying to figure out why it wasn't activating in the code, before I discovered that it's on the right sidebar now.

• Release jupyterlab_server 2.0 final

• Blog Post: https://blog.jupyter.org/jupyterlab-3-0-is-out-4f58385e25bb

• Modify and run python scripts/milestone_check.py to check the issues assigned to this milestone

• Write release highlights, starting with:

  loghub jupyterlab/jupyterlab -m XXX -t $GITHUB_TOKEN --template scripts/release_template.txt

• Test the release candidate in a clean environment

• Make sure the CI builds pass

  • The build will fail if we publish a new package because by default it is
    private. Use npm access public @jupyterlab/<name> to make it public.
  • The build will fail if we forget to include style/ in the files:
    of a package (it will fail on the jupyter lab build command because
    webpack cannot find the referenced styles to import.

• Update the other repos:

  • https://github.com/jupyterlab/extension-cookiecutter-js (this should be compatible with jlab 3 as-is, but we should also move it to a prebuilt extension) - Switch to the new extension distribution system extension-cookiecutter-js#33
  • https://github.com/jupyterlab/extension-cookiecutter-ts
  • https://github.com/jupyterlab/mimerender-cookiecutter - this repo was archived. Are we not updating it anymore?
  • https://github.com/jupyterlab/mimerender-cookiecutter-ts
  • https://github.com/jupyterlab/theme-cookiecutter - JupyterLab 3 update theme-cookiecutter#19
  • https://github.com/jupyterlab/jupyter-renderers - Update for JLab 3 jupyter-renderers#233

• Add a tag to ts cookiecutter with the new JupyterLab version

• Update the extension examples:

  • Merge 3.0 -> master: Merge 3.0 -> master extension-examples#137
  • Notebook toolbar button

• Update the extension tutorial

• At this point, there may have been some more commits merged. Run python scripts/milestone_check.py to check the issues assigned to this milestone one more time. Update changelog if necessary.

Now do the actual final release:

• Run jlpm run bumpversion release to switch to final release

• Push the commit and tags to master

• Run npm run publish:all to publish the packages

• Create a branch for the release and push to GitHub

• Update the API docs

• Set the default branch of the APOD repo.

• Publish to conda-forge.

After a few days (to allow for possible patch releases), set up development for
the next release:

• Run jlpm run bumpversion minor to bump to alpha for the next alpha release
• Put the commit and tags to master
• Run npm run publish:all to publish the packages
• Release the other repos as appropriate
• Update version for binder
  • JupyterLab 3.0 Strategy: JupyterLab 3.0 strategy jupyterhub/repo2docker#935
  • PR: Update to JupyterLab 3.0 jupyterhub/repo2docker#996