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

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

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

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

この記事の内容

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

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

Note

プッシュ ルールの委任されたバイパスは現在 パブリック プレビュー 段階であり、変更される可能性があります。

プッシュルールセットの委任されたバイパスを使用すると、プッシュ保護をバイパスできるユーザーと、ブロックされたプッシュを許可する必要があるユーザーを制御できます。

委任されたバイパスでは、リポジトリの投稿者は、制限された内容を含むコミットをプッシュする際に、「バイパス権限」を要求する必要があります。 要求は、指定されたレビュー担当者グループに送信されます。レビュー担当者は、プッシュ ルールをバイパスする要求を承認または拒否します。

プッシュ ルールをバイパスする要求が承認された場合、投稿者は制限された内容などコミットをプッシュできます。 要求が拒否された場合、投稿者は、再度プッシュする前に、制限された内容などのコミット (複数可) から内容を削除する必要があります。

委任されたバイパスを構成するには、組織の所有者またはリポジトリ管理者が最初に 「バイパス リスト」 を作成します。 バイパス リストには、チームやリポジトリ管理者など、プッシュ保護をバイパスする要求を監督する特定のロールとチームが含まれます。 詳細については、「組織内のリポジトリのルールセットを管理する」および「ルールセットについて」を参照してください。

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

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

ルールセットの編集

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

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

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

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

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

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

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

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

ルールセットの削除

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

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

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

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

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

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

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

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

ルールセット履歴の使用

注:

  • ルールセット履歴は現在 パブリック プレビュー にあり、変更される可能性があります。
  • 2023 年 10 月 11 日の パブリック プレビュー のリリース後にルールセットに加えられた変更のみがルールセット履歴に含まれます。

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

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

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

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

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

  4. ルールセットの変更履歴を表示するには、ルールセットの名前の右側にある を選択し、[ 履歴] をクリックします。

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

  5. 特定のイテレーションの右側にある を選択し、[変更の比較]、[復元]、または [ダウンロード] をクリックします。

    リポジトリ ルールセット履歴のページのスクリーンショット。 3 つのドットのラベルが付いたドロップダウン メニューが展開され、オレンジ色の枠線でハイライトされています。

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

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

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

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

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

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

  4. [新しいルールセット] ドロップダウンを選択し、[ルールセットのインポート] をクリックします。

    リポジトリ ルールセットのページのスクリーンショット。 [新しいルールセット] というラベルのドロップダウン メニューが展開され、"ルールセットのインポート" オプションがオレンジ色の枠線でハイライトされます。

  5. エクスポートされた JSON ファイルを開きます。

  6. インポートしたルールセットを確認し、[作成] をクリックします。

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

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

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

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

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

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

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

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

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

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

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

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

プッシュ ルールをバイパスする要求の管理

Note

プッシュ ルールの委任されたバイパスは現在 パブリック プレビュー 段階であり、変更される可能性があります。

バイパス権限のすべての要求は、リポジトリの [ルール設定] タブにある [バイパス要求] ページで表示および管理できます。

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

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

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

  3. [バイパス要求] をクリックします。

承認者 (バイパス リストのメンバー)、要求者 (要求を作成する投稿者)、期間、および状態によって要求をフィルター処理できます。 要求には次の状態が割り当てられます。

状態説明
Cancelled要求は投稿者によって取り消されました。
Completed要求が承認され、コミットがリポジトリにプッシュされました。
Denied要求が審査され否認されました。
Expired要求の有効期限が切れました。 要求は 7 日間有効です。
Open要求はまだレビューされていないか、承認されていますが、コミットがリポジトリにプッシュされていません。

投稿者が制限された内容などコミットをプッシュするバイパス権限を要求すると、バイパス リストのメンバーはすべて、要求へのリンクを含む電子メールによる通知を受信します。 その後、バイパス リストのメンバーは、要求の有効期限が切れる前に、要求を確認して承認または拒否する 7 日間があります。

投稿者は電子メールで決定を通知され、必要なアクションを実行する必要があります。 要求が承認された場合、投稿者は制限された内容などコミットをリポジトリにプッシュできます。 要求が拒否された場合、投稿者はコミットから制限された内容を削除して、コミットをリポジトリに正常にプッシュする必要があります。