Adopt sp-repo-review (#7039)

* adopt sp-repo-review * adopt sp-repo-review * fix typing * fix typing * undo redundant formatting * undo markdown changes * formatting
jupyter · Sep 12, 2023 · 14fce8c · 14fce8c
1 parent 5a31c64
commit 14fce8c
Show file tree

Hide file tree

Showing 27 changed files with 233 additions and 194 deletions.
diff --git a/.github/actions/build-dist/action.yml b/.github/actions/build-dist/action.yml
@@ -1,7 +1,7 @@
-name: "Build Jupyter Notebook"
-description: "Build Jupyter Notebook from source"
+name: 'Build Jupyter Notebook'
+description: 'Build Jupyter Notebook from source'
 runs:
-  using: "composite"
+  using: 'composite'
   steps:
     - name: Base Setup
       uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1

diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -1,10 +1,10 @@
 version: 2
 updates:
-  - package-ecosystem: "github-actions"
-    directory: "/"
+  - package-ecosystem: 'github-actions'
+    directory: '/'
     schedule:
-      interval: "weekly"
-  - package-ecosystem: "pip"
-    directory: "/"
+      interval: 'weekly'
+  - package-ecosystem: 'pip'
+    directory: '/'
     schedule:
-      interval: "weekly"
+      interval: 'weekly'
diff --git a/.github/jupyterlab-probot.yml b/.github/jupyterlab-probot.yml
@@ -1,2 +1,2 @@
 addBinderLink: false
-triageLabel: "status:Needs Triage"
+triageLabel: 'status:Needs Triage'
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -5,11 +5,10 @@ on:
     branches: ['main']
   pull_request:
   schedule:
-    - cron: "0 0 * * *"
+    - cron: '0 0 * * *'
 
 permissions:
-  contents:
-    write
+  contents: write
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }}
@@ -26,11 +25,11 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - name: Checkout
-      uses: actions/checkout@v4
+      - name: Checkout
+        uses: actions/checkout@v4
 
-    - name: Build
-      uses: ./.github/actions/build-dist
+      - name: Build
+        uses: ./.github/actions/build-dist
 
   test:
     runs-on: ubuntu-latest
@@ -41,28 +40,28 @@ jobs:
         # used by the jupyterlab/maintainer-tools base-setup action
         python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
     steps:
-    - name: Checkout
-      uses: actions/checkout@v4
+      - name: Checkout
+        uses: actions/checkout@v4
 
-    - name: Base Setup
-      uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
+      - name: Base Setup
+        uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
 
-    - name: Test the package
-      run: hatch run cov:test
+      - name: Test the package
+        run: hatch run cov:test
 
-    - name: JavaScript tests
-      run: |
-        hatch run js_test
+      - name: JavaScript tests
+        run: |
+          hatch run js_test
 
-    - name: Integration Tests
-      run: |
-        pip install .
-        cd
-        jupyter labextension list 2>&1 | grep -ie "@jupyter-notebook/lab-extension.*enabled.*ok" -
-        jupyter server extension list 2>&1 | grep -ie "notebook.*enabled" -
-        python -m jupyterlab.browser_check
+      - name: Integration Tests
+        run: |
+          pip install .
+          cd
+          jupyter labextension list 2>&1 | grep -ie "@jupyter-notebook/lab-extension.*enabled.*ok" -
+          jupyter server extension list 2>&1 | grep -ie "notebook.*enabled" -
+          python -m jupyterlab.browser_check
 
-    - uses: jupyterlab/maintainer-tools/.github/actions/upload-coverage@v1
+      - uses: jupyterlab/maintainer-tools/.github/actions/upload-coverage@v1
 
   coverage:
     runs-on: ubuntu-latest
@@ -176,17 +175,17 @@ jobs:
       - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
       - uses: jupyterlab/maintainer-tools/.github/actions/check-links@v1
         with:
-          ignore_links: "https://playwright.dev/docs/test-cli/ https://blog.jupyter.org/the-big-split-9d7b88a031a7 https://blog.jupyter.org/jupyter-ascending-1bf5b362d97e https://mybinder.org/v2/gh/jupyter/notebook/main"
-          ignore_glob: "ui-tests/test/notebooks/*"
+          ignore_links: 'https://playwright.dev/docs/test-cli/ https://blog.jupyter.org/the-big-split-9d7b88a031a7 https://blog.jupyter.org/jupyter-ascending-1bf5b362d97e https://mybinder.org/v2/gh/jupyter/notebook/main'
+          ignore_glob: 'ui-tests/test/notebooks/*'
 
   test_lint:
     name: Test Lint
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
-      -  name: Run Linters
-         run: |
+      - name: Run Linters
+        run: |
           hatch run typing:test
           hatch run lint:style
           pipx run interrogate -v .

diff --git a/.github/workflows/buildutils.yml b/.github/workflows/buildutils.yml
@@ -18,64 +18,64 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 10
     steps:
-    - name: Checkout
-      uses: actions/checkout@v4
+      - name: Checkout
+        uses: actions/checkout@v4
 
-    - name: Base Setup
-      uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
+      - name: Base Setup
+        uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
 
-    - name: Install dependencies
-      run: |
-        python -m pip install -U "jupyterlab>=4.0.2,<5" hatch
-        jlpm
-        jlpm run build
+      - name: Install dependencies
+        run: |
+          python -m pip install -U "jupyterlab>=4.0.2,<5" hatch
+          jlpm
+          jlpm run build
 
