GitHub Code Quality の有効化

Code Qualityをオンにして、チームに一貫した品質ベースラインを提供します。pull request と既定のブランチでコード品質の問題を自動的にキャッチ、修正、レポートします。

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

リポジトリの所有者、組織の所有者、および 管理者 ロールを持つユーザー

GitHub Team または GitHub Enterprise Cloud

この記事で

Code Qualityは、1 つのリポジトリに対して有効にすることも、組織内のすべてのリポジトリに対して一度に有効にすることもできます。 組織レベルで有効にすると、すべてのチームに 1 つの変更で一貫した品質ベースラインが与えられます。一方、リポジトリごとに有効にすると、特定のプロジェクトを対象にしたり、段階的にロールアウトしたりできます。

[前提条件]

  • エンタープライズ所有者は、企業内の Code Quality を許可している必要があります。 「企業での GitHub Code Quality の使用を許可する」を参照してください。
  • GitHub Actionsは、各Code Quality分析を実行するためにアクションを使用するため、CodeQLを有効にする必要があります。
  • この機能の利点を最大限に活用するには、リポジトリに、 CodeQLによる品質分析でサポートされている言語のいずれかを含める必要があります。 サポートされている言語を参照してください。

リポジトリの Code Quality を有効にする

  1. GitHub で、リポジトリのメイン ページに移動します。

  2. リポジトリ名の下にある [Settings] をクリックします。 [設定] タブが表示されない場合は、 [] ドロップダウン メニューを選び、 [設定] をクリックします。

    タブを示すリポジトリ ヘッダーのスクリーンショット。 [設定] タブが濃いオレンジ色の枠線で強調表示されています。

  3. サイドバーの [セキュリティ] の下の [ コードの品質 ] をクリックして、[コードの品質] ページを表示します。

  4. [ コード品質を有効にする] をクリックします。

  5. [コード品質] ページで情報を確認します。

  6. [ 変更の保存] をクリックして、 Code Qualityの構成を保存します。

組織でプライベート レジストリのキャッシュを構成している場合は、依存関係の解決に使用するコード品質分析に使用できます。 「セキュリティ機能にプライベート レジストリへのアクセスを許可する」を参照してください。

組織の Code Quality を有効にする

組織レベルでは、単一Code Quality設定で**** を制御します。 これにより、すべてのリポジトリを有効にしたり、特定のリストや動的フィルターをターゲットにしたりするための詳細なオプションが提供されるため、意図的に Code Quality パイロットして自分のペースでロールアウトできます。 選択範囲内のリポジトリが有効になり、選択範囲外のリポジトリは無効になります。

使用可能なアクセス オプションと、フィルター処理と適用のしくみについては、 組織と企業全体のコード品質の有効化 を参照してください。

  1. GitHub で、organization のメイン ページに移動します。

  2. Organization 名の下で、[ Settings] をクリックします。 [設定] タブが表示されない場合は、 [] ドロップダウン メニューを選び、 [設定] をクリックします。

    組織のプロファイルのタブのスクリーンショット。 [設定] タブが濃いオレンジ色の枠線で囲まれています。

  3. サイドバーの [セキュリティ] で、[ コードの品質] をクリックします。

  4. [リポジトリ アクセス] で、ドロップダウン メニューからオプションを選択します。

    • 選択したリポジトリ... を選択した場合は、有効にするリポジトリを選択します。
    • [ フィルターの照合...] を選択した場合は、フィルターを定義します。

  5. 必要に応じて、リポジトリ管理者がこれらの設定を変更できないようにするには、[ アクセスの強制] を有効にします。

  6. 変更によってリポジトリの Code Quality が有効または無効になった場合は、[有効化と課金の変更の確認] ダイアログが表示され、有効および無効になっているリポジトリの合計数と関連するコストが表示されます。 詳細を確認し、[ 確認] をクリックします。

変更内容は自動的に保存され、すぐに反映されます。 大規模な組織では、変更がすべてのリポジトリに適用されるまで数分かかる場合があります。

多くのチームで機能をロールアウトする場合は、すべての場所で有効にする前に、小規模なグループでパイロットを行い、品質しきい値を調整することをお勧めします。 「大規模な GitHub Code Quality のロールアウト」を参照してください。

次のステップ