組織内のリポジトリのルールセットを作成する

組織内の複数のリポジトリを対象にしたルールセットを作成できます。

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

Organization owners can create rulesets at the organization level.

この記事の内容

はじめに

組織にルールセットを作成して、ユーザーが組織内のリポジトリを操作する方法を制御できます。どのユーザーが特定のブランチにコミットをプッシュできるか、コミットをどのようにフォーマットする必要があるか、どのユーザーがタグを削除または名前変更できるかといったことを制御できます。また、ユーザーがリポジトリの名前を変更できないようにすることもできます。

また、プライベートまたは内部リポジトリ、およびリポジトリのフォークネットワーク全体へのプッシュをブロックするように、プッシュルールセットを作成することもできます。プッシュルールセットを使用すると、ファイル拡張子、ファイルパスの長さ、ファイルとフォルダーのパス、およびファイルサイズに基づいてプッシュをブロックできます。

フォークは、アップストリームリポジトリからブランチまたはタグのルールセットを継承しません。ただし、組織が所有するフォークは、他のリポジトリと同様に、作成するルールセットの対象となります。

フォークは__、ルートリポジトリからプッシュルールセットを継承します。プッシュルールは、リポジトリのフォークネットワーク全体に適用され、リポジトリへのすべてのエントリポイントが確実に保護されます。たとえば、プッシュルールセットが有効になっているリポジトリをフォークした場合、フォークされたリポジトリにも同じプッシュルールセットが適用されます。

フォークされたリポジトリの場合、プッシュルールのバイパスアクセス許可を持つユーザーは、ルートリポジトリのバイパスアクセス許可を持つユーザーだけです。

事前構築済みのルールセットのインポート

GitHub によって事前構築済みのルールセットの 1 つをインポートするには、「github/ruleset-recipes」を参照してください。

JSON ファイルを使って既存のルールセットをインポートできます。これは、複数のリポジトリまたは組織に同じルールセットを適用する場合に便利です。詳細については、「組織内のリポジトリのルールセットを管理する」を参照してください。

`fnmatch` 構文の使用

fnmatch 構文を使用して、ルールセットの作成時にターゲットとするパターンを定義できます。

* ワイルドカードを使って、任意の文字列に一致させることができます。 GitHub では File::FNM_PATHNAME フラグを File.fnmatch 構文で使うため、* のワイルドカードがディレクトリの区切り記号 (/) と照合されません。たとえば、qa/* は、qa/ で始まり、1 つのスラッシュを含むすべてのブランチと照合されますが、qa/foo/bar とは照合されません。 qa の後には、qa/**/* を使用して任意の数のスラッシュを含めることができます。これは、たとえば qa/foo/bar/foobar/hello-world と一致します。 qa**/**/* を使い qa の文字列を拡張して、より包括的にすることもできます。

構文のオプションについて詳しくは、fnmatch のドキュメントを参照してください。

ルールセットの適用ステータスの使用

ルールセットの作成または編集中に、適用ステータスを使用してルールセットの適用方法を構成できます。

ルールセットには、次の適用ステータスのいずれかを選択できます。

アクティブ: ルールセットは作成時に適用されます。
無効: ルールセットは、適用されません。

分岐またはタグルールセットの作成

GitHub の右上隅でプロフィール写真を選んでから、 [Your organizations] をクリックします。
組織の隣の [設定] をクリックします。
左のサイドバーの [コード、計画、自動化] セクションで、[ リポジトリ] をクリックし、[ルールセット] をクリックします。
「新しいルールセット」をクリックします。
ブランチを対象とするルールセットを作成するには、 [新しいブランチルールセット] をクリックします。または、タグを対象とするルールセットを作成するには、[新しいタグルールセット] をクリックします。
[ルールセット名] に、ルールセットの名前を入力します。
必要に応じて、既定の適用ステータスを変更するには、 [無効] をクリックし、新しい適用ステータスを選択します。適用ステータスの詳細については、「ルールセットについて」を参照してください。

ブランチまたはタグのルールセットに対するバイパスアクセス許可の付与

ルールセットに対し、特定のロール、チーム、またはアプリのバイパスアクセス許可を付与できます。バイパスアクセスの対象になるものを次に示します。

リポジトリ管理者、organization 所有者、Enterprise 所有者
保守ロール、書き込みロール、または書き込みロールに基づくカスタムリポジトリロール
チーム
GitHub Apps
Dependabot。 Dependabot の詳細については、「Dependabot クイックスタートガイド」を参照してください。

