Add compat workflows.

.github/CHANGELOG.md

@@ -7,6 +7,9 @@
 
 ### Breaking changes
 
+* Add workflows validating compatibility between PennyLane and Lightning's most recent stable releases and development versions.
+  [(#498)](https://github.com/PennyLaneAI/pennylane-lightning/pull/498)
+
 * Enums defined in `GateOperation.hpp` start at `1` (previously `0`). `::BEGIN` is introduced in a few places where it was assumed `0` accordingly.
   [(#485)](https://github.com/PennyLaneAI/pennylane-lightning/pull/485)
 

.github/workflows/compat-check-latest-latest.yml

@@ -0,0 +1,20 @@
+name: Compat Check w/PL - latest/latest
+
+on:
+  schedule:
+    - cron: "0 3 * * 1-5"  # Run daily at 3am Mon-Fri
+  workflow_dispatch:
+
+jobs:
+  tests_linux:
+    name: Lightning-Kokkos Compatibility test (tests_linux) - latest/latest
+    uses: ./.github/workflows/tests_linux.yml
+    with:
+      lightning-version: latest
+      pennylane-version: latest
+  tests_without_binary:
+    name: Lightning-Kokkos Compatibility test (tests_without_binary) - latest/latest
+    uses: ./.github/workflows/tests_without_binary.yml
+    with:
+      lightning-version: latest
+      pennylane-version: latest

.github/workflows/compat-check-latest-stable.yml

@@ -0,0 +1,20 @@
+name: Compat Check w/PL - latest/stable
+
+on:
+  schedule:
+    - cron: "0 3 * * 1-5"  # Run daily at 3am Mon-Fri
+  workflow_dispatch:
+
+jobs:
+  tests_linux:
+    name: Lightning-Kokkos Compatibility test (tests_linux) - latest/stable
+    uses: ./.github/workflows/tests_linux.yml
+    with:
+      lightning-version: latest
+      pennylane-version: stable
+  tests_without_binary:
+    name: Lightning-Kokkos Compatibility test (tests_without_binary) - latest/stable
+    uses: ./.github/workflows/tests_without_binary.yml
+    with:
+      lightning-version: latest
+      pennylane-version: stable

.github/workflows/compat-check-stable-latest.yml

@@ -0,0 +1,20 @@
+name: Compat Check w/PL - stable/latest
+
+on:
+  schedule:
+    - cron: "0 3 * * 1-5"  # Run daily at 3am Mon-Fri
+  workflow_dispatch:
+
+jobs:
+  tests_linux:
+    name: Lightning-Kokkos Compatibility test (tests_linux) - stable/latest
+    uses: ./.github/workflows/tests_linux.yml
+    with:
+      lightning-version: stable
+      pennylane-version: latest
+  tests_without_binary:
+    name: Lightning-Kokkos Compatibility test (tests_without_binary) - stable/latest
+    uses: ./.github/workflows/tests_without_binary.yml
+    with:
+      lightning-version: stable
+      pennylane-version: latest

.github/workflows/compat-check-stable-stable.yml

@@ -0,0 +1,20 @@
+name: Compat Check w/PL - stable/stable
+
+on:
+  schedule:
+    - cron: "0 3 * * 1-5"  # Run daily at 3am Mon-Fri
+  workflow_dispatch:
+
+jobs:
+  tests_linux:
+    name: Lightning-Kokkos Compatibility test (tests_linux) - stable/stable
+    uses: ./.github/workflows/tests_linux.yml
+    with:
+      lightning-version: stable
+      pennylane-version: stable
+  tests_without_binary:
+    name: Lightning-Kokkos Compatibility test (tests_without_binary) - stable/stable
+    uses: ./.github/workflows/tests_without_binary.yml
+    with:
+      lightning-version: stable
+      pennylane-version: stable

.github/workflows/tests_linux.yml

@@ -1,5 +1,15 @@
 name: Testing (Linux)
 on:
+  workflow_call:
+    inputs:
+      lightning-version:
+        type: string
+        required: true
+        description: The version of lightning to use. Valid values are either 'stable' (most recent git-tag) or 'latest' (most recent commit from master)
+      pennylane-version:
+        type: string
+        required: true
+        description: The version of PennyLane to use. Valid values are either 'stable' (most recent git-tag) or 'latest' (most recent commit from master)
   pull_request:
   push:
     branches:
@@ -13,11 +23,12 @@ env:
   OMP_NUM_THREADS: "2"
 
 concurrency:
-  group: tests_linux-${{ github.ref }}
+  group: tests_linux-${{ github.ref }}-${{ inputs.lightning-version }}-${{ inputs.pennylane-version }}
   cancel-in-progress: true
 
 jobs:
   cpptests:
+    if: ${{ github.event_name != 'workflow_call' || (inputs.lightning-version == 'latest' &&  inputs.pennylane-version == 'latest') }}
     strategy:
       matrix:
         os: [ubuntu-22.04]
@@ -97,7 +108,16 @@ jobs:
         uses: actions/checkout@v3
         with:
           path: main
-          fetch-depth: 2
+          fetch-depth: ${{ inputs.lightning-version == 'stable' && 0 || 2 }}
+
+      - name: Switch to stable build of Lightning
+        if: inputs.lightning-version == 'stable'
+        run: |
+          cd main
+          git fetch --all --tags
+          git checkout $(git tag | sort -V | tail -1)
+          git log -1 --format='%H'
+          git status
 
       - uses: actions/setup-python@v4
         name: Install Python
@@ -112,6 +132,12 @@ jobs:
           cd main
           python -m pip install -r requirements-dev.txt
 
+      - name: Install Stable PennyLane
+        if: inputs.pennylane-version == 'stable'
+        run: |
+          cd main
+          python -m pip uninstall -y pennylane && python -m pip install -U pennylane
+
       - name: Install ML libraries for interfaces
         run: |
           python -m pip install --upgrade torch==$TORCH_VERSION -f https://download.pytorch.org/whl/cpu/torch_stable.html
@@ -140,6 +166,7 @@ jobs:
           path: ./main/coverage-${{ github.job }}-${{ matrix.pl_backend }}.xml
 
   cpptestswithOpenBLAS:
+    if: ${{ github.event_name != 'workflow_call' || (inputs.lightning-version == 'latest' &&  inputs.pennylane-version == 'latest') }}
     strategy:
       matrix:
         os: [ubuntu-22.04]
@@ -222,6 +249,15 @@ jobs:
           path: main
           fetch-depth: 2
 
+      - name: Switch to stable build of Lightning
+        if: inputs.lightning-version == 'stable'
+        run: |
+          cd main
+          git fetch --all --tags
+          git checkout $(git tag | sort -V | tail -1)
+          git log -1 --format='%H'
+          git status
+
       - uses: actions/setup-python@v4
         name: Install Python
         with:
@@ -235,6 +271,12 @@ jobs:
           cd main
           python -m pip install -r requirements-dev.txt
 
+      - name: Install Stable PennyLane
+        if: inputs.pennylane-version == 'stable'
+        run: |
+          cd main
+          python -m pip uninstall -y pennylane && python -m pip install -U pennylane
+
       - name: Install ML libraries for interfaces
         run: |
           python -m pip install --upgrade torch==$TORCH_VERSION -f https://download.pytorch.org/whl/cpu/torch_stable.html
@@ -269,6 +311,7 @@ jobs:
       os: ubuntu-22.04
 
   cpptestswithKokkos:
+    if: ${{ github.event_name != 'workflow_call' || (inputs.lightning-version == 'latest' &&  inputs.pennylane-version == 'latest') }}
     needs: [build_and_cache_Kokkos]
     strategy:
       matrix:
@@ -372,6 +415,15 @@ jobs:
           path: main
           fetch-depth: 2
 
+      - name: Switch to stable build of Lightning
+        if: inputs.lightning-version == 'stable'
+        run: |
+          cd main
+          git fetch --all --tags
+          git checkout $(git tag | sort -V | tail -1)
+          git log -1 --format='%H'
+          git status
+
       - uses: actions/setup-python@v4
         name: Install Python
         with:
@@ -398,6 +450,12 @@ jobs:
           cd main
           python -m pip install -r requirements-dev.txt
 
+      - name: Install Stable PennyLane
+        if: inputs.pennylane-version == 'stable'
+        run: |
+          cd main
+          python -m pip uninstall -y pennylane && python -m pip install -U pennylane
+
       - name: Install ML libraries for interfaces
         run: |
           python -m pip install --upgrade torch==$TORCH_VERSION -f https://download.pytorch.org/whl/cpu/torch_stable.html
@@ -490,6 +548,7 @@ jobs:
 
   cpptestsWithMultipleBackends:
   # Device-specific tests are performed for both. Device-agnostic tests default to LightningQubit.
+    if: ${{ github.event_name != 'workflow_call' || (inputs.lightning-version == 'latest' &&  inputs.pennylane-version == 'latest') }}
     needs: [build_and_cache_Kokkos]
     strategy:
       matrix:

.github/workflows/tests_without_binary.yml

@@ -1,15 +1,26 @@
 name: Testing without binary
 on:
+  workflow_call:
+    inputs:
+      lightning-version:
+        type: string
+        required: true
+        description: The version of lightning to use. Valid values are either 'stable' (most recent git-tag) or 'latest' (most recent commit from master)
+      pennylane-version:
+        type: string
+        required: true
+        description: The version of PennyLane to use. Valid values are either 'stable' (most recent git-tag) or 'latest' (most recent commit from master)
+  pull_request:
   push:
     branches:
       - master
-  pull_request:
+
 
 env:
   COVERAGE_FLAGS: "--cov=pennylane_lightning --cov-report=term-missing --cov-report=xml:./coverage.xml --no-flaky-report -p no:warnings --tb=native"
 
 concurrency:
-  group: tests_without_binary-${{ github.ref }}
+  group: tests_without_binary-${{ github.ref }}-${{ inputs.lightning-version }}-${{ inputs.pennylane-version }}
   cancel-in-progress: true
 
 jobs:
@@ -26,6 +37,16 @@ jobs:
         uses: actions/checkout@v3
         with:
           path: main
+          fetch-depth: 2
+
+      - name: Switch to stable build of Lightning
+        if: inputs.lightning-version == 'stable'
+        run: |
+          cd main
+          git fetch --all --tags
+          git checkout $(git tag | sort -V | tail -1)
+          git log -1 --format='%H'
+          git status
 
       - uses: actions/setup-python@v4
         name: Install Python
@@ -37,6 +58,12 @@ jobs:
           cd main
           python -m pip install -r requirements-dev.txt
 
+      - name: Install Stable PennyLane
+        if: inputs.pennylane-version == 'stable'
+        run: |
+          cd main
+          python -m pip uninstall -y pennylane && python -m pip install -U pennylane
+
       - name: Install lightning.qubit device
         env:
           SKIP_COMPILATION: True

pennylane_lightning/core/_version.py

@@ -16,4 +16,4 @@
    Version number (major.minor.patch[-label])
 """
 
-__version__ = "0.33.0-dev9"
+__version__ = "0.33.0-dev10"