GitHubのコード品質について

GitHub Code Qualityを使用して、プル要求とリポジトリスキャンのコード品質の問題にフラグを設定し、Copilotを利用した自動修正を適用し、ルールセットで標準を適用します。

メモ

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

概要

          GitHub Code Quality は、コードベースが信頼性が高く、保守性が高く、効率的であることを保証するのに役立ちます。 新機能の構築、技術的負債の削減、リポジトリの正常性に関するレポートなど、 Code Quality は実用的な分析情報と自動修正を提供し、リポジトリのコード正常性を効率的に改善および維持できるようにします。

主な機能と利点

          Code Quality を使用すると、以下のことができます。

* プル要求とリポジトリスキャンを使用して、コード品質のリスクと機会を特定します。

結果の明確な説明を確認し、ワンクリック Copilot自動修正を適用します。

        **リポジトリ ダッシュボードを**使用して、信頼性と保守容易性のスコアを追跡し、注意が必要な領域を特定し、修復の優先順位を付けます。

        **組織のダッシュボードを**監視して、リポジトリのコードの正常性をひとめで把握し、さらに調査するリポジトリを決定します。

プル要求の ルールセット を設定して、コード品質標準を適用し、条件を満たしていない変更をブロックします。

        Copilot クラウド エージェント ライセンスをお持ちの場合は、修復作業をCopilotに簡単に割り当てることができます。

可用性と使用コスト

          GitHub Code Quality は、 GitHub Team および GitHub Enterprise Cloud プランの組織所有リポジトリで使用できます。

          GitHub Code Quality は、パブリック プレビュー中は課金されません。 ただし、 Code Quality スキャンには GitHub Actions 分かかります。 「[AUTOTITLE](/billing/concepts/product-billing/github-code-quality)」を参照してください。

メモ

* ** **を使用したり、Copilot搭載の自動修正を適用したりするために、Code SecurityまたはCode Qualityライセンスは必要Copilot。

サポートされている言語

          Code Quality は、 CodeQLを使用して、次の言語のルールベースの分析を実行します。

C#
Go
Java
JavaScript
Python
Ruby

TypeScript

        Code Quality また、"**AI の結果**" リポジトリ ダッシュボードに個別に表示された結果を使用して、AI を利用した分析を実行します。 コードベース全体とプル要求をスキャンするルールベースの CodeQL 分析とは異なり、この AI を利用した分析では、最近既定のブランチにプッシュされたファイルのみが調べられ、上記以外の言語で問題が特定される可能性があります。 詳しくは、「[AUTOTITLE](/code-security/code-quality/responsible-use/code-quality)」をご覧ください。

結果はどこに表示されますか?

リポジトリの Code Quality を有効にすると、次の CodeQL スキャンが表示されます。

デフォルトブランチに対して開かれたすべての新しいプル要求
既定のブランチに対するすべての既存のプル要求が更新されると、CI テストの新しい実行がトリガーされます
表示されている時刻と日付における既定のブランチのコードベース全体が [コードの品質] 設定ページにあります。

さらに、既定のブランチへの最近のすべてのプッシュの AI を利用した分析が表示されます。

Pull request の結果

          CodeQLがプル要求でルールベースの問題を検出すると、`github-code-quality[bot]`からのコメントが表示されます。 可能であれば、各コメントには、問題を解決する方法に関する Copilotの自動修正 提案が含まれます。 「[AUTOTITLE](/code-security/code-quality/tutorials/fix-findings-in-prs)」を参照してください。

既定の分岐結果

          Code Quality既定のブランチの結果は、リポジトリの [<svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-shield" aria-label="shield" role="img"><path d="M7.467.133a1.748 1.748 0 0 1 1.066 0l5.25 1.68A1.75 1.75 0 0 1 15 3.48V7c0 1.566-.32 3.182-1.303 4.682-.983 1.498-2.585 2.813-5.032 3.855a1.697 1.697 0 0 1-1.33 0c-2.447-1.042-4.049-2.357-5.032-3.855C1.32 10.182 1 8.566 1 7V3.48a1.75 1.75 0 0 1 1.217-1.667Zm.61 1.429a.25.25 0 0 0-.153 0l-5.25 1.68a.25.25 0 0 0-.174.238V7c0 1.358.275 2.666 1.057 3.86.784 1.194 2.121 2.34 4.366 3.297a.196.196 0 0 0 .154 0c2.245-.956 3.582-2.104 4.366-3.298C13.225 9.666 13.5 8.36 13.5 7V3.48a.251.251 0 0 0-.174-.237l-5.25-1.68ZM8.75 4.75v3a.75.75 0 0 1-1.5 0v-3a.75.75 0 0 1 1.5 0ZM9 10.5a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z"></path></svg> Security and quality] タブの [****] ページで報告されます。

* ** 標準の結果 ** は、 CodeQL 品質分析の結果を示します。「リポジトリのコードの品質の向上」を参照してください。 * ** AI の結果 ** は、最近既定のブランチにプッシュされたファイルの AI を利用した分析の結果を示しています。「最近マージされたコードの品質をAIで改善する」を参照してください。

スキャン情報

各CodeQL分析ではGitHub Actions分が使用され、動的な "****" ワークフローの実行としてリポジトリの [コード品質] タブに表示されます。

次のステップ

        **リポジトリの場合:**Code Qualityをオンにして、結果の生成を開始します。 「[AUTOTITLE](/code-security/how-tos/maintain-quality-code/enable-code-quality)」を参照してください。

        **企業の場合:** エンタープライズ内のリポジトリで Code Qualityを有効にできることを確認します。 「[AUTOTITLE](/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/allow-github-code-quality-in-enterprise)」を参照してください。

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

この記事で

概要