spikeinterface/.github/workflows/cross_version_serialization.yml at 75d0bb20e2ef4e8a40259f7e8ea86574c6283415 · SpikeInterface/spikeinterface · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
name: Cross-version serialization

# Loads objects serialized by an old spikeinterface release with the current code, to
# catch changes that silently break loading of old saved files (moved classes, changed
# constructor signatures, changed on-disk encodings).
#
# Delivery model: Live generation. Fixtures are regenerated from a real old install each
# run in an isolated uv environment (nothing committed). The version list is computed
# from PyPI (latest patch of each minor at or above MIN_VERSION_TO_TEST), and the full
# matrix is tested on every pull request and on manual dispatch.

on:
  pull_request:
    types: [synchronize, opened, reopened]
    branches:
      - main
    # Only trigger when a change could affect whether old files still load: the code
    # under test (core), the serialization harness, or this workflow itself. Note this
    # watches core only; a break introduced in generation/ or preprocessing/ would not
    # trigger it.
    paths:
      - 'src/spikeinterface/core/**'
      - '.github/scripts/serialization/**'
      - '.github/workflows/cross_version_serialization.yml'
  workflow_dispatch:

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  # Compute which released versions the matrix below tests loading from, exposed as the
  # job output `list`: the latest patch of each minor at or above the floor, tested on
  # every trigger.
  versions:
    name: Select versions
    runs-on: ubuntu-latest
    outputs:
      list: ${{ steps.set.outputs.list }}
    steps:
      - uses: actions/setup-python@v6
        with:
          python-version: "3.10"
      - id: set
        env:
          # Support floor: oldest minor to test. Below this, installs fail on the CI
          # Python (numcodecs dependency rot in 0.100/0.101). Raise when 0.102 rots.
          MIN_VERSION_TO_TEST: "0.102" # We will change this when making breaking changes (hopefully not too often)
        run: |
          python -m pip install -q packaging
          available_versions=$(python -m pip index versions spikeinterface | sed -n 's/.*Available versions: //p')

          versions_to_test=$(AVAILABLE_VERSIONS="$available_versions" python -c "
          import json, os
          from itertools import groupby
          from packaging.version import Version

          floor = Version(os.environ['MIN_VERSION_TO_TEST'])
          available = sorted(Version(v.strip()) for v in os.environ['AVAILABLE_VERSIONS'].split(','))

          # exclude prereleases and versions below the floor, then take the latest
          # patch of each minor
          candidates = [v for v in available if not v.is_prerelease and (v.major, v.minor) >= (floor.major, floor.minor)]
          minor_releases = [max(group) for _, group in groupby(candidates, key=lambda v: (v.major, v.minor))]

          print(json.dumps([str(v) for v in minor_releases]))
          ")

          echo "list=$versions_to_test" >> "$GITHUB_OUTPUT"

  cross-version:
    needs: versions
    name: Load fixtures from ${{ matrix.si-version }}
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        si-version: ${{ fromJSON(needs.versions.outputs.list) }}
    env:
      SI_SERIALIZATION_FIXTURES_DIR: ${{ github.workspace }}/serialization_fixtures
    steps:
      - name: Check out code
        uses: actions/checkout@v6

      - name: Set up Python
        uses: actions/setup-python@v6
        with:
          python-version: "3.10"

      - name: Set up uv
        uses: astral-sh/setup-uv@v7
        with:
          python-version: "3.10"
          enable-cache: false

      - name: Generate fixtures with spikeinterface ${{ matrix.si-version }}
        run: |
          uv run --isolated --no-project --python 3.10 \
            --with "spikeinterface[core]==${{ matrix.si-version }}" \
            python .github/scripts/serialization/serialize_objects.py "$SI_SERIALIZATION_FIXTURES_DIR"

      - name: Load fixtures with the branch
        run: |
          uv pip install --system -e . --group test-core
          pytest .github/scripts/serialization/test_cross_version_compatibility.py -v