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

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

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

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

注: リポジトリでアクティブなルールセットは、そのリポジトリの読み取りアクセス権を持つすべてのユーザーが参照できます。

ルールセットの編集

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

GitHub.com の右上隅にあるプロファイル写真を選択し、次に自分の組織をクリックします。
組織の隣の [設定] をクリックします。
左のサイドバーの [コード、計画、自動化] セクションで、[ リポジトリ] をクリックし、[ルールセット] をクリックします。
[ルールセット] ページで、編集するルールセットの名前をクリックします。
必要に応じてルールセットを変更します。使用可能なルールについて詳しくは、「ルールセットで使用できるルール」を参照してください。
ページの下部にある [変更の保存] をクリックします。

ルールセットの削除

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

GitHub.com の右上隅にあるプロファイル写真を選択し、次に自分の組織をクリックします。
組織の隣の [設定] をクリックします。
左のサイドバーの [コード、計画、自動化] セクションで、[ リポジトリ] をクリックし、[ルールセット] をクリックします。
削除するルールセットの名前をクリックします。
ルールセットの名前の右側にあるを選び、 [ルールセットの削除] をクリックします。

ルールセット履歴の使用

注:

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

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

GitHub.com の右上隅にあるプロファイル写真を選択し、次に自分の組織をクリックします。
組織の隣の [設定] をクリックします。
左のサイドバーの [コード、計画、自動化] セクションで、[ リポジトリ] をクリックし、[ルールセット] をクリックします。
ルールセットの変更履歴を表示するには、ルールセットの名前の右側にあるを選択し、[ 履歴] をクリックします。
特定のイテレーションの右側にあるを選択し、[変更の比較]、[復元]、または [ダウンロード] をクリックします。

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

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

GitHub.com の右上隅にあるプロファイル写真を選択し、次に自分の組織をクリックします。
組織の隣の [設定] をクリックします。
左のサイドバーの [コード、計画、自動化] セクションで、[ リポジトリ] をクリックし、[ルールセット] をクリックします。
[新しいルールセット] ドロップダウンを選択し、[ルールセットのインポート] をクリックします。
エクスポートされた JSON ファイルを開きます。
インポートしたルールセットを確認し、[作成] をクリックします。

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

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

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

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

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

GitHub.com の右上隅にあるプロファイル写真を選択し、次に自分の組織をクリックします。
組織の隣の [設定] をクリックします。
左のサイドバーの [コード、計画、自動化] セクションで、 [ リポジトリ] をクリックし、[ルール分析情報] をクリックします。
[ルール分析情報] ページで、ページ上部のドロップダウンメニューを使用して、ルールセット、リポジトリ、アクター、期間でアクションをフィルター処理します。
バイパスに失敗した、またはバイパスを必要とした特定のルールを確認するには、をクリックして、ルールセットの名前を展開します。