mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-10-03 19:57:35 +00:00
69 lines
2.8 KiB
YAML
69 lines
2.8 KiB
YAML
# API Conformance Tests
|
|
# This workflow ensures that API changes maintain backward compatibility and don't break existing integrations
|
|
# It runs schema validation and OpenAPI diff checks to catch breaking changes early
|
|
|
|
name: API Conformance Tests
|
|
|
|
run-name: Run the API Conformance test suite on the changes.
|
|
|
|
on:
|
|
push:
|
|
branches: [ main ]
|
|
pull_request:
|
|
branches: [ main ]
|
|
types: [opened, synchronize, reopened]
|
|
paths:
|
|
- 'docs/static/llama-stack-spec.yaml'
|
|
- 'docs/static/llama-stack-spec.html'
|
|
- '.github/workflows/conformance.yml' # This workflow itself
|
|
|
|
concurrency:
|
|
group: ${{ github.workflow }}-${{ github.ref == 'refs/heads/main' && github.run_id || github.ref }}
|
|
# Cancel in-progress runs when new commits are pushed to avoid wasting CI resources
|
|
cancel-in-progress: true
|
|
|
|
jobs:
|
|
# Job to check if API schema changes maintain backward compatibility
|
|
check-schema-compatibility:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
# Using specific version 4.1.7 because 5.0.0 fails when trying to run this locally using `act`
|
|
# This ensures consistent behavior between local testing and CI
|
|
- name: Checkout PR Code
|
|
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
|
|
|
|
# Checkout the base branch to compare against (usually main)
|
|
# This allows us to diff the current changes against the previous state
|
|
- name: Checkout Base Branch
|
|
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
|
|
with:
|
|
ref: ${{ github.event.pull_request.base.ref }}
|
|
path: 'base'
|
|
|
|
# Cache oasdiff to avoid checksum failures and speed up builds
|
|
- name: Cache oasdiff
|
|
id: cache-oasdiff
|
|
uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830
|
|
with:
|
|
path: ~/oasdiff
|
|
key: oasdiff-${{ runner.os }}
|
|
|
|
# Install oasdiff: https://github.com/oasdiff/oasdiff, a tool for detecting breaking changes in OpenAPI specs.
|
|
- name: Install oasdiff
|
|
if: steps.cache-oasdiff.outputs.cache-hit != 'true'
|
|
run: |
|
|
curl -fsSL https://raw.githubusercontent.com/oasdiff/oasdiff/main/install.sh | sh
|
|
cp /usr/local/bin/oasdiff ~/oasdiff
|
|
|
|
# Setup cached oasdiff
|
|
- name: Setup cached oasdiff
|
|
if: steps.cache-oasdiff.outputs.cache-hit == 'true'
|
|
run: |
|
|
sudo cp ~/oasdiff /usr/local/bin/oasdiff
|
|
sudo chmod +x /usr/local/bin/oasdiff
|
|
|
|
# Run oasdiff to detect breaking changes in the API specification
|
|
# This step will fail if incompatible changes are detected, preventing breaking changes from being merged
|
|
- name: Run OpenAPI Breaking Change Diff
|
|
run: |
|
|
oasdiff breaking --fail-on ERR base/docs/static/llama-stack-spec.yaml docs/static/llama-stack-spec.yaml --match-path '^/v1/'
|