組織内でGitHubのコード品質結果を探索する

前提条件

• 組織が企業に属している場合は、エンタープライズ所有者が組織の Code Quality を有効にする必要があります。 「企業での GitHub Code Quality の使用を許可する」を参照してください。
• 組織では、 Code Quality が有効になっているリポジトリが必要です。 「GitHub Code Quality の有効化」を参照してください。

組織のコード品質に関する分析情報の表示

組織レベルのダッシュボードには、次の 2 つのタブがあります。

• [ 正常性 ] タブには、組織の現在のコード正常性のスナップショットが表示されます。
• [ 傾向 ] タブには、選択した期間に開いている結果がどのように変化したかが表示されるため、進行状況を追跡し、注意が必要なリポジトリを特定できます。

1. GitHubで、組織のメイン ページに移動します。 たとえば、 https://github.com/settings/organizationsから。
2. 組織名の下の [ Security and quality ] タブをクリックします。
3. サイドバーの [Insights] セクションで、[ コードの品質] をクリックします。

ダッシュボード データのフィルター処理

ダッシュボードの上部にあるフィルター バーは、[ 正常性 ] タブと [ 傾向 ] タブの両方に適用されます。 次のようにフィルターできます:

• 信頼性スコア
• 保守容易性スコア
• 標準の結果
• AI の結果
• トピック
• チーム
• 視認性
• 組織に対して定義されているカスタム プロパティ

同じフィルター バーの [並べ替え ] コントロールを使用して、ダッシュボード データを並べ替えることもできます。

現在のコード正常性の表示

[ 正常性 ] タブには、現在の組織のコード正常性のスナップショットが表示されます。

スコア分布グラフの解釈

スコア分布グラフには、組織のコード正常性の視覚的な概要が表示されます。 各バブルは、同じ保守性と信頼性スコアを持つリポジトリのコレクションを表します。

• 各バブルの 位置 は、これらのリポジトリの全体的な正常性を示しています。 バブルが大きいほど保守性スコアが高くなりますが、右側のバブルは高い信頼性スコアを表します。
• バブルの 色と境界線のパターン は、それらのリポジトリの低いスコアの重大度を示します。 たとえば、いずれかのカテゴリの "Poor" スコアを持つバブルは、常に赤で破線で表示されます。
• 各バブルの サイズ は、その特定のスコアの組み合わせがあるリポジトリの数を表します。

保守容易性スコア、信頼性スコア、および特定のバブルによって表されるリポジトリの数を表示するには、バブルにカーソルを合わせます。

リポジトリ テーブルの探索

バブル チャートの下には、組織内のすべてのリポジトリを一覧表示するテーブルがあります。 ここでは、コード品質の結果と、それらの結果に関するより詳細な情報を表示できます。

列ヘッダーをクリックすると、任意の列のリポジトリ テーブルを昇順または降順で並べ替えることができます。

スコアの低いリポジトリの調査

1. 最もパフォーマンスの低いリポジトリのダッシュボード データをフィルター処理するには、スコア分布グラフで、結合されたスコアが最も低いバブルをクリックします。
2. リポジトリ テーブルまで下にスクロールします。 既定では、テーブルはリポジトリ スキャンが最新のものから過去のものへと並べ替えられるため、現在の品質の問題に優先順位を付けるのに役立ちます。
3. 必要に応じて、最も多くの CodeQL 結果を持つリポジトリに優先順位を付けるために、 標準の結果 を 2 回クリックします。
4. 特定のリポジトリのリポジトリ レベルのダッシュボードを表示するには、リポジトリの名前をクリックします。

時間の経過に伴う品質傾向の追跡

[ 傾向 ] タブには、アクセス権を持ち、現在のフィルターに一致するリポジトリ間で開いている結果が時間の経過と同時に変化したことを示すので、コード品質の作業が効果を持っているかどうか、次に注目する場所を確認できます。

1. 組織レベルのダッシュボードで、[ 傾向 ] タブをクリックします。
2. [ 期間 ] ドロップダウンを使用して、過去 7 日、14 日間、または 30 日間の時間範囲を選択します。
3. [Open findings over time](時間の経過に伴うオープンな結果) グラフを確認します。このグラフには、選択した期間の該当するリポジトリ全体の開いている結果の合計数が表示されます。
4. 必要に応じて、グラフの上にあるボタンを使用して、 正常性スコア または重大度別にデータをグループ 化します。
5. グラフ上のポイントにカーソルを合わせると、その日の開いている検索カウントが表示されます。

傾向データを理解する

グラフを解釈するときは、次の点に注意してください。

• グラフは、未解決の検出結果の日次スナップショットに基づいています。 特定の日に実行された分析がない場合は、その日のデータ ポイントがない可能性があります。

• 履歴データは、スナップショットの作成を開始 Code Quality ときにのみ使用できるため、使用可能な時間の範囲は最初は制限される可能性があります。

• グラフは、開かれている個々の結果や修正された結果ではなく、開いている結果の合計数を追跡します。 カウントの変更は、開発者が問題を修正または導入したという意味であるとは限りません。

• 追加のリポジトリで Code Quality を有効にすると、グラフに表示される検索数が増える可能性があります。 新しいリポジトリを有効にした後の増加は、必ずしもコードの品質が低下しているとは限りません。

• このグラフでは、現在フィルター処理しているリポジトリの開いている結果の合計数が追跡されます。 合計カウントには次のものが含まれます。

  • コードの変更によって、または新しいリポジトリでコード品質分析が有効になっている場合に導入された新しい結果
  • コードで修正された、またはユーザーによって却下された検出結果

注意が必要なリポジトリの識別

傾向グラフの下にある 2 つのテーブルは、選択した期間に注意が必要なリポジトリを特定するのに役立ちます。

• 最も改善されたリポジトリには、選択した 期間中に開いている結果が最も減少しているリポジトリが一覧表示されます。
• 改善が必要なリポジトリには、 選択した期間に開いている結果が最も多いリポジトリが一覧表示されます。

両方のテーブルに次の列があります。

• リポジトリ: リポジトリの名前。
• 未解決の合計: 選択した期間の終了時点で、そのリポジトリの未解決の検出結果の数。
• Net change: 選択した期間にリポジトリのオープン検索数がどのように変化したか。
• 無視: 選択した期間にリポジトリに対して無視された結果の数。

リポジトリの結果の数は、修正および無視される結果の影響を受ける。 リポジトリ レベルのダッシュボードを使用して、変更内容を確認できます。

リポジトリを調査するには、その名前をクリックしてリポジトリ レベルの Code Quality ダッシュボードを開きます。ここで、個々の結果を確認し、修復アクションを実行できます。

次のステップ

リポジトリ レベルのダッシュボードで使用できるコード正常性情報については、 リポジトリのコード品質結果の解釈 を参照してください。

多数のリポジトリで Code Quality を有効にする予定の場合は、 GitHub Code Quality の大規模展開 を参照してください。