Update UX Improvements branch

.copier-answers.yml

@@ -0,0 +1,14 @@
+# Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
+_commit: v4.3.5
+_src_path: https://github.com/jupyterlab/extension-template
+author_email: jupyter@googlegroups.com
+author_name: Jupyter Development Team
+has_binder: true
+has_settings: true
+kind: server
+labextension_name: '@jupyterlab/latex'
+project_short_description: JupyterLab extension for running LaTeX
+python_name: jupyterlab_latex
+repository: https://github.com/jupyterlab/jupyterlab-latex
+test: false
+

.eslintignore

@@ -0,0 +1,9 @@
+node_modules
+dist
+coverage
+*.d.ts
+style/**/*.js
+jupyterlab_latex/labextension/static/*.js
+lib/**/*.js
+src/error.tsx
+eslint.config.js

.github/workflows/binder-on-pr.yml

@@ -0,0 +1,14 @@
+name: Binder Badge
+on:
+ pull_request_target:
+ types: [opened]
+
+jobs:
+ binder:
+ runs-on: ubuntu-latest
+ permissions:
+ pull-requests: write
+ steps:
+ - uses: jupyterlab/maintainer-tools/.github/actions/binder-link@v1
+ with:
+ github_token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/build.yml

@@ -6,52 +6,93 @@ on:
  pull_request:
  branches: '*'
 
+concurrency:
+ group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+ cancel-in-progress: true
+
 jobs:
  build:
  runs-on: ubuntu-latest
+
  steps:
  - name: Checkout
- uses: actions/checkout@v3.5.2
- - name: Install node
- uses: actions/setup-node@v3
+ uses: actions/checkout@v4
+
+ - 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 server extension list
+ jupyter server extension list 2>&1 | grep -ie "jupyterlab_latex.*OK"
+
+ jupyter labextension list
+ jupyter labextension list 2>&1 | grep -ie "@jupyterlab/latex.*OK"
+ python -m jupyterlab.browser_check
+
+ - name: Package the extension
+ run: |
+ set -eux
+
+ pip install build
+ python -m build
+ pip uninstall -y "jupyterlab_latex" jupyterlab
+
+ - name: Upload extension packages
+ uses: actions/upload-artifact@v4
  with:
- node-version: '18.x'
+ name: extension-artifacts
+ path: dist/jupyterlab_latex*
+ if-no-files-found: error
+
+ test_isolated:
+ needs: build
+ runs-on: ubuntu-latest
+
+ steps:
  - name: Install Python
- uses: actions/setup-python@v4
+ uses: actions/setup-python@v5
  with:
- python-version: '3.10'
+ python-version: '3.9'
  architecture: 'x64'
-
-
- - name: Setup pip cache
- uses: actions/cache@v3
- with:
- path: ~/.cache/pip
- key: pip-3.8-${{ hashFiles('package.json') }}
- restore-keys: |
- pip-3.8-
- pip-
-
- - name: Get yarn cache directory path
- id: yarn-cache-dir-path
- run: echo "dir=$(yarn cache dir)" >> $GITHUB_OUTPUT
- - name: Setup yarn cache
- uses: actions/cache@v3
- id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
+ - uses: actions/download-artifact@v4
  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 jupyter_packaging~=0.12.3 jupyterlab~=4.0.0 pip wheel
- - name: Install the extension
+ name: extension-artifacts
+ - name: Install and Test
  run: |
  set -eux
- python -m pip install .
- - name: Integration test
- run: |
+ # 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_latex*.whl
+
+
+ jupyter server extension list
  jupyter server extension list 2>&1 | grep -ie "jupyterlab_latex.*OK"
+
+ jupyter labextension list
  jupyter labextension list 2>&1 | grep -ie "@jupyterlab/latex.*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@v4
+ - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
+ - uses: jupyterlab/maintainer-tools/.github/actions/check-links@v1

.github/workflows/check-release.yml

@@ -0,0 +1,30 @@
+name: Check Release
+on:
+ push:
+ branches: ["master"]
+ pull_request:
+ branches: ["*"]
+
+concurrency:
+ group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+ cancel-in-progress: true
+
+jobs:
+ check_release:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v4
+ - name: Base Setup
+ uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
+ - name: Check Release
+ uses: jupyter-server/jupyter_releaser/.github/actions/check-release@v2
+ with:
+
+ token: ${{ secrets.GITHUB_TOKEN }}
+
+ - name: Upload Distributions
+ uses: actions/upload-artifact@v4
+ with:
+ name: jupyterlab_latex-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,48 @@
+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
+ # silent:
+ # description: "Set a placeholder in the changelog and don't publish the release."
+ # required: false
+ # type: boolean
+ 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
+ permissions:
+ contents: write
+ 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.GITHUB_TOKEN }}
+ version_spec: ${{ github.event.inputs.version_spec }}
+ # silent: ${{ github.event.inputs.silent }}
+ 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,58 @@
+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
+ environment: release
+ permissions:
+ id-token: write
+ steps:
+ - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
+
+ - uses: actions/create-github-app-token@v1
+ id: app-token
+ with:
+ app-id: ${{ vars.APP_ID }}
+ private-key: ${{ secrets.APP_PRIVATE_KEY }}
+
+ - name: Populate Release
+ id: populate-release
+ uses: jupyter-server/jupyter_releaser/.github/actions/populate-release@v2
+ with:
+ token: ${{ steps.app-token.outputs.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:
+ NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+ uses: jupyter-server/jupyter_releaser/.github/actions/finalize-release@v2
+ with:
+ token: ${{ steps.app-token.outputs.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 }}