Delete Head Branch

Delete pull request head branch. Useful to clean pull requests once closed.

The delete_head_branch action allows Mergify to automatically delete the head branch of a pull request once it has been merged. This can be useful for maintaining a clean repository and reducing clutter from unused branches.

Parameters

Section titled Parameters
Key nameValue type
forceboolean

If set to true, the branch will be deleted even if another pull request depends on the head branch. GitHub will therefore close the dependent pull requests.

Examples

Section titled Examples

Here is an example of how the delete_head_branch action can be used in your workflow:

pull_request_rules:
  - name: delete head branch after merge if the label "cleanup" is present
    conditions:
      - merged
      - "label=cleanup"
    actions:
      delete_head_branch:

In this example, Mergify will automatically delete the head branch of a pull request once it has been merged, but only if the pull request has been labeled with “cleanup”.

The delete_head_branch action is a simple yet powerful tool that can help maintain the cleanliness and organization of your repository.