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

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

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

リポジトリのルールセットは、そのリポジトリの読み取りアクセス権を持つすべてのユーザーが表示できます。リポジトリの管理者アクセス権を持つユーザー、または "リポジトリルールの編集" アクセス許可を持つカスタムロールは、リポジトリのルールセットを作成、編集、削除したり、

ルールセットは、GitHub Free と GitHub Free の Organization のパブリックリポジトリ、GitHub Pro、GitHub Team、GitHub Enterprise Cloud のパブリックとプライベートのリポジトリで利用できます。詳しくは、「GitHub のプラン」をご覧ください。

プッシュルールセットは、内部リポジトリとプライベートリポジトリの GitHub Team プランと、プッシュルールセットが有効になっているリポジトリのフォークで使用できます。

この記事の内容

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

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

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

[ルールセット] ページでは、リポジトリへの読み取りアクセス権を持つすべてのユーザーが、特定のブランチ、タグ、またはプッシュ制限を対象とするアクティブなルールセットを表示できます。

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

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

ルールセットの編集

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

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

ルールセットの削除

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

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

ルールセット履歴の使用

注:

ルールセット履歴は現在、公開用ベータ版であり、変更されることがあります。
2023 年 10 月 11 日の公開用ベータ版のリリース後にルールセットに加えられた変更のみがルールセット履歴に含まれます。

ルールセットに対するすべての変更を表示し、特定のイテレーションに戻すことができます。特定のイテレーションでのルールセットの構成を含む JSON ファイルをダウンロードすることもできます。ルールセットのバイパスリストは、エクスポートされた JSON ファイルから除外されます。

GitHub.com で、リポジトリのメインページへ移動します。
リポジトリ名の下にある [設定] をクリックします。 [設定] タブが表示されない場合は、 [] ドロップダウンメニューを選び、 [設定] をクリックします。
左側のサイドバーの [コードと自動化] の下で、 [ルール] をクリックし、 [ルールセット] をクリックします。
ルールセットの変更履歴を表示するには、ルールセットの名前の右側にあるを選択し、[ 履歴] をクリックします。
特定のイテレーションの右側にあるを選択し、[変更の比較]、[復元]、または [ダウンロード] をクリックします。

ルールセットのインポート

JSON ファイルを使用して、別のリポジトリまたは組織からルールセットをインポートできます。これ��、複数のリポジトリまたは組織に同じルールセットを適用する場合に便利です。

GitHub.com で、リポジトリのメインページへ移動します。
リポジトリ名の下にある [設定] をクリックします。 [設定] タブが表示されない場合は、 [] ドロップダウンメニューを選び、 [設定] をクリックします。
左側のサイドバーの [コードと自動化] の下で、 [ルール] をクリックし、 [ルールセット] をクリックします。
[新しいルールセット] ドロップダウンを選択し、[ルールセットのインポート] をクリックします。
エクスポートされた JSON ファイルを開きます。
インポートしたルールセットを確認し、[作成] をクリックします。