Skip to main content

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

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

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

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 エンドポイント」および「ミューテーション」を参照してください。

メモ

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

ルールセットの編集

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

  1. GitHub の右上隅でプロフィール写真を選んでから、 [Your organizations] をクリックします。

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

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

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

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

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

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

ルールセットの削除

ヒント

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

  1. GitHub の右上隅でプロフィール写真を選んでから、 [Your organizations] をクリックします。

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

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

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

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

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

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

ルールセット履歴の使用

メモ

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

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

  1. GitHub の右上隅でプロフィール写真を選んでから、 [Your organizations] をクリックします。

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

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

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

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

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

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

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

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

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

  1. GitHub の右上隅でプロフィール写真を選んでから、 [Your organizations] をクリックします。

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

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

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

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

    リポジトリ ルールセットのページのスクリーンショット。 [New ruleset] ドロップダウン メニューが展開され、[Import a ruleset] オプションがオレンジ色の枠線で囲まれています。

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

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