Rebase

Rebase the pull request on top of its base branch.

The rebase action makes Mergify rebase the pull request on top of its base branch. This is useful when you want to ensure that your pull request is always up-to-date with the latest changes from the base branch.

Note

You do not need to use this action if you use the merge queue. The merge queue automatically update the pull requests it processes as necessary, making sure they are tested with up-to-date code before being merged.

Parameters

Key name	Value type	Default
`autosquash`	boolean	`true`
When set to `True`, commits starting with `fixup!`, `squash!` and `amend!`are squashed during the rebase.
`bot_account`	template
To rebase, Mergify needs to impersonate a GitHub user. You can specify the account to use with this option. If no `bot_account` is set, Mergify picks the pull request author. The user account must have already been logged in Mergify dashboard once.

Examples

Here's an example of how to use the rebase action:

1
pull_request_rules:
2
  - name: continuously rebase pull request when it's labeled with `rebase`
3
    conditions:
4
      - label=rebase
5
    actions:
6
      rebase:

Note that this will rebase the pull request as long as it has the label.

If you wanted to do rebase only once, you would also need to remove the label.

1
pull_request_rules:
2
  - name: rebase pull request once when it's labeled with `rebase`
3
    conditions:
4
      - label=rebase
5
    actions:
6
      rebase: {}
7
      label:
8
        remove:
9
          - rebase

Edit on GitHub