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 for mimerender and theme extensions breaking changes #13477

Open
jtpio opened this issue Nov 23, 2022 · 1 comment
Open

Test for mimerender and theme extensions breaking changes #13477

jtpio opened this issue Nov 23, 2022 · 1 comment
Assignees
Milestone

Comments

@jtpio
Copy link
Member

jtpio commented Nov 23, 2022

Problem

There has already been some discussions about testing for breaking changes (will add links to this issue later as needed if any).

However most of the time this requires manually checking and thinking about the implications of the proposed changes in a PR.

Ideally there could be some automated check that would help catch such changes.

Proposed Solution

Maybe the existing Galata tests could be extended to also check for third-party mimerender and theme extensions.

The main issue would be to choose such third-party extensions that are considered stable enough and maintained to be included in the automated test suite. For example using one of the extensions from https://github.com/jupyterlab/jupyter-renderers. For the theme maybe there could be a "semi-official" one under the jupyterlab organization (or generated from https://github.com/jupyterlab/extension-cookiecutter-ts).

The alternative is to remember to test with such third-party extensions during the JupyterLab alpha cycle to catch potential issues early.

Additional context

Linking to #13461 as an example of an unintentional breaking change for third-party theme extensions.

Also linking to #12581 which unbumped the major version of rendermime-interfaces to avoid extension authors to manually update their extension for JupyterLab 4.0.

@jtpio jtpio added enhancement status:Needs Triage Applied to new issues that need triage labels Nov 23, 2022
@jtpio jtpio added this to the 4.0.0 milestone Nov 23, 2022
@jtpio
Copy link
Member Author

jtpio commented Nov 23, 2022

Adding to the 4.0 milestone for consideration (although not blocking)

@JasonWeill JasonWeill removed the status:Needs Triage Applied to new issues that need triage label Dec 1, 2022
@JasonWeill JasonWeill modified the milestones: 4.0.0, 4.1.0 Feb 1, 2023
@fcollonval fcollonval modified the milestones: 4.1.0, 4.0.0 Feb 2, 2023
@jtpio jtpio modified the milestones: 4.0.0, 4.0.x May 15, 2023
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

4 participants