|
1 | 1 | name: API Schema Compatibility Check |
2 | 2 |
|
| 3 | +permissions: |
| 4 | + contents: read |
| 5 | + |
3 | 6 | # This workflow: |
4 | 7 | # - Runs on ALL PRs that modify API-related files |
5 | 8 | # - Always fails if breaking changes are detected |
@@ -47,55 +50,17 @@ jobs: |
47 | 50 | go install github.com/oasdiff/oasdiff@v1.11.7 |
48 | 51 | echo "$HOME/go/bin" >> $GITHUB_PATH |
49 | 52 |
|
50 | | - - name: Use committed API schemas |
| 53 | + - name: Prepare PR schemas |
51 | 54 | run: | |
52 | | - echo "Using OpenAPI schemas from PR (generated by validate-openapi-spec workflow)..." |
53 | | -
|
54 | | - # Verify schemas exist (they should be committed by validate-openapi-spec workflow) |
55 | | - if [[ ! -f "api-reference/v1/openapi_spec_v1.json" ]]; then |
56 | | - echo "::error::V1 schema not found. The validate-openapi-spec workflow should have generated it." |
57 | | - exit 1 |
58 | | - fi |
59 | | -
|
60 | | - if [[ ! -f "api-reference/v2/openapi_spec_v2.json" ]]; then |
61 | | - echo "::error::V2 schema not found. The validate-openapi-spec workflow should have generated it." |
62 | | - exit 1 |
63 | | - fi |
64 | | -
|
65 | | - # Validate JSON format |
66 | | - if ! jq empty api-reference/v1/openapi_spec_v1.json 2>/dev/null; then |
67 | | - echo "::error::V1 schema contains invalid JSON" |
68 | | - exit 1 |
69 | | - fi |
70 | | -
|
71 | | - if ! jq empty api-reference/v2/openapi_spec_v2.json 2>/dev/null; then |
72 | | - echo "::error::V2 schema contains invalid JSON" |
73 | | - exit 1 |
74 | | - fi |
75 | | -
|
76 | | - # Copy to working files |
77 | | - cp api-reference/v1/openapi_spec_v1.json pr-v1-schema.json |
78 | | - cp api-reference/v2/openapi_spec_v2.json pr-v2-schema.json |
79 | | -
|
80 | | - echo "V1 schema: $(wc -c < pr-v1-schema.json) bytes" |
81 | | - echo "V2 schema: $(wc -c < pr-v2-schema.json) bytes" |
| 55 | + jq empty api-reference/v1/openapi_spec_v1.json && cp api-reference/v1/openapi_spec_v1.json pr-v1-schema.json || { echo "::error::V1 schema invalid or missing"; exit 1; } |
| 56 | + jq empty api-reference/v2/openapi_spec_v2.json && cp api-reference/v2/openapi_spec_v2.json pr-v2-schema.json || { echo "::error::V2 schema invalid or missing"; exit 1; } |
82 | 57 |
|
83 | 58 | - name: Extract base branch schemas |
84 | 59 | env: |
85 | | - BASE_REF: ${{ github.event.pull_request.base.ref }} |
86 | 60 | BASE_SHA: ${{ github.event.pull_request.base.sha }} |
87 | 61 | run: | |
88 | | - if git show "$BASE_SHA:api-reference/v1/openapi_spec_v1.json" > base-v1-schema.json 2>/dev/null; then |
89 | | - echo "V1 schema extracted from $BASE_REF" |
90 | | - else |
91 | | - echo "{}" > base-v1-schema.json |
92 | | - fi |
93 | | -
|
94 | | - if git show "$BASE_SHA:api-reference/v2/openapi_spec_v2.json" > base-v2-schema.json 2>/dev/null; then |
95 | | - echo "V2 schema extracted from $BASE_REF" |
96 | | - else |
97 | | - echo "{}" > base-v2-schema.json |
98 | | - fi |
| 62 | + git show "$BASE_SHA:api-reference/v1/openapi_spec_v1.json" > base-v1-schema.json 2>/dev/null || echo "{}" > base-v1-schema.json |
| 63 | + git show "$BASE_SHA:api-reference/v2/openapi_spec_v2.json" > base-v2-schema.json 2>/dev/null || echo "{}" > base-v2-schema.json |
99 | 64 |
|
100 | 65 | - name: Run breaking change detection |
101 | 66 | id: breaking_changes |
@@ -156,30 +121,8 @@ jobs: |
156 | 121 | run: | |
157 | 122 | echo "::error::Breaking changes detected in API schema." |
158 | 123 | echo "::error::Found ${{ steps.breaking_changes.outputs.breaking_changes }} breaking change(s)." |
159 | | - echo "::error::Please review the compatibility report and consider:" |
160 | | - echo "::error::- Creating a new API version (v3)" |
161 | | - echo "::error::- Using backward-compatible changes instead" |
162 | | - echo "::error::- Coordinating with API consumers before deployment" |
163 | 124 | exit 1 |
164 | 125 |
|
165 | | - - name: Upload validation artifacts |
166 | | - if: always() |
167 | | - uses: actions/upload-artifact@v4 |
168 | | - with: |
169 | | - name: api-validation-artifacts-${{ github.run_number }} |
170 | | - path: | |
171 | | - pr-v1-schema.json |
172 | | - pr-v2-schema.json |
173 | | - base-v1-schema.json |
174 | | - base-v2-schema.json |
175 | | - v1-breaking-report.txt |
176 | | - v2-breaking-report.txt |
177 | | - v1-detailed-diff.txt |
178 | | - v2-detailed-diff.txt |
179 | | - v1-breaking-status.txt |
180 | | - v2-breaking-status.txt |
181 | | - retention-days: 30 |
182 | | - |
183 | 126 | migration-compatibility-check: |
184 | 127 | name: Migration Breaking Change Detection |
185 | 128 | runs-on: ubuntu-latest |
|
0 commit comments