View as Markdown

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.

With 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.

To limit backport commands for pull requests coming from the main branch:

commands_restrictions:
backport:
conditions:
- base = main

To limit backport commands usage to a specific team (or user):

commands_restrictions:
backport:
conditions:
- sender = @team

To limit backport commands for users with a specific permission on the repository:

commands_restrictions:
backport:
conditions:
- sender-permission >= write
backport#

Command Restrictions

·default
conditions:
  - sender-permission >= write
conditions:
  - sender-permission >= write
dequeue#

Command Restrictions

·default
conditions:
  - sender-permission >= write
conditions:
  - sender-permission >= write
conditions:
  - or:
      - sender-permission >= write
      - sender = {{author}}
refresh#

Command Restrictions

·default
conditions:
  - or:
      - sender-permission >= write
      - sender = {{author}}
requeue#

Command Restrictions

·default
conditions:
  - sender-permission >= write
conditions:
  - or:
      - sender-permission >= write
      - sender = {{author}}
conditions:
  - or:
      - sender-permission >= write
      - sender = {{author}}

Was this page helpful?