Upgrade extension to JupyterLab 4 #145

mahendrapaipuri · 2023-07-18T14:34:46Z

Following major changes have been made:

Migrated to hatch build system
Modernised async related stuff in handler
Bumped extension's version to 4.0.0
Migrated existing tslint.json into eslintrc.js using tslint-to-eslint-config
Added basic CI workflows

Closes #144

Use npm_builder hook to build labextension. Use nodejs version hook to manage extension's version

Migrate deprecated tslint.json to eslintrc.js. Update target in tsconfig to es2018 Lint ts src code and make changes for the src to be compatible for Jlab 4

welcome · 2023-07-18T14:34:48Z

Thanks for submitting your first pull request! You are awesome! 🤗

If you haven't done so already, check out Jupyter's Code of Conduct. Also, please make sure you followed the pull request template, as this will help us review your contribution more quickly.

You can meet the other Jovyans by joining our Discourse forum. There is also a intro thread there where you can stop by and say Hi! 👋

Welcome to the Jupyter community! 🎉

github-actions · 2023-07-18T14:34:57Z

👈 Launch a binder notebook on branch mahendrapaipuri/jupyterlab-github/upgrade_to_jlab_4

jtpio · 2023-08-01T07:04:46Z

Thanks @mahendrapaipuri for working on this!

Looks like CI was not triggered, not sure why but this also seems to be the case of the recent commits on master.

mahendrapaipuri · 2023-08-01T07:23:59Z

@jtpio You are welcome.

If we look into CI workflows, there are no "actual" workflows perse. The workflow is to create a link to binder on source branch of the PR and add it to comments.

Edit: binder config files are up to date as well

jtpio · 2023-08-01T07:26:41Z

Ah ok thanks!

Then maybe we should add the base workflows from the extension template? https://github.com/jupyterlab/extension-template

mahendrapaipuri · 2023-08-01T07:28:46Z

Fair enough. Makes sense. Do you think we can add workflows it in the current PR or create a new one?

jtpio · 2023-08-01T07:39:32Z

Here would be fine, hopefully the workflows will be triggered properly.

Add stylelint config and npm script. Add lint:check script that checks eslint, prettier and stylelint Lint css files according to stylelint config

mahendrapaipuri · 2023-08-01T09:42:52Z

@jtpio Added basic CI workflows based on what we did for topbar extensions. For release management, we will integrate it with jupyter releaser as well?

jtpio · 2023-08-01T10:57:03Z

Yes. Normally the extension template is already configured to be compatible with the releaser.

jtpio · 2023-08-01T11:37:35Z

Yes. Normally the extension template is already configured to be compatible with the releaser.

Part of supporting the Jupyter Releaser would be to add the check-releaser workflow: https://github.com/jupyterlab/extension-template/blob/main/template/.github/workflows/check-release.yml.jinja

mahendrapaipuri · 2023-08-02T07:32:08Z

@jtpio So, I was checking the check-release.yml workflow that you mentioned. If we look into the template, the check-release action it is attempting to use does not exist on jupyter_releaser actions. I was trying to understand what exactly the action check-release will do but could not find any.

