name: openapi-diff on: pull_request: # Cancel in progress workflows on pull_requests. # https://docs.github.com/en/actions/using-jobs/using-concurrency#example-using-a-fallback-value concurrency: group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} cancel-in-progress: true # hack for https://github.com/actions/cache/issues/810#issuecomment-1222550359 env: SEGMENT_DOWNLOAD_TIMEOUT_MINS: 3 jobs: check-diff: name: build api runs-on: ubuntu-22.04 timeout-minutes: 90 steps: - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 with: # Avoid codecov error message related to SHA resolution: # https://github.com/codecov/codecov-bash/blob/7100762afbc822b91806a6574658129fe0d23a7d/codecov#L891 fetch-depth: '2' - name: Check for python file changes uses: dorny/paths-filter@0bc4621a3135347011ad047f9ecf449bf72ce2bd # v3.0.0 id: changes with: token: ${{ github.token }} filters: .github/file-filters.yml - name: Setup sentry env uses: ./.github/actions/setup-sentry if: steps.changes.outputs.api_docs == 'true' - name: Checkout getsentry/sentry-api-schema uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 if: steps.changes.outputs.api_docs == 'true' with: ref: 'main' repository: getsentry/sentry-api-schema path: sentry-api-schema - uses: getsentry/action-setup-volta@e4939d337b83760d13a9d7030a6f68c9d0ee7581 # v2.0.0 if: steps.changes.outputs.api_docs == 'true' - name: Build OpenAPI Derefed JSON if: steps.changes.outputs.api_docs == 'true' # install ts-node for ts build scripts to execute properly without potentially installing # conflicting deps when running scripts locally # see: https://github.com/getsentry/sentry/pull/32328/files run: | yarn add ts-node && make build-api-docs - name: Compare OpenAPI Derefed JSON if: steps.changes.outputs.api_docs == 'true' run: | npx json-diff@0.5.4 --color sentry-api-schema/openapi-derefed.json tests/apidocs/openapi-derefed.json