Release 0.35

[blink1073]

We plan to release 0.35rc on Friday 28 September, Final on Friday 5 October.

• Create a pre-release with jlpm run prerelease
• Update the roadmap (Update JupyterLab roadmap jupyter/roadmap#44)
• Create release notes (Release highlights. #5417)
• Test the rc in a clean environment
• Make sure the CI builds pass
• 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

• Update the other repos:
  • https://github.com/jupyterlab/extension-cookiecutter-js (not needed?)
  • Update to jlab 0.35 and typescript 3.1.1 extension-cookiecutter-ts#41
  • https://github.com/jupyterlab/mimerender-cookiecutter (not updated anymore?)
  • https://github.com/jupyterlab/mimerender-cookiecutter-ts (not needed)
  • Update for JupyterLab 0.35 jupyter-renderers#162
  • Update for jlab 0.35 jupyterhub/jupyterlab-hub#75
  • also JLab 0.35 update jupyterlab-toc#58, Update for JupyterLab 0.35 prerelease jupyterlab-celltags#173, Update for jlab 0.35 prerelease. jupyterlab-statusbar#105
• Add a tag to extension-cookiecutter-ts with the new JupyterLab version
• Update the extension examples:
  • https://github.com/jupyterlab/jupyterlab/blob/master/docs/source/developer/notebook.rst#adding-a-button-to-the-toolbar - works with no changes!
• Update the xkcd 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.
• Publish the final (not prerelease) JavaScript packages using jlpm run publish:next at some point.

Now do the actual final release:

• Update jupyterlab/_version.py with a final version
• Make a final Python release
• Merge the PRs on the other repos and set the default branch of the
  xckd repo
• Update the latest npm tags by running jlpm run update:dist-tags and running the commands it prints out
• Publish to conda-forge (wait for the auto-bot)

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

• Create a branch for the release and push to GitHub
• Update jupyterlab/_version.py with a dev version
• Run jlpm integrity to update the dev_mode version
• Commit and push the version update to master
• Release the other repos as appropriate
• Update version for binder (see below)

[dhirschfeld]

Will this require that all extensions also be updated or will the currently published extensions continue to work with 0.35? If the former I might pin my JupyterLab until all the extensions have had time to make the necessary changes.

[jasongrout]

It depends on the extension. ipywidgets extensions (bqplot, ipyleaflet, ipyvolume, etc.) likely will continue to work. Rendermime extensions and theme extensions may continue to work. Extensions that depend on more core packages will likely need to be updated.

[blink1073]

Initial hack at a change log (thanks @goanpeca and @ccordoba12!):

$ loghub jupyterlab/jupyterlab -m 0.35 -t $GITHUB_TOKEN

LOGHUB: Querying issues for milestone 0.35

###############################################################################

Version 0.35 (2018/09/28)

Issues Closed

• Issue 5397 - JupyterLab clean fails (PR 5400)
• Issue 5393 - Menu bar visible during splash screen (PR 5396)
• Issue 5349 - Dark scheme: Improve code completion dropbox selector contrast (PR 5364)
• Issue 5307 - RTD is broken (PR 5359)
• Issue 5225 - jupyter lab build fails in webpack install (PR 5351)

In this release 5 issues were closed.

Pull Requests Merged

• PR 5403 - Tweak the dark splash screen to be a bit darker.
• PR 5400 - Handle rmtree errors (5397)
• PR 5396 - Fix browser test (5393)
• PR 5391 - Make persist and save use save enabled
• PR 5390 - Use the current filebrowser for several commands.
• PR 5383 - decode url link targets (5153)
• PR 5377 - "go to line" action in text editor
• PR 5376 - [master] adding 'writable' checks to some of the menu and toolbar options
• PR 5370 - NotebookWidgetFactory add toolbarItems option (NotebookWidgetFactory can set default toolbar #5363) (5363)
• PR 5364 - Fix issue Dark scheme: Improve code completion dropbox selector contrast #5349 by using a darker color as background when row selected (5349)
• PR 5361 - Reinstate link checks
• PR 5360 - Use TypeScript 3.1
• PR 5359 - Remove sphinx pin (5356, 5307)
• PR 5357 - Fix TypeError when canceling file renaming dialog
• PR 5351 - Build Cleanup (5275, 5225)
• PR 5347 - Switch left right panel (5054, 3707)
• PR 5344 - Prevent focus loss on mouseout for input elements inside toolbar
• PR 5342 - Fix Vega-Embed version
• PR 5339 - Add a new optional splash screen parameter to show a light or dark splash screen. (5338)
• PR 5335 - Add github templates
• PR 5328 - Prevent focus loss on input elements inside toolbar.
• PR 5321 - Track file path (4435)
• PR 5316 - Fix the examples, migrate to jupyterlab_server
• PR 5310 - Publish public packages with access public (2463)
• PR 5304 - Dark csv viewer (3456)
• PR 5301 - Don't force table alignment. (3180)
• PR 5297 - Fix syntax highlighting for markdown lists. (2741)
• PR 5296 - Add links to the community guides
• PR 5291 - expand JupyterLab.IOptions to allow for custom DocumentRegistry, CommandLinker, ServiceManager to be passed into app
• PR 5289 - @jupyterlab/buildutils v0.10.2
• PR 5288 - Rename package.json to package.json.orig when copying schemas.
• PR 5278 - Allow for disabled toolbar buttons
• PR 5268 - Show Palette Shortcut
• PR 5267 - Add npm executables to buildUtils
• PR 5262 - Update lerna
• PR 5260 - Fix Kernel names cut off in kernel selector dialog #5181: Remove maxlength so as to not cut off kernel name in kernel selector dialog. (5181)
• PR 5259 - Move Mathjax2 typesetter to library package (5257)
• PR 5251 - Use Jest for Services Tests
• PR 5247 - Allow other files to Open With -> Notebook (4924)
• PR 5245 - add sidebar min-width css variable
• PR 5237 - Ignore false Errno 5 on NFS (5233)
• PR 5232 - Makes matplotlib figs with dark text legible in the dark theme (and related fixes)
• PR 5226 - Add exit entry to File menu
• PR 5224 - Await pending directory change in filebrowser model.
• PR 5217 - adding nbconvert to services and using to load exporter list from nbconvert
• PR 5193 - Prevent multiple files of the same path from being opened
• PR 5186 - Update one typo
• PR 5184 - Switch xkcd to jlpm and remove inline conda instructions
• PR 5166 - Workspaces CLI
• PR 5147 - Extensions manager results sections (5042)

In this release 50 pull requests were closed.

###############################################################################

[ccordoba12]

It looks really nice! Glad to know you decided to use loghub to generate the Changelogs for JLab.

[blink1073]

0.35.0rc2 is released. That was a battle. I switched laptops (and OSes) this week...

[jasongrout]

Thank you!

[blink1073]

Note to self, use this template (will be part of a follow-up PR with changes to the release instructions):

`v0.xx.0 <https://github.com/jupyterlab/jupyterlab/releases/tag/v0.xx.0>`__
---------------------------------------------------------------------------

{{ close_date }}
^^^^^^^^^^^^^^^

See the `JupyterLab
0.xx.0 <https://github.com/jupyterlab/jupyterlab/milestone/xx?closed=1>`__
milestone on GitHub for the full list of pull requests and issues closed.

{%   for pr in pull_requests -%}
* {{ pr['title']|title }} (`#{{ pr['number'] }} <{{pr['html_url']}}>`__)
{%   endfor %}

[jasongrout]

From Gitter, about generating that issue list in markdown:

@blink1073
I posted the template and the invocation in the issue
Relies on pip install loghub
And assigning a GH token to $GH_TOKEN

[jasongrout]

I added a tweaked version of that log template in #5417.

[jasongrout]

There were lots of what seemed to be spurious build failures. So I merged in the PRs that seemed reasonable, and am now checking the tests on master.

[jasongrout]

I just published the final js versions to npm under the next tag.

[jasongrout]

Update: there's one PR open with xkcd tutorial update instructions, and another PR open to try to fix some of the travis errors we're seeing.

[blink1073]

Update: 0.35 final is released on PyPI, conda-forge pending: conda-forge/jupyterlab-feedstock#143

[blink1073]

Are we ready to complete this checklist with a 0.35.1 release that includes only #5445?

[blink1073]

I plan to finish this up tomorrow morning with all PRs merged to 0.35 unless I hear otherwise.

[blink1073]

I'm not able to release packages to npm on my machine do to an EPERM error. I'm at a loss about how to address it, tried several things. I might set up a VM tomorrow and try again.

[jasongrout]

Weird. Do you want me to release the packages?

[blink1073]

No, I'd like to see if I can do it using WSL, fun experiment. 😉

[blink1073]

npm packages are released, but I can't finish the 0.35.1 release until I switch to Linux. I give up trying to do OSS on Windows...

[vidartf]

I give up trying to do OSS on Windows...

Catch 22: It's hard to do OSS on Windows because the OSS tools that you use doesn't work on Windows 😓

[blink1073]

I tried really hard to use it for the past two weeks. I have spent the entire time fighting with the OS and accomplished hardly any work. Python development is reasonable, but until Microsoft steps in and helps with node development it is nigh impossible...

[dhirschfeld]

As a Windows user that doesn't bode well! 😬

Any tips for what to watch out for / what doesn't work well?
I know I've found working on the frontend stuff a bit tough but I thought that was just my inexperience.

[blink1073]

For daily usage, the only real show-stopper is the path length limitation, if you are using an administered computer and can't change the registry setting to remove the restriction. Here is a handy guide from Microsoft.

For JupyterLab maintenance, I was consistently bumping against the mishandling of symlinks.

• If you run git clean -dfx on the root JupyterLab directory, it recursively deletes about 1000 files in your repo, cf git clean removes content of symlinks git-for-windows/git#607. Even with our workaround I was getting errors running our build utility scripts.
• npm login credentials were not honoured when running npm publish using execSync, and the error that we get is misleading (cf npm publish fails with EPERM: operation not permitted, unlink -4048 npm/npm#17997)
• The "linking" stage of install is instantaneous on Linux on my machine and takes minutes on Windows.

About 5 years ago Microsoft stepped in and helped with the Windows build situation in Python, helping to decouple the Python version from the required MSVC runtime. I think a similar level of effort would be required to address these pain points.

[blink1073]

All actions complete.