View as Markdown

Close

Close a pull request.

The close action allows Mergify to automatically close pull requests when the specified conditions are met. This can be particularly useful when you want to ensure that certain types of pull requests are not merged.

Parameters

Section titled Parameters
message#Message template·defaultThis pull request has been automatically closed by Mergify.

A string with {{ variable }} placeholders.

Examples

Section titled Examples

Automatically close pull requests touching a file

Section titled Automatically close pull requests touching a file

If you want to automatically close any pull request that touches a certain file, let’s say do_not_touch.txt, you could write a rule such as:

pull_request_rules:
  - name: disallow changing a file
    conditions:
      - files = do_not_touch.txt
    actions:
      close:
        message: No PR can touch this file.

Was this page helpful?

Edit this page on GitHub