Действия Github - Сравните и найдите различия между двумя файлами OAS V3 - PullRequest
Новая
       34

Действия Github - Сравните и найдите различия между двумя файлами OAS V3

0 голосов
/ 29 февраля 2020

Предположим, вам даны два файла спецификации OpenApi (OAS) V3:

  • original-spe c .yaml: оригинальная spe c
  • updated-spe c .yaml: модифицированный (с улучшениями / критическими изменениями / et c)
    (пример обоих файлов доступен на https://gist.github.com/jy95/d7b53648eb756547eb67fd0db962f68d)

Я хотел бы найти инструмент CLI, который сгенерирует отчет, читаемый человеком
(например, я мог бы загрузить его в PR-комментарии с PR-комментарием из файла )

Мои требования следующие:

  • без технических ограничений
    (вы можете свободно использовать любую библиотеку языков программирования, если она работает, включая использование конвертера OAS в Swagger v2 при необходимости)
  • человек читаемый / понятный
    (должно быть ясно, чтобы люди, которые не знают ОАГ, не потерялись)
  • поддерживается (не обязательно, но лучше)

В настоящее время я нашел эти проекты в Интернете:
- openapi-diff
- quen2404 / openapi-diff
- Azure / openapi-diff
- ...

(другие, несомненно, существуют: я предоставляю вам возможность найти некоторые / или помочь мне выбрать ту, которая достаточно хороша ...)

Вот начало рабочего процесса Github, который поможет вам запустить: 

name: API Breaking Changes
# Everyone is happy with breaking changes ^^
on:
  pull_request:

jobs:
  build-report:
    needs: build-oas-artefacts
    runs-on: ubuntu-latest
    steps:
      - name: Download OAS file from SOURCE branch
        uses: actions/download-artifact@v1
        with:
          name: original-spec.yaml
      - name: Download OAS file from TARGET branch
        uses: actions/download-artifact@v1
        with:
          name: modified-spec.yaml

Спасибо за помощь

...