update action instructs Mergify to update the pull request branch with
its base branch.
When this action is added to a rule, Mergify will update the pull request branch with the latest changes from its base branch, if necessary. This is done by merging the base branch into the pull request branch or by rebasing the pull request branch onto the base branch, based on your preference.
ParametersSection titled Parameters
Mergify can impersonate a GitHub user to review a pull request. If no
ExamplesSection titled Examples
Update When BehindSection titled Update When Behind
You can ask Mergify to update your pull requests when they are a few commits behind their base branch, for example:
Linear HistorySection titled Linear History
As GitHub supports linear history in pull request settings, it is very handy to use a rule to keep your pull requests up-to-date. As you do not want to trigger your CI too often by always re-running it on every pull request — especially when there is still work in progress — you can limit this action to labeled pull requests.
When a pull request is not a draft, and has the label
will be automatically updated with its base branch.