js-fastify-rest-api-example/.github/workflows/openapi-diff.yml at main · hexlet-components/js-fastify-rest-api-example · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
name: OpenAPI Diff

# Информационный шаг: показывает в логе PR, что изменилось в контракте и есть
# ли ломающие правки. Сборку намеренно не роняет — v1 нигде не опубликован, и
# жёсткий гейт обещал бы совместимость, которой репозиторий не даёт. Когда
# спека станет публичной, достаточно убрать continue-on-error.
on:
  pull_request:
    branches:
      - main

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

permissions: {}

jobs:
  diff:
    runs-on: ubuntu-latest
    timeout-minutes: 15
    permissions:
      contents: read
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          persist-credentials: false
          fetch-depth: 0

      # Файл кладётся в рабочую копию, а не в /tmp: oasdiff запускается
      # docker-действием, и внутрь контейнера монтируется только workspace —
      # из /tmp он базовую спеку не увидит.
      - name: Extract the base version of the spec
        run: |
          mkdir -p .oasdiff
          git show "origin/${GITHUB_BASE_REF}:tsp-output/@typespec/openapi3/openapi.v1.json" \
            > .oasdiff/base.json \
            || cp tsp-output/@typespec/openapi3/openapi.v1.json .oasdiff/base.json
          test -s .oasdiff/base.json

      - name: Report breaking changes
        continue-on-error: true
        uses: oasdiff/oasdiff-action/breaking@9ce3a29eb0e6478dd0140932a678c7fb59d08f22 # v0.1.20
        with:
          base: .oasdiff/base.json
          revision: tsp-output/@typespec/openapi3/openapi.v1.json