ci-testing-pull-request.yml

# This workflow holds jobs which are required to pass before merging into master

name: PR CI
on:
  pull_request:
    branches:
      - "*"
  # https://github.blog/changelog/2023-02-08-pull-request-merge-queue-public-beta/
  merge_group:
    branches:
      - "master"

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

jobs:
  api-specs:
    timeout-minutes: 10
    name: "check OAS' are up to date"
    runs-on: ubuntu-latest
    steps:
      - name: setup python environment
        uses: actions/setup-python@v5
        with:
          python-version: "3.11"
      - name: install uv
        uses: astral-sh/setup-uv@v5
        with:
          version: "0.5.x"
          enable-cache: false
      - name: checkout source branch
        uses: actions/checkout@v4
      - name: Generate openapi specs
        run: |
          make devenv
          source .venv/bin/activate
          make openapi-specs
      - name: Check openapi specs are up to date
        run: |
          if ! ./ci/github/helpers/openapi-specs-diff.bash diff \
            https://raw.githubusercontent.com/${{ github.event.pull_request.head.repo.full_name }}/${{ github.event.pull_request.head.sha }} \
            .; then \
            echo "::error:: OAS are not up to date. Run 'make openapi-specs' to update them"; exit 1; \
          fi

  api-server-oas-breaking:
    needs: api-specs
    timeout-minutes: 10
    name: "api-server backwards compatibility"
    runs-on: ubuntu-latest
    steps:
      - name: setup python environment
        uses: actions/setup-python@v5
        with:
          python-version: "3.11"
      - name: checkout
        uses: actions/checkout@v4
      - name: check api-server backwards compatibility
        run: |
          ./scripts/openapi-diff.bash breaking --fail-on ERR\
            https://raw.githubusercontent.com/${{ github.event.pull_request.base.repo.full_name }}/${{ github.event.after }}/services/api-server/openapi.json \
            /specs/services/api-server/openapi.json

  all-oas-breaking:
    needs: api-specs
    continue-on-error: true
    timeout-minutes: 10
    name: "OAS backwards compatibility"
    runs-on: ubuntu-latest
    steps:
      - name: setup python environment
        uses: actions/setup-python@v5
        with:
          python-version: "3.11"
      - name: checkout
        uses: actions/checkout@v4
      - name: Check openapi-specs backwards compatibility
        run: |
          ./ci/github/helpers/openapi-specs-diff.bash breaking \
            https://raw.githubusercontent.com/${{ github.event.pull_request.base.repo.full_name }}/${{ github.event.after }} \
            .