Command Restriction
Set limitations on who can execute specific Mergify commands.
In some scenarios, you might want to restrict who can use Mergify commands to ensure they’re executed only by authorized individuals. The command restrictions feature allows you to define a set of users or teams who are permitted to use specific Mergify commands.
How Restrictions Work
Section titled How Restrictions WorkWith command restrictions, you can use conditions to define the valid context that is authorized to run a specific command. This could be a list of allowed users or teams, or even attributes related to the pull request itself.
The restrictions are configured with the top-level key commands_restrictions
which can specify restrictions for each command.
Examples
Section titled ExamplesTo limit backport commands for pull requests coming from the main branch:
commands_restrictions: backport: conditions: - base = mainTo limit backport commands usage to a specific team (or user):
commands_restrictions: backport: conditions: - sender = @teamTo limit backport commands for users with a specific permission on the repository:
commands_restrictions: backport: conditions: - sender-permission >= writeDefault Restrictions
Section titled Default Restrictionsbackport#conditions:
- sender-permission >= writecopy#conditions:
- sender-permission >= writedequeue#conditions:
- sender-permission >= writequeue#conditions:
- sender-permission >= writerebase#conditions:
- or:
- sender-permission >= write
- sender = {{author}}refresh#conditions:
- or:
- sender-permission >= write
- sender = {{author}}requeue#conditions:
- sender-permission >= writesquash#conditions:
- or:
- sender-permission >= write
- sender = {{author}}update#conditions:
- or:
- sender-permission >= write
- sender = {{author}}Command Restriction Format
Section titled Command Restriction Formatconditions#Was this page helpful?
Thanks for your feedback!