Breaking Change Detection - CI/CD用語集の定義

breaking change detection は API バージョンの diff を取り、既存のクライアントを壊す変更を検出します。

breaking change detection は API の schema や contract の2つのバージョンを比較し、フィールドの削除や type の厳格化など、既存のクライアントを壊す変更を検出します。これは API の CI pipeline で一般的なゲートです。

必須フィールドの削除、ルートの改名、戻り値の type の狭小化は、consumer を静かに壊す可能性があります。pull request での自動検出は、そのような変更が現れたときにコメントするか失敗させます。

実行の仕組み

pipeline は base ブランチの schema を取得し、pull request の schema と diff を取り、削除や互換性のない type 変更を breaking としてマークします。