-    - name: Configure git identity to commit
-      run: |
-        git config --global user.email "you@example.com"
-        git config --global user.name "Your Name"
+      - name: Configure git identity to commit
+        run: |
+          git config --global user.email "you@example.com"
+          git config --global user.name "Your Name"
 
-    - name: Reset version
-      run: |
-        hatch version 9.8.7
-        jlpm run lerna version 9.8.7 --no-push --force-publish --no-git-tag-version --yes
-        git commit -am "Release 9.8.7"
+      - name: Reset version
+        run: |
+          hatch version 9.8.7
+          jlpm run lerna version 9.8.7 --no-push --force-publish --no-git-tag-version --yes
+          git commit -am "Release 9.8.7"
 
-    - name: Patch Release
-      run: |
-        jlpm release:patch --force
+      - name: Patch Release
+        run: |
+          jlpm release:patch --force
 
-    - name: Minor Release
-      run: |
-        jlpm release:bump minor --force
+      - name: Minor Release
+        run: |
+          jlpm release:bump minor --force
 
-    - name: Release Cycle
-      run: |
-        # beta
-        jlpm release:bump release --force
-        # rc
-        jlpm release:bump release --force
-        # final
-        jlpm release:bump release --force
+      - name: Release Cycle
+        run: |
+          # beta
+          jlpm release:bump release --force
+          # rc
+          jlpm release:bump release --force
+          # final
+          jlpm release:bump release --force
 
-    - name: Major Release
-      run: |
-        jlpm release:bump major --force
+      - name: Major Release
+        run: |
+          jlpm release:bump major --force
 
   npm:
     runs-on: ubuntu-latest
     steps:
-    - name: Checkout
-      uses: actions/checkout@v4
+      - name: Checkout
+        uses: actions/checkout@v4
 
-    - name: Install Python
-      uses: actions/setup-python@v4
-      with:
-        python-version: '3.9'
-        architecture: 'x64'
+      - name: Install Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.9'
+          architecture: 'x64'
 
-    - name: Install dependencies
-      run: |
-        python -m pip install -U "jupyterlab>=4.0.2,<5" pip
-        jlpm
-        jlpm run build
+      - name: Install dependencies
+        run: |
+          python -m pip install -U "jupyterlab>=4.0.2,<5" pip
+          jlpm
+          jlpm run build
diff --git a/.github/workflows/check-release.yml b/.github/workflows/check-release.yml
@@ -1,12 +1,11 @@
 name: Check Release
 on:
   push:
-    branches: ["main"]
+    branches: ['main']
   pull_request:
 
 permissions:
-  contents:
-    write
+  contents: write
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }}

diff --git a/.github/workflows/lock.yml b/.github/workflows/lock.yml
@@ -5,10 +5,8 @@ on:
     - cron: '0 0 * * *'
 
 permissions:
-  issues:
-    write
-  pull-requests:
-    write
+  issues: write
+  pull-requests: write
 
 jobs:
   lock:

diff --git a/.github/workflows/prep-release.yml b/.github/workflows/prep-release.yml
@@ -1,22 +1,22 @@
-name: "Step 1: Prep Release"
+name: 'Step 1: Prep Release'
 on:
   workflow_dispatch:
     inputs:
       version_spec:
-        description: "New Version Specifier"
-        default: "next"
+        description: 'New Version Specifier'
+        default: 'next'
         required: false
       branch:
-        description: "The branch to target"
+        description: 'The branch to target'
         required: false
       post_version_spec:
-        description: "Post Version Specifier"
+        description: 'Post Version Specifier'
         required: false
       since:
-        description: "Use PRs with activity since this date or git reference"
+        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"
+        description: 'Use PRs with activity since the last stable git tag'
         required: false
         type: boolean
 jobs:
@@ -37,6 +37,6 @@ jobs:
           since: ${{ github.event.inputs.since }}
           since_last_stable: ${{ github.event.inputs.since_last_stable }}
 
-      - name: "** Next Step **"
+      - 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
@@ -1,15 +1,15 @@
-name: "Step 2: Publish Release"
+name: 'Step 2: Publish Release'
 on:
   workflow_dispatch:
     inputs:
       branch:
-        description: "The target branch"
+        description: 'The target branch'
         required: false
       release_url:
-        description: "The URL of the draft GitHub release"
+        description: 'The URL of the draft GitHub release'
         required: false
       steps_to_skip:
-        description: "Comma separated list of steps to skip"
+        description: 'Comma separated list of steps to skip'
         required: false
 
 jobs:
@@ -41,13 +41,13 @@ jobs:
           target: ${{ github.event.inputs.target }}
           release_url: ${{ steps.populate-release.outputs.release_url }}
 
-      - name: "** Next Step **"
+      - name: '** Next Step **'
         if: ${{ success() }}
         run: |
           echo "Verify the final release"
           echo ${{ steps.finalize-release.outputs.release_url }}
 
-      - name: "** Failure Message **"
+      - name: '** Failure Message **'
         if: ${{ failure() }}
         run: |
           echo "Failed to Publish the Draft Release Url:"

diff --git a/.github/workflows/ui-tests.yml b/.github/workflows/ui-tests.yml
@@ -2,7 +2,7 @@ name: UI Tests
 
 on:
   push:
-    branches: ["main"]
+    branches: ['main']
   pull_request:
 
 concurrency: