Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Test Notebook 7 on CI #16119

Open
jtpio opened this issue Apr 5, 2024 · 1 comment
Open

Test Notebook 7 on CI #16119

jtpio opened this issue Apr 5, 2024 · 1 comment

Comments

@jtpio
Copy link
Member

jtpio commented Apr 5, 2024

As a JupyterLab-based application, Notebook 7 is currently being developed in https://github.com/jupyter/notebook.

Notebook 7 depends on some of the core @jupyterlab extensions and plugins (but not all), and reassembles them in a different way to produce a Jupyter Frontend similar to what the Classic Notebook has been offering for many years.

However since it's a separate application, changes in JupyterLab must first be released before they can be integrated in Notebook 7. Often this is fine and updating to the latest @jupyterlab works without too much effort.

However sometimes changes in JupyterLab may end up affecting Notebook 7 later on. Here are some examples that were the result of back and forth between lab and notebook:

Because Jupyter Notebook is an official Jupyter Frontend, it could be interesting to have a way to test changes that land in JupyterLab and see how they may affect downstream applications, and more precisely Notebook 7.

Some ideas:

  • add a CI workflow on the JupyterLab repo to check if a PR would work with Notebook 7
  • tests could be UI tests (or the Notebook 7 UI tests directly), just to get an idea if something might be wrong and worth looking at in a PR
  • use yalc or similar to link JupyterLab packages in Notebook before building Notebook
  • trigger the check only on-demand? (like for the benchmarks)

The main drawback of this approach would be added CI complexity and possibly extra maintenance effort. Also sometimes the tests will be expected to fail when something visual changes, and a new plugin is added.

It might also be worth taking some inspiration from jupyak, which allows testing PRs from various Jupyter repos.

@jupyterlab-probot jupyterlab-probot bot added the status:Needs Triage Applied to new issues that need triage label Apr 5, 2024
@RRosio RRosio added maintenance and removed status:Needs Triage Applied to new issues that need triage labels Apr 10, 2024
@krassowski
Copy link
Member

Canary testing with a single or two snapshots sounds good for me. Running all UI tests may be annoying.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants