cirq_compatibility.yml

# Copyright 2025 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

name: 'Nightly Cirq compatibility test'
run-name: Regularly test code against latest Cirq dev release

on:
  schedule:
    - cron: "10 7 * * *"

  workflow_dispatch:
    inputs:
      debug:
        description: 'Run with debugging options'
        type: boolean
        default: true

permissions: read-all

concurrency:
  # Cancel any previously-started but still active runs on the same branch.
  cancel-in-progress: true
  group: ${{github.workflow}}-${{github.event.pull_request.number||github.ref}}

jobs:
  test-compatibility:
    name: Test Cirq compatibility
    runs-on: ubuntu-24.04
    timeout-minutes: 30
    env:
      PIP_CONSTRAINT: .github/workflows/pip-constraints.txt
    steps:
      - name: Check out a copy of the git repository
        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
        with:
          fetch-depth: 1
          submodules: recursive

      - name: Set up Python with caching of pip dependencies
        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5
        with:
          python-version: '3.12'
          cache: pip
          cache-dependency-path: |
            requirements.txt
            dev-requirements.txt

      - name: Install latest dev version of Cirq
        run: pip install --upgrade cirq~=1.0.dev

      - name: Install qsim dev requirements
        run: |
          pip install -r requirements.txt
          pip install -r dev-requirements.txt

      - name: Run Python tests
        env:
          MAKEFLAGS: ${{inputs.debug && '--debug=b' || '' }}
          PYTEST_ADDOPTS: ${{inputs.debug && '-v' || '' }}
        run: make -j run-py-tests