So, the idea is that you will manage the releases via a forked jupyter_releaser repo or you prefer to add all release related workflows (https://github.com/jupyter-server/jupyter_releaser/tree/main/example-workflows) in the repo?

jtpio · 2023-08-02T07:55:26Z

If we look into the template, the check-release action it is attempting to use does not exist on jupyter_releaser actions.

I think it corresponds to this one: https://github.com/jupyter-server/jupyter_releaser/blob/main/.github/actions/check-release/action.yml

So, the idea is that you will manage the releases via a forked jupyter_releaser repo or you prefer to add all release related workflows (https://github.com/jupyter-server/jupyter_releaser/tree/main/example-workflows) in the repo?

The recommended and most convenient way now is to add the workflows to the repo directly to avoid having to maintain the fork. This is used in the JupyterLab repo for example (and they are also included in the extension template):

The ones that are taken from jupyter_releaser repo

jtpio · 2023-08-02T08:10:01Z

.github/workflows/check-release.yml

+
+      - name: Install Dependencies
+        run: |
+          pip install -e .


Normally we shouldn't need this as it might add side-effects, and this step does not exist during the actual release process.

Ok. Maybe we should remove it from the extension-template repo as well?

Ah if it's there then yes 👍

Yes, it is in the template. I have not changed anything from the template except replacing Jinja2 vars.

Just opened jupyterlab/extension-template#38

mahendrapaipuri · 2023-08-02T08:15:59Z

Seems like check release workflow failed due to missing CHANGELOG.md file. From the docs of jupyter_releaser, it seems like the presence of CHANGELOG.md file is not a prerequisite.

Do you think jupyter_releaser should create one if it does not exist?

jtpio · 2023-08-02T08:17:17Z

We can add an empty CHANGELOG.md for example taken from the template: https://github.com/jupyterlab/extension-template/blob/main/template/CHANGELOG.md

It is needed for check release workflow to generate a draft changelog. The workflow expects the file to exist.

jtpio · 2023-08-02T08:21:08Z

empty

We could also bootstrap a changelog using github-activity and the --all flag: https://github-activity.readthedocs.io/en/latest/index.html#generate-a-markdown-changelog

Add missing markers in the changelog file

Remove deprecated tslint related packages

mahendrapaipuri · 2023-08-02T10:26:01Z

All CI tests are passing now. Good to go for the review @jtpio

jtpio · 2023-08-02T12:54:43Z

package.json

@@ -1,6 +1,6 @@
 {
  "name": "@jupyterlab/github",
-  "version": "3.0.1",
+  "version": "4.0.0",


Should we revert the version back to 3.0.1 here for now?

When we will be making the release, we can specify 4.0.0 to the releaser. Otherwise if the version is already 4.0.0, the releaser will not allow setting the same version (4.0.0).

jupyter-releaser will take care of version bumping

jtpio

Thanks!!

welcome · 2023-08-02T13:17:07Z

Congrats on your first merged pull request in this project! 🎉

Thank you for contributing, we are very proud of you! ❤️

jtpio · 2023-08-02T13:17:21Z

Waiting for #147 to be able to do the release.

mahendrapaipuri added 4 commits July 18, 2023 16:25

Migrate to hatch build system

d56c702

Use npm_builder hook to build labextension. Use nodejs version hook to manage extension's version

Bump @jupyterlab deps to 4.0.0

76cbedc

Migrate deprecated tslint.json to eslintrc.js. Update target in tsconfig to es2018 Lint ts src code and make changes for the src to be compatible for Jlab 4

Update labextension points

f3fa22a

Update binder env in CI workflows

760f05d

mahendrapaipuri added 2 commits July 18, 2023 16:50

Ensure we can make editable builds

3bda98f

Fix build cmd for editbale installs in pyproject

d6df94f

mahendrapaipuri mentioned this pull request Jul 19, 2023

Extension Compatibility with JupyterLab 4.0 jupyterlab/jupyterlab#14590

Open

jtpio added the enhancement label Aug 1, 2023

mahendrapaipuri added 5 commits August 1, 2023 10:06

Remove "extension" suffix from extensions name

7d9513b

Remove utililies from jupyter_server rather than nb

82dd6f0

Enhance lint config

36aeba6

Add stylelint config and npm script. Add lint:check script that checks eslint, prettier and stylelint Lint css files according to stylelint config

Add basic CI workflows

0001aa0

Modernise async stuff and ensure token is defined

85d6f70

Update README file

9de7a3c

Add release related workflows

0ac79a6

The ones that are taken from jupyter_releaser repo

jtpio reviewed Aug 2, 2023

View reviewed changes

Add an empty changelog file

71a9061

It is needed for check release workflow to generate a draft changelog. The workflow expects the file to exist.

mahendrapaipuri added 2 commits August 2, 2023 10:29

Generate a changelog from github-activity

e336c2b

Add missing markers in the changelog file

Remove unnecessary step in check release workflow

56a7f4c

jtpio mentioned this pull request Aug 2, 2023

Remove pip install -e . step from the check release workflow jupyterlab/extension-template#38

Merged

mahendrapaipuri added 2 commits August 2, 2023 11:53

Remove unnecessary prepare script from package.json

bcb7e7f

Remove deprecated tslint related packages

Remove reference to tslint in eslint config

0ff432a

jtpio reviewed Aug 2, 2023

View reviewed changes

Revert version back to 3.x in package.json

b643ed5

jupyter-releaser will take care of version bumping

jtpio mentioned this pull request Aug 2, 2023

Add releaser tokens to the repo #147

Closed

jtpio approved these changes Aug 2, 2023

View reviewed changes

jtpio merged commit b711c4a into jupyterlab:master Aug 2, 2023
9 checks passed

jtpio mentioned this pull request Aug 4, 2023

Update to JupyterLab 4 and Notebook 7 jupyterlite/jupyterlite#1019

Merged

37 tasks

fcollonval mentioned this pull request Aug 15, 2023

Extensions compatibility for notebook 7 jupyter/notebook#7012

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Upgrade extension to JupyterLab 4 #145

Upgrade extension to JupyterLab 4 #145

mahendrapaipuri commented Jul 18, 2023 •

edited

Loading

welcome bot commented Jul 18, 2023

github-actions bot commented Jul 18, 2023

jtpio commented Aug 1, 2023

mahendrapaipuri commented Aug 1, 2023 •

edited

Loading

jtpio commented Aug 1, 2023

mahendrapaipuri commented Aug 1, 2023

jtpio commented Aug 1, 2023

mahendrapaipuri commented Aug 1, 2023

jtpio commented Aug 1, 2023

jtpio commented Aug 1, 2023

mahendrapaipuri commented Aug 2, 2023

jtpio commented Aug 2, 2023

jtpio Aug 2, 2023

mahendrapaipuri Aug 2, 2023

jtpio Aug 2, 2023

mahendrapaipuri Aug 2, 2023

jtpio Aug 2, 2023

mahendrapaipuri commented Aug 2, 2023

jtpio commented Aug 2, 2023

jtpio commented Aug 2, 2023

mahendrapaipuri commented Aug 2, 2023

jtpio Aug 2, 2023

mahendrapaipuri Aug 2, 2023

jtpio left a comment

welcome bot commented Aug 2, 2023

jtpio commented Aug 2, 2023

Upgrade extension to JupyterLab 4 #145

Upgrade extension to JupyterLab 4 #145

Conversation

mahendrapaipuri commented Jul 18, 2023 • edited Loading

welcome bot commented Jul 18, 2023

github-actions bot commented Jul 18, 2023

jtpio commented Aug 1, 2023

mahendrapaipuri commented Aug 1, 2023 • edited Loading

jtpio commented Aug 1, 2023

mahendrapaipuri commented Aug 1, 2023

jtpio commented Aug 1, 2023

mahendrapaipuri commented Aug 1, 2023

jtpio commented Aug 1, 2023

jtpio commented Aug 1, 2023

mahendrapaipuri commented Aug 2, 2023

jtpio commented Aug 2, 2023

jtpio Aug 2, 2023

Choose a reason for hiding this comment

mahendrapaipuri Aug 2, 2023

Choose a reason for hiding this comment

jtpio Aug 2, 2023

Choose a reason for hiding this comment

mahendrapaipuri Aug 2, 2023

Choose a reason for hiding this comment

jtpio Aug 2, 2023

Choose a reason for hiding this comment

mahendrapaipuri commented Aug 2, 2023

jtpio commented Aug 2, 2023

jtpio commented Aug 2, 2023

mahendrapaipuri commented Aug 2, 2023

jtpio Aug 2, 2023

Choose a reason for hiding this comment

mahendrapaipuri Aug 2, 2023

Choose a reason for hiding this comment

jtpio left a comment

Choose a reason for hiding this comment

welcome bot commented Aug 2, 2023

jtpio commented Aug 2, 2023

mahendrapaipuri commented Jul 18, 2023 •

edited

Loading

mahendrapaipuri commented Aug 1, 2023 •

edited

Loading