ブランチルールを使用してブランチで許可されたアクションを管理する

ブランチを作成すると、そのロールのアクセス許可に基づいて、そのブランチに対して特定のアクションが許可されます。ブランチルールを設定することで、特定のブランチに許可されるアクションを変更できます。ブランチルールは、プロジェクトでユーザーに付与されているロールに基づいています。プロジェクト内の特定のロールを持つユーザーやブランチにコミットをプッシュするなど、いくつかの事前定義されたアクションを制限できます。これにより、特定のアクションを実行できるロールを制限することで、プロジェクト内の特定のブランチを保護できます。例えば、Project administrator ロールを持つユーザーのみがそのブランチにマージまたはプッシュできるようにブランチルールを設定すると、プロジェクト内の他のロールを持つユーザーはそのブランチのコードを変更できなくなります。

ブランチのルールを作成することで発生するすべての影響を考慮する必要があります。例えば、ブランチへのプッシュを Project administrator ロールを持つユーザーに制限すると、Contributor ロールを持つユーザーはそのブランチでワークフローを作成または編集できなくなります。これは、ワークフロー YAML がそのブランチに保存され、これらのユーザーは変更をコミットして、YAML にプッシュできないためです。ベストプラクティスとして、ブランチルールを作成した後にテストして、意図していない影響が発生していないかを確認します。ブランチルールをプルリクエストの承認ルールと組み合わせて使用することもできます。詳細については、「承認ルールを使用してプルリクエストをマージするための要件を管理する」を参照してください。

ソースリポジトリのデフォルトブランチに適用されるブランチルールは、他のブランチに適用されるブランチルールとは少し動作が異なります。デフォルトブランチに適用されるルールは、デフォルトブランチとして指定したブランチに自動的に適用されます。以前にデフォルトブランチとして設定されていたブランチは、削除ができるようになる点を除いて、すでに適用されているルールを保持します。この削除の保護は、現在のデフォルトブランチにのみ適用されます。

ブランチルールには、[標準] と[カスタム] の 2 つの状態があります。[標準] は、ブランチで許可されているアクションが、CodeCatalyst のブランチアクションでユーザーに付与されているアクセス許可と一致することを示します。ロールとアクセス許可の関連性については、「ユーザーロールによってアクセス権を付与する」を参照してください。カスタムは、1 つ以上のブランチアクションに、プロジェクト内のユーザーロールによって付与されたデフォルトのアクセス許可とは異なるアクションを実行できる特定のロールのリストを持つアクションがあることを示します。

次の表に、ブランチでこれらのアクションを実行できるロールのアクションとデフォルト設定を示します。

ブランチルールを削除することはできませんが、ブランチでこのアクションを実行することが許可されているすべてのロールからのアクションを許可するように更新することで、ルールを効果的に削除できます。