# Our minimal suite of tests that run on each pull request

name: PR Test

on:

pull_request:

branches:

- main

- "v*x"

concurrency:

group: test-${{ github.ref }}

cancel-in-progress: true

env:

COLUMNS: 120

jobs:

import_lint:

name: Import lint

timeout-minutes: 5

runs-on: ubuntu-latest

steps:

- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

with:

persist-credentials: false

- name: Set up Python 3.12

uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0

with:

python-version: 3.12

- name: Install dependencies

run: |

pip install --upgrade pip

pip install tox

- name: Run import lint

run: tox -e import-lint

manifest:

# make sure all necessary files will be bundled in the release

name: Check Manifest

timeout-minutes: 15

runs-on: ubuntu-latest

steps:

- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

with:

persist-credentials: false

- uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0

with:

python-version: "3.12"

cache-dependency-path: pyproject.toml

cache: 'pip'

- name: Install Dependencies

run: pip install --upgrade pip

- name: Install Napari dev

run: pip install -e . --group build

env:

PIP_CONSTRAINT: resources/constraints/constraints_py3.12.txt

- name: Make Typestubs

run: |

make typestubs

- name: Check Manifest

run: |

make check-manifest

localization_syntax:

# make sure all necessary files will be bundled in the release

name: Check l18n syntax

runs-on: ubuntu-latest

timeout-minutes: 2

steps:

- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

with:

persist-credentials: false

- uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0

with:

python-version: "3.x"

- name: Check localization formatting

run: |

pip install --upgrade pip semgrep

# f"..." and f'...' are the same for semgrep

semgrep --error --lang python --pattern 'trans._(f"...")' src/napari

semgrep --error --lang python --pattern "trans._(\$X.format(...))" src/napari

build_wheel:

name: Build wheel

uses: ./.github/workflows/reusable_build_wheel.yml

test_initial:

name: Initial test

uses: ./.github/workflows/reusable_run_tox_test.yml

needs: build_wheel

strategy:

fail-fast: false

matrix:

include:

- python: "3.10"

platform: ubuntu-latest

backend: pyqt5

coverage: no_cov

min_req: ""

- python: "3.14"

platform: ubuntu-latest

backend: pyqt6

coverage: no_cov

min_req: ""

with:

python_version: ${{ matrix.python }}

platform: ${{ matrix.platform }}

qt_backend: ${{ matrix.backend }}

coverage: ${{ matrix.coverage }}

min_req: ${{ matrix.MIN_REQ }}

artifacts_suffix: "initial"

test:

name: ${{ matrix.platform }}

uses: ./.github/workflows/reusable_run_tox_test.yml

needs: test_initial

strategy:

fail-fast: false

matrix:

platform: [ ubuntu-latest ]

python: [ "3.13" ]

backend: [ "pyqt5,pyqt6" ]

coverage: [ cov ]

include:

# Windows py310

- python: "3.11"

platform: windows-2022

backend: pyqt5

coverage: no_cov

- python: "3.13"

platform: windows-2022

backend: pyqt6

coverage: cov

- python: "3.13"

platform: macos-15-intel

backend: pyqt5_no_numba

coverage: no_cov

timeout-minutes: 60

- python: "3.13"

platform: macos-latest

backend: pyqt6

coverage: no_cov

timeout-minutes: 60

# minimum specified requirements

- python: "3.10"

platform: ubuntu-22.04

backend: pyqt5

MIN_REQ: 1

coverage: cov

- python: "3.12"

platform: ubuntu-22.04

backend: pyqt6

coverage: cov

tox_extras: "all_optional"

# test without any Qt backends

- python: "3.11"

platform: ubuntu-22.04

backend: headless

coverage: no_cov

# test with torch

- python: "3.13"

platform: ubuntu-latest

backend: pyqt6

coverage: cov

tox_extras: "testing_extra"

# test with no numba

- python: "3.13"

platform: ubuntu-latest

backend: pyqt6_no_numba

coverage: cov

# pyside6 test

- python: "3.13"

platform: ubuntu-latest

backend: pyside6

coverage: cov

# linux aarch64 test

- python: "3.14"

platform: ubuntu-24.04-arm

backend: pyqt6

coverage: cov

with:

python_version: ${{ matrix.python }}

platform: ${{ matrix.platform }}

qt_backend: ${{ matrix.backend }}

min_req: ${{ matrix.MIN_REQ }}

coverage: ${{ matrix.coverage }}

tox_extras: ${{ matrix.tox_extras }}

timeout: ${{ matrix.timeout-minutes || 40 }}

test_pip_install:

needs: test_initial

name: pip install

uses: ./.github/workflows/reusable_pip_test.yml

test_examples:

name: test examples

uses: ./.github/workflows/reusable_run_tox_test.yml

needs: test_initial

with:

toxenv: py312-linux-pyqt6-examples-cov

timeout: 60

python_version: 3.12

constraints_suffix: _examples

coverage: cov

coverage_report:

if: ${{ always() }}

secrets: inherit

needs:

- test

- test_examples

uses: napari/shared-workflows/.github/workflows/upload_coverage.yml@main

with:

artifact-pattern: 'coverage reports*'

test_benchmarks:

name: test benchmarks

runs-on: ubuntu-latest

needs: test_initial

timeout-minutes: 60

env:

GIT_LFS_SKIP_SMUDGE: 1

steps:

- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

with:

fetch-depth: 0

persist-credentials: false

- uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0

with:

python-version: 3.12

cache-dependency-path: pyproject.toml

- name: Setup headless display

uses: pyvista/setup-headless-display-action@5bc8de3bc71fcda7a96439571287a554901541a0 # v4.3

with:

qt: true

wm: herbstluftwm

- name: Download benchmark data

run: |

wget https://data.napari.dev/triangulation-benchmark-shapes.zip

unzip triangulation-benchmark-shapes.zip -d src/napari/benchmarks/

rm triangulation-benchmark-shapes.zip

- uses: octokit/request-action@45eef13998ff762839b0a0de9bbcf41970fd056d # v2.x

# here we get hash of the latest release commit to compare with PR

id: latest_release

with:

route: GET /repos/{owner}/{repo}/releases/latest

owner: napari

repo: napari

env:

GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: install dependencies

run: |

pip install --upgrade pip

pip install "asv[virtualenv]"

env:

PIP_CONSTRAINT: resources/constraints/benchmark.txt

- name: asv machine

run: asv machine --yes

- name: Run benchmarks PR

run: |

asv run --show-stderr --quick --attribute timeout=300 HEAD^!

env:

PR: 1 # prevents asv from running very compute-intensive benchmarks

PIP_CONSTRAINT: ${{ github.workspace }}/resources/constraints/benchmark.txt

- name: Run benchmarks latest release

# here we check if the benchmark on the latest release is not broken

run: |

asv run --show-stderr --quick --attribute timeout=300 ${{ fromJSON(steps.latest_release.outputs.data).target_commitish }}^!

env:

PR: 1 # prevents asv from running very compute-intensive benchmarks

PIP_CONSTRAINT: ${{ github.workspace }}/resources/constraints/benchmark.txt

- name: Upload triangulation artifacts

if: failure()

uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0

with:

name: triangulation-benchmarks

path: /tmp/napari*