Contract #120
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Contract | |
| on: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| schedule: | |
| # Daily nightly run at 06:00 UTC catches drift from upstream API changes | |
| # captured into fixtures/ between merges. | |
| - cron: "0 6 * * *" | |
| repository_dispatch: | |
| # Fired by audd-openapi on every merge to main; re-run our parser against | |
| # the latest spec to catch contract drift before it reaches users. | |
| types: [openapi-updated] | |
| permissions: | |
| contents: read | |
| issues: write | |
| jobs: | |
| contract: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| path: audd-node | |
| - uses: actions/checkout@v4 | |
| with: | |
| repository: AudDMusic/audd-openapi | |
| path: audd-openapi | |
| - uses: actions/setup-node@v4 | |
| with: | |
| node-version: "20" | |
| cache: npm | |
| cache-dependency-path: audd-node/package-lock.json | |
| - working-directory: audd-node | |
| run: npm ci | |
| - working-directory: audd-node | |
| env: | |
| AUDD_OPENAPI_FIXTURES: ${{ github.workspace }}/audd-openapi/fixtures | |
| run: npx vitest run test/contract.test.ts | |
| - name: Report drift issue | |
| if: failure() && github.event_name != 'pull_request' | |
| uses: actions/github-script@v7 | |
| with: | |
| script: | | |
| const { data: open } = await github.rest.issues.listForRepo({ | |
| owner: context.repo.owner, repo: context.repo.repo, | |
| state: 'open', labels: 'contract-drift' | |
| }); | |
| const runUrl = `${context.serverUrl}/${context.repo.owner}/${context.repo.repo}/actions/runs/${context.runId}`; | |
| if (open.length > 0) { | |
| await github.rest.issues.createComment({ | |
| owner: context.repo.owner, repo: context.repo.repo, | |
| issue_number: open[0].number, | |
| body: `Still failing against the latest audd-openapi spec.\n\nRun: ${runUrl}` | |
| }); | |
| } else { | |
| await github.rest.issues.create({ | |
| owner: context.repo.owner, repo: context.repo.repo, | |
| title: `contract drift detected (${context.workflow})`, | |
| body: `Contract tests failed against the latest audd-openapi spec.\n\nRun: ${runUrl}`, | |
| labels: ['contract-drift'] | |
| }); | |
| } | |
| - name: Close drift issue on recovery | |
| if: success() && github.event_name != 'pull_request' | |
| uses: actions/github-script@v7 | |
| with: | |
| script: | | |
| const { data: open } = await github.rest.issues.listForRepo({ | |
| owner: context.repo.owner, repo: context.repo.repo, | |
| state: 'open', labels: 'contract-drift' | |
| }); | |
| const runUrl = `${context.serverUrl}/${context.repo.owner}/${context.repo.repo}/actions/runs/${context.runId}`; | |
| for (const issue of open) { | |
| await github.rest.issues.createComment({ | |
| owner: context.repo.owner, repo: context.repo.repo, | |
| issue_number: issue.number, | |
| body: `Contract tests are passing again — closing.\n\nRun: ${runUrl}` | |
| }); | |
| await github.rest.issues.update({ | |
| owner: context.repo.owner, repo: context.repo.repo, | |
| issue_number: issue.number, state: 'closed' | |
| }); | |
| } |