Merge pull request #85 from QuantStack/migrateV4

Migrate to JupyterLab 4

Author: DenisaCG

.eslintignore

@@ -33,3 +33,5 @@ setup.py
 tsconfig.eslint.json
 tsconfig.json
 yarn.lock
+.yarn.yml
+webpack.config.js

.github/workflows/build.yml

@@ -9,60 +9,79 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
+
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     - name: Base Setup
       uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
 
     - name: Install dependencies
-      run: python -m pip install -U jupyterlab~=3.4
-
-    - name: Build the extension
+      run: python -m pip install -U "jupyterlab>=4.0.0,<5"
+    
+    - name: Lint the extension
       run: |
         set -eux
         jlpm
         jlpm eslint:check
+
+    - name: Build the extension
+      run: |
+        set -eux
         python -m pip install .
 
         jupyter labextension list
         jupyter labextension list 2>&1 | grep -ie "jupyterlab-blockly-extension.*OK"
         python -m jupyterlab.browser_check
+    
+    - name: Package the extension
+      run: |
+        set -eux
 
         pip install build
-        python -m build --sdist
-        cp dist/*.tar.gz myextension.tar.gz
+        python -m build
         pip uninstall -y "jupyterlab_blockly" jupyterlab
-        rm -rf myextension
 
-    - uses: actions/upload-artifact@v2
+    - name: Upload extension packages
+      uses: actions/upload-artifact@v3
       with:
-        name: myextension-sdist
-        path: myextension.tar.gz
+        name: extension-artifacts
+        path: dist/jupyterlab_blockly*
+        if-no-files-found: error
 
   test_isolated:
     needs: build
     runs-on: ubuntu-latest
 
     steps:
-    - name: Checkout
-      uses: actions/checkout@v2
     - name: Install Python
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
-        python-version: '3.8'
+        python-version: '3.9'
         architecture: 'x64'
-    - uses: actions/download-artifact@v2
+    - uses: actions/download-artifact@v3
       with:
-        name: myextension-sdist
+        name: extension-artifacts
     - name: Install and Test
       run: |
         set -eux
         # Remove NodeJS, twice to take care of system and locally installed node versions.
         sudo rm -rf $(which node)
         sudo rm -rf $(which node)
-        pip install myextension.tar.gz
-        pip install jupyterlab
-        jupyter labextension list 2>&1 | grep -ie "jupyterlab-blockly-extension.*OK"
+
+        pip install "jupyterlab>=4.0.0,<5" jupyterlab_blockly*.whl
+
+
+        jupyter labextension list
+        jupyter labextension list 2>&1 | grep -ie "jupyterlab-blockly.*OK"
         python -m jupyterlab.browser_check --no-browser-test
+
+  check_links:
+    name: Check Links
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    steps:
+      - uses: actions/checkout@v3
+      - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
+      - uses: jupyterlab/maintainer-tools/.github/actions/check-links@v1

.github/workflows/check-release.yml

@@ -26,6 +26,6 @@ jobs:
       - name: Upload Distributions
         uses: actions/upload-artifact@v3
         with:
-          name: jupyter-releaser-dist-${{ github.run_number }}
+          name: jupyterlab_blockly-releaser-dist-${{ github.run_number }}
           path: |
             .jupyter_releaser_checkout/dist

.github/workflows/enforce-label.yml

@@ -0,0 +1,13 @@
+name: Enforce PR label
+
+on:
+  pull_request:
+    types: [labeled, unlabeled, opened, edited, synchronize]
+jobs:
+  enforce-label:
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+    steps:
+      - name: enforce-triage-label
+        uses: jupyterlab/maintainer-tools/.github/actions/enforce-label@v1

.github/workflows/prep-release.yml

@@ -0,0 +1,41 @@
+name: "Step 1: Prep Release"
+on:
+  workflow_dispatch:
+    inputs:
+      version_spec:
+        description: "New Version Specifier"
+        default: "next"
+        required: false
+      branch:
+        description: "The branch to target"
+        required: false
+      post_version_spec:
+        description: "Post Version Specifier"
+        required: false
+      since:
+        description: "Use PRs with activity since this date or git reference"
+        required: false
+      since_last_stable:
+        description: "Use PRs with activity since the last stable git tag"
+        required: false
+        type: boolean
+jobs:
+  prep_release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
+
+      - name: Prep Release
+        id: prep-release
+        uses: jupyter-server/jupyter_releaser/.github/actions/prep-release@v2
+        with:
+          token: ${{ secrets.ADMIN_GITHUB_TOKEN }}
+          version_spec: ${{ github.event.inputs.version_spec }}
+          post_version_spec: ${{ github.event.inputs.post_version_spec }}
+          branch: ${{ github.event.inputs.branch }}
+          since: ${{ github.event.inputs.since }}
+          since_last_stable: ${{ github.event.inputs.since_last_stable }}
+
+      - name: "** Next Step **"
+        run: |
+          echo "Optional): Review Draft Release: ${{ steps.prep-release.outputs.release_url }}"

.github/workflows/publish-release.yml

@@ -0,0 +1,57 @@
+name: "Step 2: Publish Release"
+on:
+  workflow_dispatch:
+    inputs:
+      branch:
+        description: "The target branch"
+        required: false
+      release_url:
+        description: "The URL of the draft GitHub release"
+        required: false
+      steps_to_skip:
+        description: "Comma separated list of steps to skip"
+        required: false
+
+jobs:
+  publish_release:
+    runs-on: ubuntu-latest
+    permissions:
+      # This is useful if you want to use PyPI trusted publisher
+      # and NPM provenance
+      id-token: write
+    steps:
+      - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
+
+      - name: Populate Release
+        id: populate-release
+        uses: jupyter-server/jupyter_releaser/.github/actions/populate-release@v2
+        with:
+          token: ${{ secrets.ADMIN_GITHUB_TOKEN }}
+          branch: ${{ github.event.inputs.branch }}
+          release_url: ${{ github.event.inputs.release_url }}
+          steps_to_skip: ${{ github.event.inputs.steps_to_skip }}
+
+      - name: Finalize Release
+        id: finalize-release
+        env:
+          # The following are needed if you use legacy PyPI set up
+          # PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
+          # PYPI_TOKEN_MAP: ${{ secrets.PYPI_TOKEN_MAP }}
+          # TWINE_USERNAME: __token__
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        uses: jupyter-server/jupyter_releaser/.github/actions/finalize-release@v2
+        with:
+          token: ${{ secrets.ADMIN_GITHUB_TOKEN }}
+          release_url: ${{ steps.populate-release.outputs.release_url }}
+
+      - name: "** Next Step **"
+        if: ${{ success() }}
+        run: |
+          echo "Verify the final release"
+          echo ${{ steps.finalize-release.outputs.release_url }}
+
+      - name: "** Failure Message **"
+        if: ${{ failure() }}
+        run: |
+          echo "Failed to Publish the Draft Release Url:"
+          echo ${{ steps.populate-release.outputs.release_url }}

.gitignore

@@ -58,6 +58,7 @@ htmlcov/
 .coverage.*
 .cache
 nosetests.xml
+coverage/
 coverage.xml
 *.cover
 .hypothesis/
@@ -112,3 +113,6 @@ dmypy.json
 
 # OSX files
 .DS_Store
+
+# Yarn cache
+.yarn/

.prettierignore

@@ -2,6 +2,7 @@
 **/node_modules
 **/style
 **/package.json
