リポジトリのルールセットの管理

リポジトリ内の既存のルールセットを編集、監視、削除して、ユーザーが特定のブランチやタグを操作する方法を変更できます。

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

リポジトリのルールセットは、そのリポジトリの読み取りアクセス権を持つすべてのユーザーが表示できます。リポジトリの管理者アクセス権を持つユーザー、または "リポジトリルールの編集" アクセス許可を持つカスタムロールは、リポジトリルールセットの分析情報を表示できます。詳しくは、「カスタムリポジトリロールについて」をご覧ください。

ルールセットは、GitHub Free と GitHub Free の Organization のパブリックリポジトリ、GitHub Pro、GitHub Team、GitHub Enterprise Cloud のパブリックとプライベートのリポジトリで利用できます。

プッシュルールセットは、内部およびプライベートリポジトリ、プッシュルールセットが有効になっているリポジトリのフォーク、および企業内の組織の GitHub Enterprise Cloud プランで使用できます。

この記事の内容

ルールセットを作成した後も、ルールセットに変更を加えることができます。たとえば、ブランチまたはタグをより適切に保護するためのルールを追加したり、をリポジトリの共同作成者エクスペリエンスへの影響をテストした後にルールセットを "評価" モードから "アクティブ" に切り替えたりできます。の共同作成者エクスペリエンスに対する意図しない影響をトラブルシューティングするためにルールセットを一時的に無効にします。

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

Tip

Organization 所有者である場合は、organization レベルでルールセットを作成できます。これらのルールセットは、組織内の特定のリポジトリに、およびそれらのリポジトリ内の特定のブランチに適用できます。詳しくは、「組織内のリポジトリのルールセットを作成する」をご覧ください。

リポジトリのルールセットの表示

[Rulesets] ページでは、リポジトリへの読み取りアクセス権を持つすべてのユーザーが、特定のブランチ、タグ、またはプッシュ制限を対象とするアクティブなルールセットを表示できます。"評価" モードで実行されているルールセットも表示されますが、これは強制されません。

フォークされたリポジトリのプッシュルールセットの場合、[ルールセット] ページには、ルールが適用されているソースリポジトリによってルールセットが管理されていることが示されます。

GitHub で、リポジトリのメインページに移動します。
左側のファイルツリービューで、ブランチドロップダウンメニューを選択し、 [すべてのブランチを表示] をクリックします。統合ファイルエディターの上部にあるブランチドロップダウンメニューも見つかります。
ブランチ名の左側にあるをクリックします
必要に応じて、結果をフィルター処理するには、タブをクリックするか、[ブランチの検索] 検索バーを使用します。
表示するルールセットの名前をクリックします。

ルールセットの編集

Note

ルールセットが organization レベルで作成されている場合、リポジトリの設定からルールセットを編集することはできません。ルールセットを編集する権限を持っている場合は、組織の設定でそうすることができます。詳しくは、「組織内のリポジトリのルールセットを管理する」をご覧ください。

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

GitHub で、リポジトリのメインページに移動します。
リポジトリ名の下にある [設定] をクリックします。 [設定] タブが表示されない場合は、 [] ドロップダウンメニューを選び、 [設定] をクリックします。
左側のサイドバーの [コードと自動化] の下で、 [ルール] をクリックし、 [ルールセット] をクリックします。
[ルールセット] ページで、編集するルールセットの名前をクリックします。
必要に応じてルールセットを変更します。使用可能なルールについて詳しくは、「ルールセットで使用できるルール」を参照してください。
ページの下部にある [変更の保存] をクリックします。

ルールセットの削除

Tip

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

GitHub で、リポジトリのメインページに移動します。
リポジトリ名の下にある [設定] をクリックします。 [設定] タブが表示されない場合は、 [] ドロップダウンメニューを選び、 [設定] をクリックします。
左側のサイドバーの [コードと自動化] の下で、 [ルール] をクリックし、 [ルールセット] をクリックします。
削除するルールセットの名前をクリックします。
ルールセットの名前の右側にあるを選び、 [ルールセットの削除] をクリックします。

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

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

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

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

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

GitHub で、リポジトリのメインページに移動します。
リポジトリ名の下にある [設定] をクリックします。 [設定] タブが表示されない場合は、 [] ドロップダウンメニューを選び、 [設定] をクリックします。
左側のサイドバーの [コードと自動化] で、 [ルール] をクリックし、 [分析情報] をクリックします。
[ルールの分析情報] ページで、ページ上部のドロップダウンメニューを使用して、ルールセット、ブランチ、アクター、期間でアクションをフィルター処理します。
バイパスに失敗した、またはバイパスを必要とした特定のルールを確認するには、をクリックして、ルールセットの名前を展開します。
必要に応じて、同じマージグループ内の対応する pull request のマージキューの詳細を確認します。