api-changes.yml

name: API Changes 🤝

on:
  pull_request:
    paths:
    - requirements/requirements*.txt
    - src/**
    - .github/workflows/api-changes.yml
    - CHANGELOG.md

concurrency:
  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
  cancel-in-progress: true

env:
  FORCE_COLOR: 1
  # renovate: datasource=pypi depName=griffe
  GRIFFE_VERSION: 1.5.5
  # renovate: datasource=pypi depName=nox
  NOX_VERSION: 2024.10.9
  # renovate: datasource=pypi depName=uv
  UV_VERSION: 0.5.28

permissions:  # added using https://github.com/step-security/secure-repo
  contents: read

jobs:
  check-api-changes:
    name: Check API Changes
    runs-on: ubuntu-24.04
    env:
      NOXSESSION: api
    steps:
    - name: Check out the repository
      uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
      with:
        fetch-depth: 0
        persist-credentials: false

    - name: Setup Python
      uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
      with:
        python-version: 3.x

    - name: Install uv
      uses: astral-sh/setup-uv@180f8b44399608a850e1db031fa65c77746566d3 # v5.0.1
      with:
        version: ${{ env.UV_VERSION }}

    - name: Install tools
      run: |
        uv tool install --with nox==${{ env.NOX_VERSION }} nox
        uv tool install --with griffe==${{ env.GRIFFE_VERSION }} griffe
        uv tool list

    - name: Set REF
      id: set-ref
      if: always() && !startsWith(github.head_ref, 'release/')
      run: |
        echo "ref=${{ github.event.pull_request.base.sha }}" >> $GITHUB_OUTPUT

    # Check API against the latest commit on the base branch
    - name: Run Nox
      run: |
        nox -- ${{ steps.set-ref.outputs.ref }}