Support JupyterLab 4.0 (#43)

* Run migration script * Modify code for cell editor api updates * Update lock file * Run prettier * Update package.json Co-authored-by: Jeremy Tuloup <[email protected]> * Run lint --------- Co-authored-by: Jeremy Tuloup <[email protected]>
jupyterlab-contrib · Nov 21, 2023 · cabbbc5 · cabbbc5
1 parent 90e016f
commit cabbbc5
Show file tree

Hide file tree

Showing 25 changed files with 7,160 additions and 6,450 deletions.
diff --git a/.copier-answers.yml b/.copier-answers.yml
@@ -0,0 +1,15 @@
+# Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
+_commit: v4.2.4
+_src_path: https://github.com/jupyterlab/extension-template
+author_email: ''
+author_name: JupyterLab Contrib Team
+has_binder: false
+has_settings: true
+kind: frontend
+labextension_name: jupyterlab-cell-flash
+project_short_description:
+  JupyterLab extension to show a flash effect when a cell
+  is executed
+python_name: jupyterlab_cell_flash
+repository: https://github.com/jupyterlab-contrib/jupyterlab-cell-flash.git
+test: false
diff --git a/.eslintignore b/.eslintignore
diff --git a/.eslintrc.js b/.eslintrc.js
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -2,55 +2,86 @@ name: Build
 
 on:
   push:
-    branches: [ main ]
+    branches: main
   pull_request:
     branches: '*'
 
 jobs:
   build:
     runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        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>=4.0.0,<5"
+
+      - name: Lint the extension
+        run: |
+          set -eux
+          jlpm
+          jlpm run lint:check
+
+      - name: Build the extension
+        run: |
+          set -eux
+          python -m pip install .[test]
+
+          jupyter labextension list
+          jupyter labextension list 2>&1 | grep -ie "jupyterlab-cell-flash.*OK"
+          python -m jupyterlab.browser_check
+
+      - name: Package the extension
+        run: |
+          set -eux
+
+          pip install build
+          python -m build
+          pip uninstall -y "jupyterlab_cell_flash" jupyterlab
+
+      - name: Upload extension packages
+        uses: actions/upload-artifact@v3
+        with:
+          name: extension-artifacts
+          path: dist/jupyterlab_cell_flash*
+          if-no-files-found: error
+
+  test_isolated:
+    needs: build
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Install Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.9'
+          architecture: 'x64'
+      - uses: actions/download-artifact@v3
+        with:
+          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 "jupyterlab>=4.0.0,<5" jupyterlab_cell_flash*.whl
+
+
+          jupyter labextension list
+          jupyter labextension list 2>&1 | grep -ie "jupyterlab-cell-flash.*OK"
+          python -m jupyterlab.browser_check --no-browser-test
+
+  check_links:
+    name: Check Links
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
     steps:
-    - name: Checkout
-      uses: actions/checkout@v2
-    - name: Install node
-      uses: actions/setup-node@v1
-      with:
-       node-version: '14.x'
-    - name: Install Python
-      uses: actions/setup-python@v2
-      with:
-        python-version: '3.9'
-        architecture: 'x64'
-
-
-    - name: Setup pip cache
-      uses: actions/cache@v2
-      with:
-        path: ~/.cache/pip
-        key: pip-3.9-${{ hashFiles('package.json') }}
-        restore-keys: |
-          pip-3.9-
-          pip-
-
-    - name: Get yarn cache directory path
-      id: yarn-cache-dir-path
-      run: echo "::set-output name=dir::$(yarn cache dir)"
-    - name: Setup yarn cache
-      uses: actions/cache@v2
-      id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
-      with:
-        path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
-        key: yarn-${{ hashFiles('**/yarn.lock') }}
-        restore-keys: |
-          yarn-
-
-    - name: Install dependencies
-      run: python -m pip install -U jupyterlab~=3.0 jupyter_packaging~=0.10
-    - name: Build the extension
-      run: |
-        jlpm
-        jlpm run eslint:check
-        python -m pip install .
-
-        jupyter labextension list 2>&1 | grep -ie "jupyterlab-cell-flash.*OK"
-        python -m jupyterlab.browser_check
+      - uses: actions/checkout@v3
+      - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
+      - uses: jupyterlab/maintainer-tools/.github/actions/check-links@v1
diff --git a/.github/workflows/check-release.yml b/.github/workflows/check-release.yml
@@ -1,55 +1,25 @@
 name: Check Release
 on:
   push:
-    branches:
-      - main
+    branches: ['main']
   pull_request:
-    branches:
-      - main
-
-permissions:
-  contents: write
+    branches: ['*']
 
 jobs:
   check_release:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
-      - name: Install Python
-        uses: actions/setup-python@v2
-        with:
-          python-version: 3.9
-          architecture: 'x64'
-      - name: Install node
-        uses: actions/setup-node@v2
-        with:
-          node-version: '14.x'
-      - name: Get pip cache dir
-        id: pip-cache
-        run: |
-          echo "::set-output name=dir::$(pip cache dir)"
-      - name: Cache pip
-        uses: actions/cache@v1
-        with:
-          path: ${{ steps.pip-cache.outputs.dir }}
-          key: ${{ runner.os }}-pip-${{ hashFiles('setup.cfg', 'setup.py') }}
-          restore-keys: |
-            ${{ runner.os }}-pip-
-      - name: Cache checked links
-        uses: actions/cache@v2
-        with:
-          path: ~/.cache/pytest-link-check
-          key: ${{ runner.os }}-linkcheck-${{ hashFiles('**/.md') }}-md-links
-          restore-keys: |
-            ${{ runner.os }}-linkcheck-
-      - name: Upgrade packaging dependencies
-        run: |
-          pip install --upgrade pip setuptools wheel jupyter-packaging~=0.10 --user
-      - name: Install Dependencies
-        run: |
-          pip install .
+        uses: actions/checkout@v3
+      - name: Base Setup
+        uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
       - name: Check Release
-        uses: jupyter-server/jupyter_releaser/.github/actions/check-release@v1
+        uses: jupyter-server/jupyter_releaser/.github/actions/check-release@v2
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Upload Distributions
+        uses: actions/upload-artifact@v3
+        with:
+          name: jupyterlab_cell_flash-releaser-dist-${{ github.run_number }}
+          path: .jupyter_releaser_checkout/dist
diff --git a/.github/workflows/enforce-label.yml b/.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
diff --git a/.github/workflows/prep-release.yml b/.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 }}"
diff --git a/.github/workflows/publish-release.yml b/.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 }}