Skip to main content

pull request でのブロックの解決

プル要求におけるコード品質やカバレッジのしきい値に関する問題を特定し、解決して、変更をマージできるようにしてください。

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

書き込み アクセスを持つユーザー

pull request がブロックされる理由を理解する

リポジトリ管理者と組織の所有者は、 GitHub Code Qualityを使用して品質ゲートを設定できます。 pull request を開くと、チェックが自動的に実行され、これらの標準に対する変更が評価されます。

ブロックには次の 2 種類があります。

  • コード品質の結果: 変更により、必要な品質しきい値を下回る問題が発生します。
  • カバレッジのしきい値: 変更により、コード カバレッジが必要な最小値を下回ったり、カバレッジが既定の分岐に対して許容される量を超えて低下したりします。

これらのチェックは、健全で保守可能なコードベースを維持し、技術的負債の蓄積を防ぐのに役立ちます。

コード品質の指摘事項ブロックを解消する

pull request で必要な品質しきい値を下回るコードが導入された場合は、[確認] セクションの pull request の下部にマージ ブロック バナーが表示されます。"マージがブロックされています: コード品質の結果が検出されました"。

プル要求の [チェック] セクションのマージ ブロック バナーのスクリーンショット。

リポジトリ管理者または組織の所有者によって設定された品質ゲートは、マージをブロックする 最小重大度レベル を定義します。 マージする前に、その重大度レベル以上のすべての結果を修正または無視する必要があります。 マージ ブロック バナーで重大度レベルが指定されていない場合、リポジトリ ではすべての結果 に対処する必要があります。

プルリクエストのブロックを解除するには、ブロック対象の重大度以上の指摘事項を修正または却下する必要があります。

  1. あなたのプルリクエストに対して github-code-quality[bot] が残したコメントを確認してください。 各コメントには重大度 (エラー警告、注) のラベルが付 けられます
  2. 関連する結果を修正または無視します。 詳しい手順については、「pull request でのコード品質の結果の修正」を参照してください。
  3. プル要求の [チェック] セクションにマージ ブロック バナーが存在しなくなったかどうかを確認します。

カバレッジしきい値ブロックの解決

プル要求がカバレッジしきい値ルールによってブロックされている場合は、[チェック] セクションにマージ ブロック バナーが表示され、どのしきい値が満たされなかったかを示すメッセージが表示されます。 例えば次が挙げられます。

  • 「カバレッジ 22.0% は最小値 50.0% を下回っています」: プル リクエストのブランチ カバレッジが、ルールセットで設定された最小カバレッジ率を下回っています。
  • 「カバレッジが 2.5% 低下しました。許容される最大の低下率は 1.0% です」。あなたの変更により、デフォルトブランチと比較して、許容範囲を超えてカバレッジが低下しました。

pull request のブロックを解除するには、より多くのコードベースが実行されるようにテストを追加または変更する必要があります。

  1. プル リクエストのカバレッジ概要コメントを確認して、カバレッジが不足しているファイルまたは領域を特定してください。
  2. テストを追加または更新して、実行範囲を拡大します。 Copilot は、テストの記述と更新に役立ちます。 「コードのテスト」を参照してください。
  3. 変更をプッシュしてください。 カバレッジ チェックは自動的に再実行されます。

次のステップ