โš™๏ธ 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

To run commands, a user needs to be the author of the pull request or have write access to the repository. More restrictions can be added with Commands Restrictions.

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

rebase๐Ÿ”—

Runs the rebase action.

Syntax

@Mergifyio rebase

Example

@Mergifyio rebase

update๐Ÿ”—

Runs the update action.

Syntax

@Mergifyio update

Example

@Mergifyio update

backport๐Ÿ”—

Runs the backport action.

Syntax

@Mergifyio backport <branch name> <branch name 2> โ€ฆ

Example

@Mergifyio backport stable/3.1 stable/4.0

copy๐Ÿ”—

Runs the copy action.

Syntax

@Mergifyio copy <branch name> <branch name 2> โ€ฆ

Example

@Mergifyio copy stable/3.1 stable/4.0

squash๐Ÿ”—

Runs the squash action.

Syntax

@Mergifyio squash [<commit_message format>]

Example

@Mergifyio squash first-commit

refresh๐Ÿ”—

Re-evaluates your Mergify rules on this pull request.

Syntax

@Mergifyio refresh

Example

@Mergifyio refresh

unqueue๐Ÿ”—

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

Syntax

@Mergifyio unqueue

Example

@Mergifyio unqueue

requeue๐Ÿ”—

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

Syntax

@Mergifyio requeue

Example

@Mergifyio requeue