Skip to main content

pull request でのブロックの解決

プルリクエストにおけるコード品質の問題を特定し、解決して、変更をマージしてください。

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

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

メモ

GitHub Code Quality は現在 パブリック プレビュー にあり、変更される可能性があります。 パブリック プレビュー の間、Code Quality は課金されませんが、Code Quality スキャンでは GitHub Actions 分が消費されます。

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

リポジトリ管理者は、 GitHub Code Qualityを使用して、保守性と信頼性のためにコード品質ゲートを設定できます。 プル要求を開くと、スキャンが自動的に実行され、これらの標準に対する変更がチェックされます。

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

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

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

スキャン結果とその重大度レベルの表示

スキャンの結果は、プル要求に関するコメントとして報告され、 github-code-quality[bot]によって残されます。 各コメントは、変更で検出された特定のコード品質の問題に対応します。

コメントには重大度 (エラー警告、注) のラベルが付 けられます。 重大度レベルの意味の詳細については、「重大度 レベル」を参照してください。

pull request をブロックしている結果を特定する

リポジトリ管理者によって設定される品質ゲートは、マージをブロックする 最小重大度レベル を定義します。

マージ ブロック バナーでは、最小重大度レベルを指定できます。 Pull request をマージする前に、その重大度レベル以上のすべての指摘事項に対処する必要があります。

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

メモ

マージ ブロック バナーに重大度レベルが定義されていない場合は、リポジトリで最も厳格なコード品質しきい値が使用されていることを意味します。このしきい値では、マージ前 にすべての結果 に対処する必要があります。

各結果の修正または無視

pull request のブロックを解除するには、コード内の問題を 修正 するか、コメントを 閉じる かを決定することで、必要な各検索を解決する必要があります。

          Copilot自動修正とCopilotクラウドエージェントを活用して結果を修正する

Copilot自動修正

pull request に関するコメントには、pull request に直接コミットできる 推奨自動修正 が含まれています。 ロジック、セキュリティ、スタイルに関して推奨される自動修正を慎重に確認し、[ 提案のコミット] をクリックします。

これらの提案を適用するためにCopilot ライセンスは必要ありません。

Copilotクラウドエージェント

または、 Copilot ライセンスがある場合は、修復作業を Copilotクラウドエージェントに委任できます。 pull request にコメントし、@Copilotに言及していることを明示し、Copilotに検出された問題の修正を要求します。

クラウドエージェントであるCopilotを呼び出したPRコメントを示すスクリーンショット。

          Copilot は、コメントに目の絵文字 (👀) で応答し、新しいエージェント セッションを開始し、必要な修正を含む pull request を開きます。

          Copilotクラウドエージェントの作業を追跡できます。
  • pull request では、作業の進行状況に応じて概要が更新されます。
  •         [エージェント ページ](https://github.com/copilot/agents?ref_product=copilot&ref_type=engagement&ref_style=text)またはセッション ログの使用については、[AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/track-copilot-sessions) を参照してください。
    
            Copilotを呼び出すには、Copilotクラウドエージェント ライセンスが必要です。
    

サインアップ Copilot

結果を無視する

コードベースのコンテキストで関連性がない場合、またはアクション可能でない場合は、結果を無視できます。 結果を無視する一般的な理由は次のとおりです。

  • この結果は、管理されなくなったレガシ コードにあります。
  • これは、チームのコーディング標準に対する既知の例外です。
  • これは、実際の品質リスクをもたらさない偽陽性です。

無関係なアラートを無視すると、品質チェックが意味のある問題に焦点を当て続けます。

要件を満たしていることを確認する

コード品質要件を満たしているかどうかを確認するには、pull request の下部にある 「チェック」セクションを参照してください。 差し込みブロックバナーが表示されなくなり、通常どおり変更をマージできるようになります。

次のステップ

最近変更されたファイルの結果を修正することで、技術的負債を削減します。 「最近マージされたコードの品質をAIで改善する」を参照してください。