ドキュメント

レビュー証拠

pull requestに関連付けられたプレビュー展開環境、スキャン結果、カバレッジデータ、テスト結果を確認できます。

レビュー証拠レビュー証拠とは、それが属するpull requestに添付される検証の証明です。開くことのできるプレビュー、スキャン結果、カバレッジの差分、ブラウザ実行記録などが該当します。

原則は単純です。証拠とそれが記述するコードは一緒に提供されるべきです。誰も見ない別のダッシュボードにあるスキャン結果は証拠ではなく、単なる課題に過ぎません。

添付可能なもの

Coroidは以下の複数のカテゴリにわたるプロバイダーと連携します:

カテゴリプロバイダー
GitネイティブGitHub Actions環境、GitLab レビューアプリ
スタティックホスティングVercel、Netlify、Cloudflare Pages、AWS Amplify
フルスタックプレビューRender、Railway、Heroku Review Apps、Fly.io、Northflank、Qovery、Porter
モバイル配布Expo EAS、TestFlight、Google Play内部テスト
レビューおよびスキャンCodeRabbit、Qodo / PR-Agent、Greptile、Cursor Bugbot、SonarQube Cloud、Snyk、Semgrep
カバレッジおよびビジュアルCodecov、Chromatic、Percy
エンドツーエンドおよびモニタリングCypress Cloud、Checkly、Maestro、BrowserStack
カスタムカスタム証拠ウェブフック

合計で31種類のプロバイダーが対応しています。リストにないものにはカスタム証拠ウェブフックが利用されます。

各プロバイダーは、生成可能な証拠の種類(ウェブプレビュー、モバイルビルド、AI レビュー、セキュリティスキャン、カバレッジ、ビジュアルレビュー、エンドツーエンドおよびパフォーマンス)と、Git上のデータ、CI出力、またはプロバイダーのAPIへの直接呼び出しを通じてCoroidがそれらを取り込む方法を明示します。

おそらく既にほとんどの機能をご利用中でしょう

Coroidを導入するチームの多くは、すでにプレビュー展開環境、スキャナー、カバレッジレポート機能を利用しています。レビュー証拠は既存の仕組みをつなぐものであり、置き換えるものではありません。

組織の接続設定でプロバイダーを設定すれば、Coroidが作成するプルリクエストに証拠が自動的に添付されます。

証拠とゲート

証拠とゲートは関連していますが、別の概念です:

  • 証拠とは、人が参照するために添付される情報です。
  • ゲートとは、システムが強制する判断基準です。

証拠がゲートの条件を満たすこともあります。例えばカバレッジ閾値ゲートはカバレッジ証拠を参照しますが、ほとんどの証拠は単なる参考情報に過ぎません。見る価値があるからといって、必ずしも作業を妨げる必要はありません。

マージ後の証拠

レビュー証拠とは pull request のことです。リリース特定の環境にデプロイされるコミットを、別途実行されるQuality Graph、チェックリスト、および関連する承認プロセスを用いて評価します。有効なレビュー証拠を参照することもありますが、プルリクエストのチェックに合格したからといってそのコミットが必ずデプロイされたと断言できるわけではありません。プロバイダーのコールバックや手動での証明によってデプロイが記録され、デプロイ後のカナリア分析で健全性が確認されます。

添付する内容の選定

証拠が多いほど良いというわけではありません。各項目はレビュアーの注意を奪い合うため、15個のアーティファクトを含む pull request と3個を含むものとでは、レビュアーが目に留める時間は変わりません。

判断を左右するものを添付する:

  • aプレビューは、変更がユーザーに見える場合に必ず使用できます。 タスクのレビューから開始できます。
  • カバレッジは、差分が重要な場合に使用します。
  • セキュリティスキャンは、入力処理、認証、依存関係に関わる部分に使用します。
  • ビジュアル差分は、デザインシステムやコンポーネントの作業に使用します。