+!/package.json
 **/tsconfig.json
 **/patches
 **/scripts

.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

LICENSE

@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2022, quantstack
+Copyright (c) 2024, quantstack
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

README.md

@@ -16,7 +16,7 @@ Repo: https://github.com/google/blockly
 
 ## Requirements
 
-- JupyterLab == 3.6
+- JupyterLab >= 4.0.0
 
 ## Install
 
@@ -25,6 +25,10 @@ To install the extension, execute:
 ```bash
 conda install -c conda-forge jupyterlab-blockly
 ```
+or 
+```bash
+pip install jupyterlab-blockly
+```
 
 #### Kernels
 
@@ -41,6 +45,10 @@ To remove the extension, execute:
 ```bash
 conda uninstall -c conda-forge jupyterlab-blockly
 ```
+or
+```bash
+pip install jupyterlab-blockly
+```
 
 ## Contributing
 
@@ -53,7 +61,7 @@ The `jlpm` command is JupyterLab's pinned version of
 `yarn` or `npm` in lieu of `jlpm` below.
 
 ```bash
-micromamba create -n blockly -c conda-forge python nodejs=18 pre-commit jupyterlab==3.6 jupyter-packaging jupyterlab-language-pack-es-ES jupyterlab-language-pack-fr-FR ipykernel xeus-python xeus-lua
+micromamba create -n blockly -c conda-forge python nodejs=18 pre-commit jupyterlab jupyter-packaging jupyterlab-language-pack-es-ES jupyterlab-language-pack-fr-FR ipykernel xeus-python xeus-lua
 micromamba activate blockly
 # Clone the repo to your local environment
 # Change directory to the jupyterlab_blockly directory

RELEASE.md

@@ -6,13 +6,31 @@ The extension can be published to `PyPI` and `npm` manually or using the [Jupyte
 
 ### Python package
 
-This extension can be distributed as Python
-packages. All of the Python
-packaging instructions in the `pyproject.toml` file to wrap your extension in a
-Python package. Before generating a package, we first need to install `build`.
+This extension can be distributed as Python packages. All of the Python
+packaging instructions are in the `pyproject.toml` file to wrap your extension in a
+Python package. Before generating a package, you first need to install some tools:
 
 ```bash
