GitHub のコード品質について

メモ

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 分を消費します。「GitHub Code Quality 課金」を参照してください。

メモ

Copilot または Code Security ライセンスは必要 ありません。Code Quality を使用したり、Copilot-powered autofixes を適用したりすることはできません。
パブリックプレビューの間、リポジトリ所有者による Code Security の使用をブロックするエンタープライズポリシーは、Code Quality の使用もブロックします。「GitHub Code Quality を企業で使用できるようにする」を参照してください。

サポートされている言語

Code Quality は、 CodeQL を使用し、以下の言語に対してルールベースの分析を実施します。

C#
Go
Java
JavaScript
Python
Ruby
TypeScript

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

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

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

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

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

Pull request の結果

CodeQL がプルリクエストに関するルールベースの問題を検出すると、github-code-quality[bot]からのコメントが表示されます。可能であれば、各コメントには、問題を解決する方法に関する Copilotの自動修正の提案が含まれます。「プルリクエストをマージする前にコード品質に関する指摘を修正すること」を参照してください。

既定の分岐結果

Code Quality の既定のブランチでの結果は、リポジトリの [ セキュリティ ] タブの "コードの品質" ページで報告されます。

        **標準の結果 は、** CodeQL 品質分析の結果を示します。 「[AUTOTITLE](/code-security/code-quality/tutorials/improve-your-codebase)」を参照してください。

        **AI の結果** は、最後に既定のブランチにプッシュされたファイルの AI を利用した分析の結果を示します。 「[AUTOTITLE](/code-security/code-quality/tutorials/improve-recent-merges)」を参照してください。

スキャン情報

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

次のステップ

リポジトリで Code Quality を有効にします。GitHub Code Qualityの有効化を参照してください。エンタープライズ所有者は、最初に高度なセキュリティポリシーを更新する必要 がある場合があります 。 GitHub Code Quality を企業で使用できるようにするを参照してください。
GitHub Code Quality が既定のブランチでどのように機能するかを確認して、コード品質の問題を確認し、リポジトリのコードの正常性をひとめで把握できるようにします。「GitHub コード品質のクイックスタートガイド」を参照してください。

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

この記事の内容

概要