.github/workflows/api-check.yml - main - niceSOFT/python3-setuptools_scm

.github/workflows/api-check.yml

60 строк2 KB

dependabot[bot]

chore(deps): Bump the github-actions group across 1 directory with 5 updates

24 июл 2026, 21:22

24 июл 2026, 21:223a9a8fb

name: API Stability Check

on:
  pull_request:
  push:
    branches:
    - "*"

concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }}
  cancel-in-progress: true

permissions:
  contents: read

env:
  FORCE_COLOR: 1

jobs:
  api-check:
    name: Check API stability with griffe
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          fetch-depth: 0

      - name: Setup Python
        uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
        with:
          python-version: '3.11'

      - name: Install the latest version of uv
        uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7.6.0

      - name: Get latest release tag
        id: latest-tag
        run: |
          # Get the latest setuptools-scm tag (griffe needs a git ref)
          LATEST_TAG=$(git describe --tags --abbrev=0 --match 'setuptools-scm-v*' origin/main 2>/dev/null || echo "")
          if [ -z "$LATEST_TAG" ]; then
            echo "No tags found on origin/main, skipping API check"
            echo "skip=true" >> $GITHUB_OUTPUT
          else
            echo "Latest release tag: $LATEST_TAG"
            echo "tag=$LATEST_TAG" >> $GITHUB_OUTPUT
            echo "skip=false" >> $GITHUB_OUTPUT
          fi

      - name: Install dependencies
        if: steps.latest-tag.outputs.skip != 'true'
        run: uv sync --all-packages --all-groups

      - name: Check API stability against latest release
        if: steps.latest-tag.outputs.skip != 'true'
        run: |
          echo "Comparing current code against tag: ${{ steps.latest-tag.outputs.tag }}"
          # Use local check_api.py script which includes griffe-public-wildcard-imports extension
          uv run --no-sync python setuptools-scm/check_api.py --against ${{ steps.latest-tag.outputs.tag }}