benchmark.yml

name: JupyterLab Benchmark Tests

on:
  workflow_dispatch:
    inputs:
      challenger:
        description: "JupyterLab Git repository with the challenger version (format {owner}/{repo})"
        required: true
      challenger_branch:
        description: "Git repository reference to the challenger branch"
        required: true
      challenger_project:
        description: "Playwright project to execute (windowingMode JupyterLab 4; renderCellOnIdle: JupyterLab 2.3 or 3.x)"
        required: false
        default: "jupyterlab"
        type: choice
        options:
          - jupyterlab
          - jupyterlab-renderCellOnIdle-on
          - jupyterlab-renderCellOnIdle-off
          - jupyterlab-windowingMode-full
          - jupyterlab-windowingMode-defer
          - jupyterlab-windowingMode-none
          - jupyterlab-1-2
          - retrolab
          - testing
      reference_branch:
        description: "Reference branch on the JupyterLab repository (default: master)"
        required: false
        default: "master"
      reference_project:
        description: "Playwright project to execute on the reference version"
        required: false
        default: ""
        type: choice
        options:
          - jupyterlab
          - jupyterlab-renderCellOnIdle-on
          - jupyterlab-renderCellOnIdle-off
          - jupyterlab-windowingMode-full
          - jupyterlab-windowingMode-defer
          - jupyterlab-windowingMode-none
          - jupyterlab-1-2
          - retrolab
          - testing
      browser:
        description: "Which browser to use (default 'chromium')"
        required: false
        default: "chromium"
        type: choice
        options:
          - chromium
          - firefox
          - webkit
      samples:
        description: "Number of samples to compute"
        required: false
        default: "100"
      tests:
        description: 'List of test notebooks to include (available ["codeNotebook", "mdNotebook", "largeMetadata", "largePlotly", "longOutput", "manyPlotly", "manyOutputs", "errorOutputs"])'
        required: false
        default: '["codeNotebook", "mdNotebook", "longOutput"]'
      test_steps:
        description: 'List of test steps for each notebook (available ["open", "switch-with-copy", "switch-with-txt", "search", "start-debug", "close"])'
        required: false
        default: '["open", "switch-with-copy", "switch-with-txt", "close"]'
      size:
        description: "Test files size (bigger means larger test files)"
        required: false
        default: "100"

permissions:
  issues: write

jobs:
  test:
    # uses: jupyterlab/benchmarks/.github/workflows/run-benchmark.yml@master
    uses: ./.github/workflows/run-benchmark.yml
    with:
      event: ${{ github.event_name }}
      # Repository to clone for scheduled benchmark
      challenger: ${{ github.event.inputs.challenger || 'jupyterlab/jupyterlab' }}
      # Branch to checkout for scheduled benchmark
      challenger_branch: ${{ github.event.inputs.challenger_branch || 'master' }}
      challenger_project: ${{ github.event.inputs.challenger_project || 'jupyterlab' }}
      reference_branch: ${{ github.event.inputs.reference_branch || 'master' }}
      reference_project: ${{ github.event.inputs.reference_project || 'jupyterlab' }}
      # Which browser to use (one of 'chromium', 'firefox', 'webkit')
      browser: ${{ github.event.inputs.browser || 'chromium' }}
      # How many samples to compute the statistical distribution
      samples: ${{ github.event.inputs.samples || '100' }}
      # Notebooks to test
      tests: ${{ github.event.inputs.tests || '["codeNotebook", "mdNotebook", "longOutput"]' }}
      # Test steps to measure on each test notebook
      test_steps: ${{ github.event.inputs.test_steps || '["open", "switch-with-copy", "switch-with-txt", "close"]' }}
      # The test notebook size
      size: ${{ github.event.inputs.size || '100' }}
      artifacts_name: 'benchmarks-report'