ルールセットのバイパスのアクセス許可を付与するには、[バイパスリスト] セクションで [バイパスの追加] をクリックします。
表示される [バイパスの追加] モーダルダイアログで、バイパスアクセス許可を付与するロール、チーム、またはアプリを検索し、[提案] セクションからロール、チーム、またはアプリを選択し、[選択項目の追加] をクリックします。
必要に応じて、リポジトリに直接プッシュすることを許可せずにアクターにバイパスを許可するには、[常に許可] の右側にあるをクリックし、次に [pull request のみ] をクリックします。

選択したアクターは、リポジトリに変更を加えるために pull request を開いて、pull request と監査ログに変更の明確な証跡を作成する必要があります。アクターは、ブランチの保護をバイパスして、その pull request をマージすることを選択できます。

組織内でターゲットにするリポジトリの選択

ルールセットを使うと、organization 内のすべてのリポジトリ、特定の名前付け規則と一致する organization 内のリポジトリ、カスタムプロパティを持つ organization 内のリポジトリ、または organization 内の手動で選んだリポジトリ一覧をターゲットすることを選択できます。

カスタムプロパティについて詳しくは、「組織内リポジトリのカスタムプロパティの管理」をご覧ください。

リポジトリが組織レベルで作成されたルールセットのターゲットになっている場合は、組織のオーナーのみがそのルールセットを編集できます。ただし、リポジトリへの管理者アクセス権を持つユーザー、または "リポジトリルールの編集" アクセス許可を含むカスタムロールを持つユーザーは、リポジトリレベルで追加のルールセットを作成できます。これらのルールセット内のルールは、組織レベルで定義されたルールと集約されます。その結果、新しいルールセットを作成すると、ブランチまたはタグを対象とするルールは、より制限が厳しくなりますが、制限が緩くなることはありません。ルールセットの作成について詳しくは、「ルールセットについて」をご覧ください。

組織内のすべてのリポジトリをターゲットにする

組織内のすべてのリポジトリをターゲットにするには、[ターゲットリポジトリ] セクションで [ターゲット: REPOSITORIES] を選択し、[すべてのリポジトリ] をクリックします。

組織内の名前付け規則によるリポジトリのターゲット設定

名前付け規則による、組織内のリポジトリの動的リストをターゲットにするには、[ターゲットリポジトリ] セクションで [ターゲット: REPOSITORIES] を選択し、[リポジトリの動的リスト] をクリックします。
ターゲットパターンの定義を開始するには、[ターゲット条件] セクションで、[ターゲットの追加] を選択し、[パターンで追加] または [パターンで除外] をクリックします。
表示されるモーダルダイアログで、fnmatch 構文を使ってリポジトリの名前付けパターンを入力し、 [包含パターンの追加] または [除外パターンの追加] をクリックします。 fnmatch の構文について詳しくは、「fnmatch 構文の使用」をご覧ください。

メモ

複数のターゲット条件を同じルールセットに追加できます。たとえば、パターン *cat* に一致するリポジトリを含め、さらにパターン not-a-cat に一致するリポジトリを明示的に除外できます。
必要に応じて、ルールセットの構成ページで [ターゲットリポジトリの名前変更を禁止する] を選びます。

プロパティに基づいて組織内のリポジトリをターゲットにする

カスタムプロパティに基づいて、組織内のリポジトリをターゲットにすることができます。詳しくは、「組織内リポジトリのカスタムプロパティの管理」をご覧ください。

プロパティに基づいて組織内のリポジトリの動的リストをターゲットにするには、[ターゲットリポジトリ] セクションで [ターゲット: REPOSITORIES] を選択し、[プロパティに基づく動的リスト] をクリックします。
ターゲットを追加するには、[ターゲットにする条件] セクションで、[ターゲットの追加] を選択し、[プロパティに基づいて包含] または [プロパティに基づいて除外] をクリックします。
表示されるモーダルダイアログで、ドロップダウンメニューからカスタムプロパティまたはシステムプロパティを選択し、プロパティの値を選択します。
[ターゲットの追加] をクリックします。

組織内のリポジトリを選択してターゲットにする

組織内の静的で手動で選択されたリポジトリの一覧をターゲットにするには、[ターゲットリポジトリ] セクションで [ターゲット: REPOSITORIES] を選択し、[リポジトリの選択] をクリックします。
選んだリポジトリの静的一覧をターゲットにするには、[ターゲット条件] セクションで [リポジトリの選択] を選択し、ターゲットにする各リポジトリを検索します。検索結果から各リポジトリを選びます。

