Add breakage CI (#258)

* Add MRIBase breakage tests

* Add MRIOperators breakage test

Author: nHackel

.github/workflows/ci_mribase.yml

@@ -63,4 +63,44 @@ jobs:
         with:
           file: lcov.info
           token: ${{ secrets.CODECOV_TOKEN }}
-          flags: MRIBase
+          flags: MRIBase
+          
+  # Based on https://github.com/SciML/OrdinaryDiffEq.jl/blob/master/.github/workflows/Downstream.yml
+  breakage:
+    name: Breakage ${{ matrix.package }} (Julia ${{ matrix.julia-version}})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        julia-version:
+          - '1.10'
+        os:
+          - ubuntu-latest
+        package:
+          - MRIOperators
+          - MRISimulation
+          - MRICoilSensitivities
+          - MRISampling
+          - MRIFiles
+          - MRIReco
+    steps:
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
+        with:
+          version: ${{ matrix.julia-version }}
+          arch: x64
+      - name: Test Breakage ${{ matrix.package }}
+        env:
+          BREAK_PKG: ${{ matrix.package }}
+        shell: julia --color=yes {0}
+        run: |
+          using Pkg
+          try
+            Pkg.add(ENV["BREAK_PKG"]) # Add for release version
+            Pkg.develop([PackageSpec(path=pwd(), subdir="MRIBase")])
+            Pkg.test(ENV["BREAK_PKG"], coverage=true)  # resolver may fail with test time depsAdd commentMore actions
+          catch err
+            err isa Pkg.Resolve.ResolverError || rethrow()
+            @info "Not compatible with this release. No need to check for breakage" exception=err
+            exit(0)
+          end

.github/workflows/ci_mrioperators.yml

@@ -67,4 +67,40 @@ jobs:
         with:
           file: lcov.info
           token: ${{ secrets.CODECOV_TOKEN }}
-          flags: MRIOperators
+          flags: MRIOperators
+
+  # Based on https://github.com/SciML/OrdinaryDiffEq.jl/blob/master/.github/workflows/Downstream.yml
+  breakage:
+    name: Breakage ${{ matrix.package }} (Julia ${{ matrix.julia-version}})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        julia-version:
+          - '1.10'
+        os:
+          - ubuntu-latest
+        package:
+          - MRISimulation
+          - MRIReco
+    steps:
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
+        with:
+          version: ${{ matrix.julia-version }}
+          arch: x64
+      - name: Test Breakage ${{ matrix.package }}
+        env:
+          BREAK_PKG: ${{ matrix.package }}
+        shell: julia --color=yes {0}
+        run: |
+          using Pkg
+          try
+            Pkg.add(ENV["BREAK_PKG"]) # Add for release version
+            Pkg.develop([PackageSpec(path=pwd(), subdir="MRIOperators")])
+            Pkg.test(ENV["BREAK_PKG"], coverage=true)  # resolver may fail with test time depsAdd commentMore actions
+          catch err
+            err isa Pkg.Resolve.ResolverError || rethrow()
+            @info "Not compatible with this release. No need to check for breakage" exception=err
+            exit(0)
+          end

MRIBase/src/MRIBase.jl

@@ -3,6 +3,7 @@ module MRIBase
 using AbstractNFFTs
 using NFFTTools # for density compensation weights in trajectory
 
+
 include("Trajectories/Trajectories.jl")
 include("Datatypes/Datatypes.jl")
 include("Datatypes/Flags.jl")