OpenAPITools / OpenAPITools/openapi-diff

Add official Github action for openapi-diff

オープン
#186 コメント 4 件 リアクション 20 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

enhancement
主要言語
Java
スター
1.1k
フォーク
190
PR マージ指標
30日以内にマージされた PR はありません

説明

Openapi-diff is well suited to be integrate into Github actions in order to:

  • Highlight breaking in a pull request
  • Document changes in OpenAPI
  • etc.

For example, today we have an internal github repo which on every commit triggers generating Redoc OpenAPI documentation and publishes it to Github pages for the repository. In this documentation we'd like to include a openapi-diff markdown report of the changes.

Or, when ever we do a pull request we want to review the changes made. Openapi-diff will allow us to identify automatically breaking changes.

There are a couple of unofficial limited Github actions based on other openapi diff tool

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

まず、リポジトリに既存するエントリポイントと、リリースまたは自動化の設定を確認します。この issue ではファイルやテストは指定されていません。要求された動作をリンクされた非公式の actions と比較し、公式の action が OpenAPI diff の結果と breaking-change のチェックをどのように公開すべきかを判断します。利用可能な GitHub Action が pull-request ワークフローとレポート生成ワークフロー向けにドキュメント化され、検証されていれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
github-actions, java, openapi
領域
api, ci-cd, devops
issue の種類
機能追加
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。