⚙️ Commands🔗

Mergify is able to run some 🚀 Actions directly without leveraging the rule system. By commenting on a pull request, you can ask Mergify to executes some actions.

The syntax of the comment is:

@Mergifyio <command> [parameters …]

Note

Each command have default restrictions described below. A user might need to be the author of the pull request or have write access to the repository to run a command. More restrictions can be added with Commands Restrictions.

The list of available commands is listed below, with their parameters:

backport🔗

Runs the backport action.

Syntax	`@Mergifyio backport <branch name> <branch name 2> …`
Example	`@Mergifyio backport stable/3.1 stable/4.0`
Default restrictions	Write access

copy🔗

Runs the copy action.

Syntax	`@Mergifyio copy <branch name> <branch name 2> …`
Example	`@Mergifyio copy stable/3.1 stable/4.0`
Default restrictions	Write access

queue🔗

Add this pull request to the merge queue.

Syntax

@Mergifyio queue [<queue-name>]

Example

@Mergifyio queue

@Mergifyio queue default

Default restrictions

Write access

rebase🔗

Runs the rebase action.

Syntax	`@Mergifyio rebase`
Example	`@Mergifyio rebase`
Default restrictions	Write access or author of the pull request

refresh🔗

Re-evaluates your Mergify rules on this pull request.

Syntax	`@Mergifyio refresh`
Example	`@Mergifyio refresh`
Default restrictions	Write access or author of the pull request

squash🔗

Runs the squash action.

Syntax	`@Mergifyio squash [<commit_message format>]`
Example	`@Mergifyio squash first-commit`
Default restrictions	Write access or author of the pull request

update🔗

Runs the update action.

Syntax	`@Mergifyio update`
Example	`@Mergifyio update`
Default restrictions	Write access or author of the pull request

unqueue🔗

Removes this pull request from the merge queue if it has been queued with queue action or queue command.

Syntax	`@Mergifyio unqueue`
Example	`@Mergifyio unqueue`
Default restrictions	Write access

requeue🔗

Inform Mergify that the CI failure was not due to the pull request itself, but to, e.g., a flaky test.

Syntax	`@Mergifyio requeue`
Example	`@Mergifyio requeue`
Default restrictions	Write access