🪐 Support for JupyterLab 4.x (take 2!) (#155)

* Rework dependencies (#139) * 🎨 Theme updates for showing proofs, algorithms, and github previews (#140) * 🎨 Update for showing proofs * Update Playwright Snapshots * Pass trust to the mimerenderer (#150) * Update `@jupyterlab/galata`? * 🧪 Pass in request to `galata` * Try `npm_client: jlpm` * 🧹 Update yml formatting, to trigger build! * Only reuse expressions if the model exists * Remove block lifting * Upgrade myst packages * Turn ts-error into lint warning * Fix local images in markdown files * Add abbreviations and glossary transforms * Fake get rid of the double render * Backwards compatible with Jupyterlab3 * Consistent setters/getters on cell metadata --------- Co-authored-by: Rowan Cockett <[email protected]>
jupyter-book · Jun 23, 2023 · 3eb5b7b · 3eb5b7b
1 parent 42d8321
commit 3eb5b7b
Show file tree

Hide file tree

Showing 51 changed files with 14,350 additions and 13,987 deletions.
diff --git a/.github/workflows/binder-on-pr.yml b/.github/workflows/binder-on-pr.yml
@@ -1,31 +1,14 @@
-# Reference https://mybinder.readthedocs.io/en/latest/howto/gh-actions-badges.html
 name: Binder Badge
 on:
   pull_request_target:
     types: [opened]
 
-permissions:
-  pull-requests: write
-
-
 jobs:
   binder:
     runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
     steps:
-      - name: comment on PR with Binder link
-        uses: actions/github-script@v3
+      - uses: jupyterlab/maintainer-tools/.github/actions/binder-link@v1
         with:
-          github-token: ${{secrets.GITHUB_TOKEN}}
-          script: |
-            var PR_HEAD_USERREPO = process.env.PR_HEAD_USERREPO;
-            var PR_HEAD_REF = process.env.PR_HEAD_REF;
-            github.issues.createComment({
-              issue_number: context.issue.number,
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              body: `[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/${PR_HEAD_USERREPO}/${PR_HEAD_REF}?urlpath=lab) :point_left: Launch a Binder on branch _${PR_HEAD_USERREPO}/${PR_HEAD_REF}_`
-            })
-        env:
-          PR_HEAD_REF: ${{ github.event.pull_request.head.ref }}
-          PR_HEAD_USERREPO: ${{ github.event.pull_request.head.repo.full_name }}
-
+          github_token: ${{ secrets.github_token }}
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -11,84 +11,85 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - name: Checkout
-      uses: actions/checkout@v2
-
-    - name: Base Setup
-      uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
-
-    - name: Install dependencies
-      run: python -m pip install -U jupyterlab~=3.1
-
-    - name: Lint the extension
-      run: |
-        set -eux
-        jlpm
-        jlpm run lint:check
-
-    - name: Test the extension
-      run: |
-        set -eux
-        jlpm run test
-
-    - name: Build the extension
-      run: |
-        set -eux
-        python -m pip install .[test]
-
-        jupyter labextension list
-        jupyter labextension list 2>&1 | grep -ie "jupyterlab-myst.*OK"
-        python -m jupyterlab.browser_check
-
-    - name: Package the extension
-      run: |
-        set -eux
-
-        pip install build
-        python -m build
-        pip uninstall -y "jupyterlab_myst" jupyterlab
-
-    - name: Upload extension packages
-      uses: actions/upload-artifact@v2
-      with:
-        name: extension-artifacts
-        path: dist/jupyterlab_myst*
-        if-no-files-found: error
+      - 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.0b0,<5"
+
+      - name: Lint the extension
+        run: |
+          set -eux
+          jlpm
+          jlpm run lint:check
+
+      - name: Test the extension
+        run: |
+          set -eux
+          jlpm run test
+
+      - name: Build the extension
+        run: |
+          set -eux
+          python -m pip install .[test]
+
+          pytest -vv -r ap --cov jupyterlab_myst
+          jupyter server extension list
+          jupyter server extension list 2>&1 | grep -ie "jupyterlab_myst.*OK"
+
+          jupyter labextension list
+          jupyter labextension list 2>&1 | grep -ie "jupyterlab-myst.*OK"
+          python -m jupyterlab.browser_check
+
+      - name: Package the extension
+        run: |
+          set -eux
+
+          pip install build
+          python -m build
+          pip uninstall -y "jupyterlab_myst" jupyterlab
+
+      - name: Upload extension packages
+        uses: actions/upload-artifact@v3
+        with:
+          name: extension-artifacts
+          path: dist/jupyterlab_myst*
+          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
-      with:
-        python-version: '3.9'
-        architecture: 'x64'
-    - uses: actions/download-artifact@v2
-      with:
-        name: extension-artifacts
-    - name: Install
-      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~=3.1" jupyterlab_myst*.whl -r requirements-test.txt
-
-    - name: Install and Test
-      run: |
-        set -eux
-
-        jupyter labextension list
-        jupyter labextension list 2>&1 | grep -ie "jupyterlab-myst.*OK"
-        python -m jupyterlab.browser_check --no-chrome-test
-        
-        python -m pytest "${{ github.workspace }}/tests"
-      working-directory: "${{ runner.temp }}"
+      - name: Checkout
+        uses: actions/checkout@v3
+      - 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.0b0,<5" jupyterlab_myst*.whl
+
+
+          jupyter server extension list
+          jupyter server extension list 2>&1 | grep -ie "jupyterlab_myst.*OK"
+
+          jupyter labextension list
+          jupyter labextension list 2>&1 | grep -ie "jupyterlab-myst.*OK"
+          python -m jupyterlab.browser_check --no-browser-test
 
   integration-tests:
     name: Integration tests
@@ -99,63 +100,61 @@ jobs:
       PLAYWRIGHT_BROWSERS_PATH: ${{ github.workspace }}/pw-browsers
 
     steps:
-    - name: Checkout
-      uses: actions/checkout@v2
-
-    - name: Base Setup
-      uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
-
-    - name: Download extension package
-      uses: actions/download-artifact@v2
-      with:
-        name: extension-artifacts
-
-    - name: Install the extension
-      run: |
-        set -eux
-        python -m pip install "jupyterlab~=3.1" jupyterlab_myst*.whl
-
-    - name: Install dependencies
-      working-directory: ui-tests
-      env:
-        PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: 1
-      run: jlpm install
-
-    - name: Set up browser cache
-      uses: actions/cache@v2
-      with:
-        path: |
-          ${{ github.workspace }}/pw-browsers
-        key: ${{ runner.os }}-${{ hashFiles('ui-tests/yarn.lock') }}
-
-    - name: Install browser
-      run: jlpm playwright install chromium
-      working-directory: ui-tests
-
-    - name: Execute integration tests
-      working-directory: ui-tests
-      run: |
-        jlpm playwright test
-
-    - name: Upload Playwright Test report
-      if: always()
-      uses: actions/upload-artifact@v2
-      with:
-        name: jupyterlab_myst-playwright-tests
-        path: |
-          ui-tests/test-results
-          ui-tests/playwright-report
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Base Setup
+        uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
+
+      - name: Download extension package
+        uses: actions/download-artifact@v3
+        with:
+          name: extension-artifacts
+
+      - name: Install the extension
+        run: |
+          set -eux
+          python -m pip install "jupyterlab>=4.0.0b0,<5" jupyterlab_myst*.whl
+
+      - name: Install dependencies
+        working-directory: ui-tests
+        env:
+          PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: 1
+        run: jlpm install
+
+      - name: Set up browser cache
+        uses: actions/cache@v3
+        with:
+          path: |
+            ${{ github.workspace }}/pw-browsers
+          key: ${{ runner.os }}-${{ hashFiles('ui-tests/yarn.lock') }}
+
+      - name: Install browser
+        run: jlpm playwright install chromium
+        working-directory: ui-tests
+
+      - name: Execute integration tests
+        working-directory: ui-tests
+        run: |
+          jlpm playwright test
+
+      - name: Upload Playwright Test report
+        if: always()
+        uses: actions/upload-artifact@v3
+        with:
+          name: jupyterlab_myst-playwright-tests
+          path: |
+            ui-tests/test-results
+            ui-tests/playwright-report
 
   check_links:
     name: Check Links
     runs-on: ubuntu-latest
     timeout-minutes: 15
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
       - name: Install missing dependencies
         # On May 30, 2023 this wasn't included in the base try removing in future!
         run: pip install typing_extensions
       - uses: jupyterlab/maintainer-tools/.github/actions/check-links@v1
-        with:
-          ignore_links: 'https:\/\/mybinder\.org.*'
diff --git a/.github/workflows/check-release.yml b/.github/workflows/check-release.yml
@@ -10,7 +10,7 @@ jobs:
     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
@@ -23,7 +23,7 @@ jobs:
           token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Upload Distributions
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: jupyterlab_myst-releaser-dist-${{ github.run_number }}
-          path: .jupyter_releaser_checkout/dist
+          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/publish-release.yml b/.github/workflows/publish-release.yml
@@ -46,6 +46,7 @@ jobs:
         run: |
           echo "Verify the final release"
           echo ${{ steps.finalize-release.outputs.release_url }}
+
       - name: "** Failure Message **"
         if: ${{ failure() }}
         run: |

diff --git a/.github/workflows/update-integration-tests.yml b/.github/workflows/update-integration-tests.yml
@@ -9,15 +9,13 @@ permissions:
   pull-requests: write
 
 jobs:
-
-
   update-snapshots:
     if: ${{ github.event.issue.pull_request && contains(github.event.comment.body, 'please update playwright snapshots') }}
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
 
@@ -33,7 +31,7 @@ jobs:
         uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
 
       - name: Install dependencies
-        run: python -m pip install -U jupyterlab~=3.1
+        run: python -m pip install -U "jupyterlab>=4.0.0b0,<5"
 
       - name: Install extension
         run: |
@@ -44,7 +42,7 @@ jobs:
       - uses: jupyterlab/maintainer-tools/.github/actions/update-snapshots@v1
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
+          npm_client: jlpm
           # Playwright knows how to start JupyterLab server
           start_server_script: 'null'
           test_folder: ui-tests
-