ターゲットにするブランチまたはタグの選択

ブランチまたはタグをターゲットにするには、[ターゲットブランチ] または [ターゲットタグ] セクションで、[ターゲットの追加] を選び、ブランチまたはタグを含めるまたは除外する方法を選びます。 fnmatch 構文を使って、パターンに基づいてブランチまたはタグを含めたり除外したりできます。詳細については、「fnmatch 構文の使用」を参照してください。

複数のターゲット条件を同じルールセットに追加できます。たとえば、既定のブランチを含め、*feature* のパターンに一致するブランチを含めてから、not-a-feature のパターンに一致する特定のブランチを除外することができます。

ブランチまたはタグの保護の選択

[ブランチ保護] または [タグ保護] セクションで、ルールセットに含めるルールを選びます。ルールを選ぶと、そのルールに追加設定を入力できる場合があります。ルールの詳細については、「ルールセットで使用できるルール」を参照してください。

メモ

[Additional settings] セクションで [Require status checks before merging] をオンにする場合:

必須にする各状態チェックの名前を入力できます。要件としての状態チェックの追加を完了するには、をクリックする必要があります。
[マージする前にブランチを最新にする必要がある] をオンにする場合は、保護を有効にするためのチェックを定義する必要があります。

メタデータの制限追加

メタデータの制限は、リポジトリでのコミット間の整合性の向上を目的とする必要があります。 pull request でのコードレビュー必須化などのセキュリティ対策を置き換えることを意図したものではありません。

メモ

ブランチをスカッシュマージする場合、そのブランチに対するすべてのコミットは、ベースブランチのメタデータ要件を満たす必要があります。

コミットメタデータまたはブランチ名を制御するルールを追加するには、ルールセットを作成または編集するときに [Restrictions] セクションで、[Restrict commit metadata] または [Restrict branch names] をクリックします。
制限の設定を構成して、[追加] をクリックします。同じルールセットに複数の制限を追加できます。
特定の正規表現パターンと一致させるには、[要件] ドロップダウンで [特定の正規表現パターンに一致する必要がある] を選択します。

[一致するパターンで開始する必要がある] など、ほとんどの要件では、入力したパターンはリテラルに解釈され、ワイルドカードはサポートされません。たとえば、* 文字が表すのは、リテラルな * 文字のみです。

より複雑なパターンの場合は、[特定の正規表現パターンに一致する必要がある] または [特定の正規表現パターンに一致しない] を選び、正規表現構文を使って、一致するパターンを定義できます。詳細については、GitHub Enterprise Cloud ドキュメントの「メタデータのコミットに正規表現を使う」を参照してください。

リポジトリのルールセットを表示しているすべてのユーザーは、指定した説明を表示できます。
必要に応じて、メタデータ制限を含むルールセットを適用する前に、ルールセットに対して "評価" の適用状態を選択し、共同作成者に影響を与えることなくメタデータ制限の効果をテストします。メタデータの制限の詳細については、「ルールセットで使用できるルール」を参照してください。

ブランチまたはタグのルールセットの最終処理と次の手順

ルールセットの作成を完了するには、[作成] をクリックします。ルールセットの適用ステータスが "アクティブ" に設定されている場合、ルールセットはすぐに有効になります。

プッシュルールセットの作成

メモ

このルールセットを使うと、リポジトリのフォークネットワーク全体にプッシュ制限を適用できます。

Organization 内のプライベートリポジトリまたは内部リポジトリのプッシュルールセットを作成できます。

GitHub の右上隅でプロフィール写真を選んでから、 [Your organizations] をクリックします。
組織の隣の [設定] をクリックします。
左のサイドバーの [コード、計画、自動化] セクションで、[ リポジトリ] をクリックし、[ルールセット] をクリックします。
「新しいルールセット」をクリックします。
ブランチを対象とするルールセットを作成するには、 [新しいプッシュルールセット] をクリックします。
[ルールセット名] に、ルールセットの名前を入力します。
必要に応じて、既定の適用ステータスを変更するには、 [無効] をクリックし、新しい適用ステータスを選択します。適用ステータスの詳細については、「ルールセットについて」を参照してください。

プッシュルールセットに対するバイパスアクセス許可の付与

メモ

リポジトリをターゲットとするプッシュルールセットのアクセス許可は、このリポジトリのフォークネットワーク全体に継承されます。つまり、このリポジトリのフォークネットワーク全体のリポジトリでこのルールセットをバイパスできる唯一のユーザーが、ルートリポジトリでこのルールセットをバイパスできるユーザーです。