Skip to main content
Skip to content

プル要求のコードカバレッジのしきい値の設定

アップロードされたコード カバレッジがチームで必要なレベルを下回った場合に、プル要求がマージされないようにします。

この機能を使用できるユーザーについて

リポジトリの所有者、組織の所有者、および 管理者 ロールを持つユーザー

メモ

この機能は パブリック プレビュー であり、変更される可能性があります。

コードカバレッジ ルールの仕組み

コード カバレッジの制限ルールは、アップロードされたライン カバレッジ データを構成されたしきい値と比較して評価します。 カバレッジのアップロードが完了するまで待つことはありません。

想定されるすべてのカバレッジ結果が利用可能になる前にプルリクエストがマージされないようにするには、想定されるカバレッジ アップロードに関連付けられた各ステータスチェックを必須ステータスチェックにします。 これには、個別のジョブまたはワークフローからアップロードされたカバレッジが含まれます。

ライン カバレッジの詳細については、「 コードカバレッジ リファレンス」を参照してください。

前提条件

  • GitHub Code Quality はリポジトリで有効になっています。
  • コード カバレッジ データは、pull request ブランチの GitHub にアップロードされます。 「リポジトリのコード カバレッジの設定」を参照してください。

カバレッジしきい値ルールの作成

  1. GitHub で、リポジトリのメイン ページに移動します。

  2. リポジトリ名の下にある [Settings] をクリックします。 [設定] タブが表示されない場合は、 [] ドロップダウン メニューを選び、 [設定] をクリックします。

    タブを示すリポジトリ ヘッダーのスクリーンショット。 [設定] タブが濃いオレンジ色の枠線で強調表示されています。

  3. 左側のサイドバーの 「コード、計画、自動化」で、「 ルールセット」をクリックし、「 ルールセット」をクリックします。

  4. 新しいブランチ ルールセットを作成するか、既存のブランチ ルール セットをクリックして編集します。

  5. [ブランチ ルール] で、[コード カバレッジを制限] を選択します。

  6. [ 追加の設定] を展開してしきい値を構成します。 値が 0は、しきい値が無効になっていることを意味します。

    • 最小ライン カバレッジ率: 集計されたライン カバレッジがこの割合を下回るプル要求をブロックする値を入力します。
    • 最大ライン カバレッジ ドロップ: 既定の分岐を基準にして、ライン カバレッジがこの数パーセントポイントを超えて低下するプル要求をブロックする値を入力します。
  7. 作成 または 変更を保存 をクリックします。