Switch to Pixi for development / CI and hatchling for build system #10103
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: tests | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| branches: | |
| - "*" | |
| workflow_dispatch: | |
| inputs: | |
| target: | |
| description: "How much of the test suite to run" | |
| type: choice | |
| default: default | |
| options: | |
| - default | |
| - full | |
| - downstream | |
| cache: | |
| description: "Use cache" | |
| type: boolean | |
| default: true | |
| schedule: | |
| - cron: "0 19 * * SUN" | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} | |
| cancel-in-progress: true | |
| defaults: | |
| run: | |
| shell: bash -el {0} | |
| env: | |
| DISPLAY: ":99.0" | |
| PYTHONIOENCODING: "utf-8" | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| COV: "--cov=./panel --cov-report=xml" | |
| jobs: | |
| pre_commit: | |
| name: Run pre-commit | |
| runs-on: "ubuntu-latest" | |
| steps: | |
| - uses: holoviz-dev/holoviz_tasks/pre-commit@v0 | |
| - uses: pre-commit/[email protected] | |
| with: | |
| extra_args: -a --hook-stage manual oxipng || true -- | |
| - uses: stefanzweifel/git-auto-commit-action@v4 | |
| with: | |
| commit_message: "Optimize PNG images (lossless)" | |
| file_pattern: "*.png" | |
| setup: | |
| name: Setup workflow | |
| runs-on: ubuntu-latest | |
| permissions: | |
| pull-requests: read | |
| outputs: | |
| code_change: ${{ steps.filter.outputs.code }} | |
| doc_change: ${{ steps.filter.outputs.doc }} | |
| matrix: ${{ env.MATRIX }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| if: github.event_name != 'pull_request' | |
| - name: Check for code changes | |
| uses: dorny/paths-filter@v3 | |
| id: filter | |
| with: | |
| filters: | | |
| code: | |
| - 'panel/**' | |
| - 'examples/**' | |
| - 'pixi.toml' | |
| - 'pyproject.toml' | |
| - '.github/workflows/test.yaml' | |
| doc: | |
| - 'doc/getting_started/**' | |
| - 'doc/how_to/**' | |
| - 'scripts/**' | |
| - 'lite/**' | |
| - name: Set matrix option | |
| run: | | |
| if [[ '${{ github.event_name }}' == 'workflow_dispatch' ]]; then | |
| OPTION=${{ github.event.inputs.target }} | |
| elif [[ '${{ github.event_name }}' == 'schedule' ]]; then | |
| OPTION="full" | |
| elif [[ '${{ github.event_name }}' == 'push' && '${{ github.ref_type }}' == 'tag' ]]; then | |
| OPTION="full" | |
| else | |
| OPTION="default" | |
| fi | |
| echo "MATRIX_OPTION=$OPTION" >> $GITHUB_ENV | |
| - name: Set test matrix with 'default' option | |
| if: env.MATRIX_OPTION == 'default' | |
| run: | | |
| MATRIX=$(jq -nsc '{ | |
| "os": ["ubuntu-latest", "macos-14", "windows-latest"], | |
| "environment": ["test-39", "test-312"] | |
| }') | |
| echo "MATRIX=$MATRIX" >> $GITHUB_ENV | |
| - name: Set test matrix with 'full' option | |
| if: env.MATRIX_OPTION == 'full' | |
| run: | | |
| MATRIX=$(jq -nsc '{ | |
| "os": ["ubuntu-latest", "macos-14", "windows-latest"], | |
| "environment": ["test-39", "test-310", "test-311", "test-312"] | |
| }') | |
| echo "MATRIX=$MATRIX" >> $GITHUB_ENV | |
| - name: Set test matrix with 'downstream' option | |
| if: env.MATRIX_OPTION == 'downstream' | |
| run: | | |
| MATRIX=$(jq -nsc '{ | |
| "os": ["ubuntu-latest"], | |
| "environment": ["test-312"] | |
| }') | |
| echo "MATRIX=$MATRIX" >> $GITHUB_ENV | |
| pixi_lock: | |
| name: Pixi lock | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: holoviz-dev/holoviz_tasks/pixi_lock@pixi | |
| with: | |
| cache: ${{ github.event.inputs.cache == 'true' || github.event.inputs.cache == '' }} | |
| unit_test_suite: | |
| name: unit:${{ matrix.environment }}:${{ matrix.os }} | |
| needs: [pre_commit, setup, pixi_lock] | |
| runs-on: ${{ matrix.os }} | |
| if: needs.setup.outputs.code_change == 'true' | |
| strategy: | |
| fail-fast: false | |
| matrix: ${{ fromJson(needs.setup.outputs.matrix) }} | |
| timeout-minutes: 90 | |
| steps: | |
| - if: inputs.opengl == 'true' && runner.os == 'Linux' | |
| run: | | |
| echo "::group::Install OpenGL" | |
| sudo apt-get install libglu1-mesa | |
| /sbin/start-stop-daemon --start --quiet --pidfile /tmp/custom_xvfb_99.pid --make-pidfile --background --exec /usr/bin/Xvfb -- :99 -ac -screen 0 1280x1024x24 | |
| sleep 3 | |
| - uses: holoviz-dev/holoviz_tasks/pixi_install@pixi | |
| if: needs.setup.outputs.code_change == 'true' | |
| with: | |
| environments: ${{ matrix.environment }} | |
| # opengl: true | |
| # - name: override-vtk-osmesa | |
| # if: contains(matrix.os, 'ubuntu') | |
| # run: | | |
| # conda activate test-environment | |
| # conda install -c conda-forge vtk=9.2.6=osmesa* vtk-base=9.2.6=osmesa* vtk-io-ffmpeg=9.2.6=osmesa* --no-deps | |
| - name: Test unit | |
| run: | | |
| pixi run -e ${{ matrix.environment }} test-unit $COV | |
| - name: Test subprocess | |
| if: contains(matrix.os, 'ubuntu') | |
| run: | | |
| pixi run -e ${{ matrix.environment }} test-subprocess $COV | |
| - name: Test docs | |
| run: | | |
| pixi run -e ${{ matrix.environment }} test-docs $COV | |
| - name: Test Examples | |
| run: | | |
| pixi run -e ${{ matrix.environment }} test-example | |
| - uses: codecov/codecov-action@v4 | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| ui_test_suite: | |
| name: ui:${{ matrix.environment }}:${{ matrix.os }} | |
| needs: [pre_commit, setup, pixi_lock] | |
| runs-on: ${{ matrix.os }} | |
| if: needs.setup.outputs.code_change == 'true' || needs.setup.outputs.doc_change == 'true' | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: ["ubuntu-latest", "macos-latest", "windows-latest"] | |
| environment: ["test-ui"] | |
| timeout-minutes: 120 | |
| env: | |
| PANEL_LOG_LEVEL: info | |
| OAUTH_COOKIE_SECRET: ${{ secrets.OAUTH_COOKIE_SECRET }} | |
| OAUTH_ENCRYPTION_KEY: ${{ secrets.OAUTH_ENCRYPTION_KEY }} | |
| AUTH0_PORT: "5701" | |
| AUTH0_OAUTH_KEY: ${{ secrets.AUTH0_OAUTH_KEY }} | |
| AUTH0_OAUTH_SECRET: ${{ secrets.AUTH0_OAUTH_SECRET }} | |
| AUTH0_OAUTH_EXTRA_PARAMS: ${{ secrets.AUTH0_OAUTH_EXTRA_PARAMS }} | |
| AUTH0_OAUTH_USER: ${{ secrets.AUTH0_OAUTH_USER }} | |
| AUTH0_OAUTH_PASSWORD: ${{ secrets.AUTH0_OAUTH_PASSWORD }} | |
| AZURE_PORT: "5702" | |
| AZURE_OAUTH_KEY: ${{ secrets.AZURE_OAUTH_KEY }} | |
| AZURE_OAUTH_SECRET: ${{ secrets.AZURE_OAUTH_SECRET }} | |
| AZURE_OAUTH_USER: ${{ secrets.AZURE_OAUTH_USER }} | |
| AZURE_OAUTH_PASSWORD: ${{ secrets.AZURE_OAUTH_PASSWORD }} | |
| OKTA_PORT: "5703" | |
| OKTA_OAUTH_KEY: ${{ secrets.OKTA_OAUTH_KEY }} | |
| OKTA_OAUTH_SECRET: ${{ secrets.OKTA_OAUTH_SECRET }} | |
| OKTA_OAUTH_EXTRA_PARAMS: ${{ secrets.OKTA_OAUTH_EXTRA_PARAMS }} | |
| OKTA_OAUTH_USER: ${{ secrets.OKTA_OAUTH_USER }} | |
| OKTA_OAUTH_PASSWORD: ${{ secrets.OKTA_OAUTH_PASSWORD }} | |
| steps: | |
| - uses: holoviz-dev/holoviz_tasks/pixi_install@pixi | |
| with: | |
| environments: ${{ matrix.environment }} | |
| id: install | |
| - name: launch jupyter | |
| run: | | |
| pixi run -e ${{ matrix.environment }} jupyter server extension enable panel.io.jupyter_server_extension --sys-prefix | |
| (pixi run -e ${{ matrix.environment }} jupyter lab --config panel/tests/ui/jupyter_server_test_config.py --port 8887 > /tmp/jupyterlab_server.log 2>&1) & | |
| - name: build jupyterlite | |
| run: | | |
| # TODO: Make this a pixi feature/environment | |
| pixi run -e ${{ matrix.environment }} python -m pip install -r ./lite/requirements.txt | |
| pixi run -e ${{ matrix.environment }} python ./scripts/build_pyodide_wheels.py lite/pypi | |
| pixi run -e ${{ matrix.environment }} python ./scripts/panelite/generate_panelite_content.py | |
| pixi run -e ${{ matrix.environment }} jupyter lite build --lite-dir lite --output-dir lite/dist | |
| - name: Wait for JupyterLab | |
| uses: ifaxity/[email protected] | |
| with: | |
| resource: http-get://localhost:8887/lab | |
| timeout: 180000 | |
| - name: Test UI | |
| run: | | |
| # Create a .uicoveragerc file to set the concurrency library to greenlet | |
| # https://github.com/microsoft/playwright-python/issues/313 | |
| echo "[run]\nconcurrency = greenlet" > .uicoveragerc | |
| FAIL="--screenshot only-on-failure --full-page-screenshot --output ui_screenshots" | |
| pixi run -e ${{ matrix.environment }} test-ui --jupyter $COV --cov-config=.uicoveragerc $FAIL | |
| - uses: actions/upload-artifact@v3 | |
| if: always() | |
| with: | |
| name: ui_screenshots | |
| path: ./ui_screenshots | |
| if-no-files-found: ignore | |
| - uses: codecov/codecov-action@v4 | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| core_test_suite: | |
| name: core:${{ matrix.environment }}:${{ matrix.os }} | |
| needs: [pre_commit, setup, pixi_lock] | |
| runs-on: ${{ matrix.os }} | |
| if: needs.setup.outputs.code_change == 'true' | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: ["ubuntu-latest"] | |
| environment: ["test-core"] | |
| timeout-minutes: 120 | |
| steps: | |
| - uses: holoviz-dev/holoviz_tasks/pixi_install@pixi | |
| with: | |
| environments: ${{ matrix.environment }} | |
| - name: Test Unit | |
| run: | | |
| pixi run -e ${{ matrix.environment }} test-unit |