メモ
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」を参照してください。
メモ
- Copilot または Code Security ライセンスは必要 ありません。Code Quality を使用したり、Copilot-powered autofixes を適用したりすることはできません。
サポートされている言語
Code Quality は、 CodeQL を使用し、以下の言語に対してルールベースの分析を実施します。
- C#
- Go
- Java
- JavaScript
- Python
- Ruby
- TypeScript
Code Quality は、AI を利用した分析も実行し、その結果は "AI の結果" リポジトリ ダッシュボードに個別に表示されます。 コードベース全体とプル要求をスキャンするルールベースの CodeQL 分析とは異なり、この AI を利用した分析では、最近既定のブランチにプッシュされたファイルのみが調べられ、上記以外の言語の問題が特定される可能性があります。 詳しくは、「AUTOTITLE」をご覧ください。
結果はどこに表示されますか?
リポジトリに対して Code Quality を有効にすると、CodeQL スキャンで次の情報が表示されます。
- デフォルトブランチに対して開かれたすべての新しいプル要求
- 既定のブランチに対するすべての既存のプル要求が更新されると、CI テストの新しい実行がトリガーされます
- "コードの品質" 設定ページに表示されている日時の時点での既定のブランチにおけるコードベース全体
さらに、既定のブランチへの最近のすべてのプッシュの AI を利用した分析が表示されます。
Pull request の結果
CodeQL がプルリクエストに関するルールベースの問題を検出すると、からのコメントが表示されます。 可能であれば、各コメントには、問題を解決する方法に関する Copilotの自動修正 の提案が含まれます。 「AUTOTITLE」を参照してください。
既定の分岐結果
Code Quality の既定のブランチでの結果は、リポジトリの [ セキュリティ ] タブの "コードの品質" ページで報告されます。
- 標準の結果 は、 CodeQL 品質分析の結果を示します。 「AUTOTITLE」を参照してください。
- AI の結果 は、最後に既定のブランチにプッシュされたファイルの AI を利用した分析の結果を示します。 「AUTOTITLE」を参照してください。
スキャン情報
各 CodeQL 分析ではGitHub Actions 分が使用され、動的な "コード品質" ワークフローの実行としてリポジトリの [アクション] タブで確認できます。
次のステップ
- リポジトリの場合: Code Quality をオンにして、結果の生成を開始します。 「AUTOTITLE」を参照してください。
- 企業の場合: エンタープライズ内のリポジトリで Code Quality を有効にできることを確認します。 「AUTOTITLE」を参照してください。