workflow-template-stable.yml

# Workflow template for testing plugins against PennyLane stable

name: {{ plugin }}-{% if latest %}latest{% else %}stable{% endif %}-stable
on:
  push:
    branches:
      - master
  pull_request:
  schedule:
    - cron: '0 0 * * 0'
  workflow_dispatch:


env:
  PLUGIN_REPO: {{ gh_user }}/{{ plugin_repo }}
  PLUGIN_BRANCH: {% if branch %}{{ branch }}{% else %}master{% endif %}
  PLUGIN_PACKAGE: {{ plugin_package }}
  PENNYLANE_BRANCH: master
{%- if token is defined %}
  {{ token }}: {% raw %}${{ secrets.{% endraw %}{{ token }}{% raw %} }}{% endraw %}
{%- endif %}
{%- if additional_env_vars is defined %}
  {{ additional_env_vars }}
{%- endif %}


jobs:
  tests:
    runs-on: {% if runs_on is defined %}{{ runs_on }}{% else %}ubuntu-latest{% endif %}

    strategy:
      fail-fast: false

    steps:
      - name: Cancel Previous Runs
        uses: styfle/cancel-workflow-action@0.4.1
        with:
          access_token: {% raw %}${{ github.token }}{% endraw %}

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

{%- if additional_setup is defined %}
      {{ additional_setup | indent(6, True) }}
{%- endif %}

      - name: Install requirements
        run: |
          pip install --upgrade pip
          {%- for req in requirements %}
          pip install --upgrade {{ req }}
          {%- endfor %}
          pip install 'pytest<8.1.0' 
          pip install pytest-mock pytest-cov flaky pytest-benchmark
          pip freeze

     {%- if latest %}

      - name: Install PennyLane and Plugin
        run: |
          {% raw -%}
          pip install pennylane git+https://github.com/${{ env.PLUGIN_REPO }}.git@${{ env.PLUGIN_BRANCH }}
          {%- endraw %}

      - uses: actions/checkout@v2
        with:
          repository: {% raw %}${{ env.PLUGIN_REPO }}{% endraw %}
          path: plugin_repo
          ref: {% raw %}${{ env.PLUGIN_BRANCH }}{% endraw %}
      {% else %}

      - name: Install PennyLane and Plugin
        run: |
          {% raw -%}
          pip install pennylane ${{ env.PLUGIN_PACKAGE }} --upgrade
          {%- endraw %}
          pip freeze

      - name: Get plugin version
        id: plugin-version
        run: |
          {% raw -%}
          PLUGIN_VERSION=$(python -c "import pkg_resources as pkg; print(pkg.get_distribution('${{ env.PLUGIN_PACKAGE }}').version)")
          echo "version=$PLUGIN_VERSION" >> $GITHUB_OUTPUT
          {%- endraw %}

      - uses: actions/checkout@v2
        with:
          repository: {% raw %}${{ env.PLUGIN_REPO }}{% endraw %}
          path: plugin_repo
          ref: {% raw %}v${{ steps.plugin-version.outputs.version }}{% endraw %}
      {% endif -%}

      {% if device_tests -%}
      - name: Run PennyLane device integration tests
        run: |
          if ! [ -x "$(command -v pl-device-test)" ]; then
            echo 'Error: Version of PennyLane does not provide device integration tests.' >&2
          else
            {%- for test in device_tests %}
            pl-device-test {{ test }}
            {%- endfor %}
          fi
      {%- endif %}

      - name: Run plugin tests
        run: python -m pytest plugin_repo/{{ tests_loc }} --tb=short {%- for kwarg in test_kwargs %} {{ kwarg }} {%- endfor %}