-pip install build twine
+pip install build twine hatch
+```
+
+Bump the version using `hatch`. By default this will create a tag.
+See the docs on [hatch-nodejs-version](https://github.com/agoose77/hatch-nodejs-version#semver) for details.
+
+```bash
+hatch version <new-version>
+```
+
+Make sure to clean up all the development files before building the package:
+
+```bash
+jlpm clean:all
+```
+
+You could also clean up the local git repository:
+
+```bash
+git clean -dfX
 ```
 
 To create a Python source package (`.tar.gz`) and the binary package (`.whl`) in the `dist/` directory, do:
@@ -40,22 +58,20 @@ npm publish --access public
 
 ## Automated releases with the Jupyter Releaser
 
-The extension repository should already be compatible with the Jupyter Releaser.
-
-Check out the [workflow documentation](https://github.com/jupyter-server/jupyter_releaser#typical-workflow) for more information.
+The extension repository should already be compatible with the Jupyter Releaser. But
+the GitHub repository and the package managers need to be properly set up. Please
+follow the instructions of the Jupyter Releaser [checklist](https://jupyter-releaser.readthedocs.io/en/latest/how_to_guides/convert_repo_from_repo.html).
 
 Here is a summary of the steps to cut a new release:
 
-- Fork the [`jupyter-releaser` repo](https://github.com/jupyter-server/jupyter_releaser)
-- Add `ADMIN_GITHUB_TOKEN`, `PYPI_TOKEN` and `NPM_TOKEN` to the Github Secrets in the fork
 - Go to the Actions panel
-- Run the "Draft Changelog" workflow
-  ![Draft Changelog](assets/run_draft_changelog.png)
-- Merge the Changelog PR
-  ![Merge Draft Changelog PR](assets/merge_changelog.png)
-- Using the info from the draft changelong PR, run the "Full Release" workflow
-  ![Full Release info](assets/info_full_release.png)
-  ![Full Release](assets/run_full_release.png)
+- Run the "Step 1: Prep Release" workflow
+- Check the draft changelog
+- Run the "Step 2: Publish Release" workflow
+
+> [!NOTE]
+> Check out the [workflow documentation](https://jupyter-releaser.readthedocs.io/en/latest/get_started/making_release_from_repo.html)
+> for more information.
 
 ## Publishing to `conda-forge`
 

binder/environment.yml

@@ -12,7 +12,7 @@ channels:
 dependencies:
   # runtime dependencies
   - python >=3.8,<3.12.0a0
-  - jupyterlab >=3.5,<4.0.0a0
+  - jupyterlab >=4.0.0,<5.0.0a0
   # labextension build dependencies
   - nodejs >=18,<19
   - pip

docs/conf.py

@@ -17,7 +17,7 @@
 # -- Project information -----------------------------------------------------
 
 project = 'jupyterlab-blockly'
-copyright = '2022, Denisa Checiu'
+copyright = '2024, QuantStack'
 author = 'Denisa Checiu'
 
 # The full version, including alpha/beta/rc tags