組織内のリポジトリのルールセットを管理する

既存のルールセットを編集、監視、削除して、組織内のリポジトリと対話する方法を変更できます。

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

Organization owners and users with the "Manage organization ref update rules and rulesets" permission can manage rulesets at the organization level.

この記事の内容

組織のルールセットの管理について

組織レベルでルールセットを作成した後にルールセットを変更して、ユーザーがターゲット リポジトリと対話する方法を変更できます。 たとえば、これらのリポジトリのブランチまたはタグをより適切に保護するためのルールを追加したり、リポジトリの共同作成者エクスペリエンスへの影響をテストした後でルール セットを「評価」モードから「アクティブ」に切り替えたりすることができます。 リポジトリのブランチに適用される組織のルールセットでは、リポジトリ管理者がターゲット リポジトリのブランチの名前を変更したり、既定のブランチを別のブランチに変更したりすることができなくなります。 リポジトリ管理者は、適切なアクセス許可を持っている限り、ブランチを作成および削除できます。

REST および GraphQL API を使ってルールセットを管理できます。 詳細については、「ルールの REST API エンドポイント」および「ミューテーション」を参照してください。

Note

リポジトリの読み取りアクセス権を持つすべてのユーザーは、そのリポジトリで動作しているアクティブなルールセットを見ることができます。

ルールセットの編集

ルールセットを編集して、名前、バイパスのアクセス許可、ルールなど、ルールセットの一部を変更できます。 また、ルールセットを有効または一時的に無効にする場合など、ルールセットを編集してその状態を変更することもできます。

  1. GitHub の右上隅で、プロフィール写真を選択し、 あなたの組織をクリックします。

  2. 組織の隣の [設定] をクリックします。

  3. 左のサイド バーの [コード、計画、自動化] セクションで、[ リポジトリ] をクリックし、[ルールセット] をクリックします。

    組織の設定ページのスクリーンショット。 サイド バーで、[ルールセット] というラベルの付いたリンクがオレンジ色の枠線で囲まれています。

  4. [ルールセット] ページで、編集するルールセットの名前をクリックします。

  5. 必要に応じてルールセットを変更します。 使用可能なルールについて詳しくは、「ルールセットで使用できるルール」を参照してください。

  6. ページの下部にある [変更の保存] をクリックします。

ルールセットの削除

Tip

ルールセットを一時的に無効にしたいが、削除したくない場合は、ルールセットの状態を "無効" に設定できます。 詳しくは、「ルールセットの編集」をご覧ください。

  1. GitHub の右上隅で、プロフィール写真を選択し、 あなたの組織をクリックします。

  2. 組織の隣の [設定] をクリックします。

  3. 左のサイド バーの [コード、計画、自動化] セクションで、[ リポジトリ] をクリックし、[ルールセット] をクリックします。

    組織の設定ページのスクリーンショット。 サイド バーで、[ルールセット] というラベルの付いたリンクがオレンジ色の枠線で囲まれています。

  4. 削除するルールセットの名前をクリックします。

  5. ルールセットの名前の右側にある を選び、 [ルールセットの削除] をクリックします。

    ルールセットを編集するページのスクリーンショット。 3 つのドットのラベルが付いたボタンの下に、[ルールセットの削除] というラベルが付いたオプションがオレンジ色の枠線で囲まれています。

ルールセットの分析情報の表示

ルールセットの分析情報を表示して、ルールセットが組織内のリポジトリにどのように影響しているかを確認できます。 [ルールの分析情報] ページに、次のユーザー アクションのタイムラインが表示されます。 フィルターを使用し、探しているものを見つけることができます。

  • 1 つ以上のルールセットに対してチェックされ、成功したアクション。
  • 1 つ以上のルールセットに対してチェックされ、失敗したアクション。
  • 他のユーザーがバイパスした 1 つ以上のルールセットに対するアクション。

ルールセットが "評価" モードで実行されている場合、ルールセットがアクティブなときに成功または失敗するアクションを確認することができます。

[ルールの分析情報] ページのスクリーンショット。 1 つは "成功" とマークされ、1 つは "バイパス" とマークされ、1 つは "評価" ラベルで "失敗" とマークされた 3 つのアクションが一覧表示されています。

  1. GitHub の右上隅で、プロフィール写真を選択し、 あなたの組織をクリックします。

  2. 組織の隣の [設定] をクリックします。

  3. 左のサイド バーの [コード、計画、自動化] セクションで、 [ リポジトリ] をクリックし、[ルール分析情報] をクリックします。

    組織の設定ページのスクリーンショット。 サイド バーで、[ルール分析情報] というラベルの付いたリンクがオレンジ色の枠線で囲まれています。

  4. [ルール分析情報] ページで、ページ上部のドロップダウン メニューを使用して、ルールセット、リポジトリ、アクター、期間でアクションをフィルター処理します。

  5. バイパスに失敗した、またはバイパスを必要とした特定のルールを確認するには、 をクリックして、ルールセットの名前を展開します。

    [ルールの分析情報] ページのスクリーンショット。 [octocat の作成は許可されません] というラベルが付いたイベントの右側にある 3 つの水平ドットのアイコンがオレンジ色の枠線で囲まれています。