.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,72 @@
+# Copyright 2024 The MathWorks, Inc.
+
+name: "🐞 Bug Report"
+title: "[Enter short description of bug.]"
+description: "Report a bug."
+labels: [bug, needs-triage]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Before reporting a bug, see [Issues](https://github.com/mathworks/jupyter-matlab-proxy/issues) to check if an issue already exists for the bug you encountered. To request a feature or report a vulnerability, return to [Create an Issue](https://github.com/mathworks/jupyter-matlab-proxy/issues/new/choose).
+
+  - type: markdown
+    attributes:
+      value: |
+        ##  Provide details about the bug: 
+        * What is the problem?
+        * What behavior were you expecting? 
+        * What happened instead? 
+        * Include full errors, uncaught exceptions, stack traces, and relevant logs. 
+        * Provide a sequence of steps to reproduce the issue.
+        * Suggest a fix, if possible.
+        * Any additional information that might be relevant.
+        
+  - type: textarea
+    id: bug-summary
+    attributes:
+      label: Summary
+
+  - type: dropdown
+    id: browsers
+    attributes:
+      label: Browser(s) used
+      multiple: true
+      options:
+        - Chrome
+        - Firefox        
+        - Safari
+        - Microsoft Edge
+
+  - type: dropdown
+    id: Feature-issue
+    attributes:
+      label: Issue found in
+      multiple: true
+      options:
+        - MATLAB Kernel
+        - MATLAB Desktop
+        - Syntax Highlighting, Auto Indentation, Tab Completion
+        - MAGIC Commands
+        - Others        
+
+  - type: markdown
+    attributes:
+      value: |
+        ## Run the `troubleshooting.py` script and paste the output below.         
+        
+        ```bash
+        $ python ./troubleshooting/troubleshooting.py
+        ```
+        If you are collecting logs using the MWI_LOG_FILE environment variable, we recommend you provide the variable when executing the troubleshooting script:
+         ```bash
+        $ MWI_LOG_FILE="/tmp/log.file" python ./troubleshooting/troubleshooting.py
+        ```
+        For more information about the `MWI_LOG_FILE` environment variable, see [Advanced-Usage.md](https://github.com/mathworks/jupyter-matlab-proxy/blob/main/Advanced-Usage.md)
+        For more information about the troubleshooting script, see [Troubleshooting](https://github.com/mathworks/jupyter-matlab-proxy/tree/main/troubleshooting)
+        
+
+  - type: textarea
+    id: troubleshooting-script-output
+    attributes:
+      label: Script output

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,7 @@
+# Copyright 2024 The MathWorks, Inc.
+
+blank_issues_enabled: true
+contact_links:
+  - name: Report a Security Vulnerability
+    url: https://github.com/mathworks/jupyter-matlab-proxy/security/policy
+    about: Follow these steps.

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,26 @@
+# Copyright 2024 The MathWorks, Inc.
+
+name: 🚀 Feature Request
+description: Suggest a feature for this project. 
+title: "(short issue description)"
+labels: [feature-request, needs-triage]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        To report a bug or security vulnerability, return to [Create an Issue](https://github.com/mathworks/jupyter-matlab-proxy/issues/new/choose).
+
+  - type: markdown
+    attributes:
+      value: |
+        ## Provide details of the feature you are proposing:
+        * A brief description 
+        * What use case or challenge would this help you overcome? For example: “Currently, it’s too time-consuming/difficult to do…” 
+        * Suggestions for implementing the request: provide a prototype, sketch, reference etc. 
+        * Any additional information: details, stack traces, related issues, links for context, etc.
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Details of the feature
+

.github/workflows/release.yml → .github/workflows/publish-jupyter-matlab-proxy.yml

@@ -1,29 +1,34 @@
-# Copyright 2020-2023 The MathWorks, Inc.
-
-# Workflow to release MATLAB Jupyter Integration to PyPi
-name: Release to PyPI
+# Copyright 2020-2024 The MathWorks, Inc.
 
+name: Publish jupyter-matlab-proxy to PyPI
 on:
   release:
     types: [created]
 
 jobs:
   call-unit-tests:
-    # Runs unit tests
+    # Only run release jobs on tags which have `jupyter-matlab-proxy` in them
+    if: ${{ contains(github.ref, 'jupyter-matlab-proxy') }}
+    # Run unit tests
     uses: ./.github/workflows/run-unit-tests.yml
+    secrets: inherit
 
   build_and_publish_pypi:
-    # TODO: Add integration-tests as a dependency to
-    # the release pipeline.
     needs: [call-unit-tests]
     if: success()
     runs-on: ubuntu-latest
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+    environment:
+      name:  pypi
+      url: https://pypi.org/project/jupyter-matlab-proxy
 
     steps:
       - name: Checkout
         uses: actions/checkout@v3
         with:
-          ref: ${{github.sha}}
+          ref: ${{ github.sha }}
 
       - name: Set up Python 3.8
         uses: actions/setup-python@v4
@@ -40,8 +45,3 @@ jobs:
 
       - name: Publish to PyPI.
         uses: pypa/gh-action-pypi-publish@release/v1
-        with:
-          user: __token__
-          verbose: true
-          password: ${{ secrets.PYPI_TOKEN }}
-          repository_url: ${{ secrets.PYPI_REPOSITORY_URL }}

.github/workflows/publish-tljh-matlab.yml

@@ -0,0 +1,65 @@
+# Copyright 2024 The MathWorks, Inc.
+name: Upload Python Package for tljh-matlab
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  build-tljh-matlab:
+    # Only run job if release tag contains `tljh-matlab`
+    if: ${{ contains(github.ref, 'tljh-matlab') }}
+
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./install_guides/the-littlest-jupyterhub/tljh-matlab
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.x'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+
+    - name: Build package
+      run: |
+        python -m build
+
+    - name: Upload distributions
+      uses: actions/upload-artifact@v4
+      with:
+          name: release-dists
+          path: install_guides/the-littlest-jupyterhub/tljh-matlab/dist/
+
+  release-tljh-matlab:
+    runs-on: ubuntu-latest
+    needs: 
+      - build-tljh-matlab
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+    environment:
+      name:  pypi
+      url: https://pypi.org/project/tljh-matlab
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: install_guides/the-littlest-jupyterhub/tljh-matlab/dist/
+
+      - name: Publish to PyPI.
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: install_guides/the-littlest-jupyterhub/tljh-matlab/dist

.github/workflows/run-e2e-tests.yml

@@ -1,6 +1,6 @@
 # Copyright 2023-2024 The MathWorks, Inc.
 
-name: End-to-End Tests for Jupyter Integration for MATLAB
+name: End-to-End Tests for MATLAB Integration for Jupyter
 on:
   workflow_call:
 
@@ -15,14 +15,14 @@ jobs:
       PYTHON_VERSION: 3.8
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           node-version: ${{ env.NODE_VERSION }}
 
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ env.PYTHON_VERSION }}
 
@@ -39,18 +39,16 @@ jobs:
 
       - name: Set up MATLAB
         # Use MATLAB Actions to get running MATLAB in GitHub Actions
-        uses: matlab-actions/setup-matlab@v2-beta
+        uses: matlab-actions/setup-matlab@v2
         with:
           products: MATLAB Symbolic_Math_Toolbox
 
-
-
       - name: Install jupyterlab and jupyter-matlab-proxy
         working-directory: ${{ github.workspace }}
         run: |
           python3 -m pip install --upgrade pip
           python3 -m pip install ".[dev]"
-          python3 -m pip install "jupyterlab>3.1.0,<4.0.0"
+          python3 -m pip install "jupyterlab>4.0.0,<5.0.0"
 
       - name: Install playwright browsers
         run: npx playwright install --with-deps
@@ -73,8 +71,8 @@ jobs:
         run: |
           python3 -m pip install --upgrade pip
           python3 -m pip install pytest-playwright
-          python3 -m playwright install
-          python3 -c "from tests.utils.licensing import *; license_with_online_licensing(log_dir=\"./licensing-logs\")"
+          python3 -m playwright install chromium --with-deps
+          (cd tests/utils && python3 -c "from licensing import *; license_with_online_licensing(log_dir=\"./licensing-logs\")")
 
       - name: Run playwright tests
         env:
@@ -99,7 +97,7 @@ jobs:
 
       - name: Preserve test results after the job has finished
         if: always()
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: e2e_test_results
           path: ./tests/e2e/zipped-e2e-test-results.zip

.github/workflows/run-integration-tests.yml

@@ -1,11 +1,9 @@
-# Copyright 2020-2023 The MathWorks, Inc.
+# Copyright 2023-2024 The MathWorks, Inc.
 
-# Workflow that contains jobs to test MATLAB Jupyter Integration
-name: Integration testing MATLAB Jupyter Integration
+name: Integration testing MATLAB Integration for Jupyter
 
 on:
   # Reusable workflow
-  # Trigger on workflow call
   workflow_call:
 
 jobs:
@@ -19,16 +17,16 @@ jobs:
 
         # The minimum matlab-release is set to 21b as 20b and 21a are not supported by matlab-actions/setup-matlab.
         # See https://github.com/matlab-actions/setup-matlab/issues/76
-        matlab-release: [R2021b, R2023a]
+        matlab-release: [R2021b, latest]
 
     runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Set up MATLAB ${{ matrix.matlab-release }}
         # Use MATLAB Actions to get running MATLAB in GitHub Actions
-        uses: matlab-actions/setup-matlab@v2-beta
+        uses: matlab-actions/setup-matlab@v2
         with:
           release: ${{ matrix.matlab-release }}
           products: MATLAB Symbolic_Math_Toolbox
@@ -50,21 +48,25 @@ jobs:
       - name: Ensure browsers are installed for playwright
         run: python3 -m playwright install --with-deps
 
+      - name: License MATLAB Proxy
+        env:
+          TEST_USERNAME: ${{ secrets.TEST_USERNAME }}
+          TEST_PASSWORD: ${{ secrets.TEST_PASSWORD }}
+        run: |
+          python3 -c "from tests.integration.utils import licensing; licensing.start_and_license_matlab_proxy_using_jsp()"
+
       - name: Integration test with pytest
-        run: python3 -m pytest tests/integration -vs
         env:
-          TEST_USERNAME: ${{secrets.TEST_USERNAME}}
-          TEST_PASSWORD: ${{secrets.TEST_PASSWORD}}
+          MWI_LOG_LEVEL: "DEBUG"
+          MWI_LOG_FILE: ${{github.workspace}}/tests/integration/integ_logs.log
 
-      - name: Copy Log File
-        if: ${{ always() }}
-        run: |
-          cp ${{ github.workspace }}/tests/integration/integ_logs.log ${{ matrix.os }}${{ matrix.matlab-release }}${{ matrix.python-version }}.log
+        run: python3 -m pytest tests/integration -vs
 
-      - name: Make logs files available for downloading
+      - name: Preserve test logs
         if: ${{ always() }}
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
-          name: MATLAB Proxy Integration Test Log File
-          path: ${{ matrix.os }}${{ matrix.matlab-release }}${{ matrix.python-version }}.log
-          retention-days: 7
+          name: MATLAB Proxy Integration Test Log File ${{ matrix.os }} matlab-${{ matrix.matlab-release }} python-${{ matrix.python-version }}
+          path: |
+            tests/integration/integ_logs.log
+            licensing-screenshot-failed.png