Skip to content

docs: deprecate delete_head_branch action #10791

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mergify merged 1 commit into from
Apr 2, 2026
+13 −125
Merged

docs: deprecate delete_head_branch action #10791

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/content/docs/workflow/actions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ management.
<Docset title="Comment" path="comment" icon="fa-solid:list-alt">
Comment a pull request.
</Docset>
<Docset title="Delete Head Branch" path="delete_head_branch" icon="bi:scissors">
Delete pull request head branch.
<Docset title="Delete Head Branch (Deprecated)" path="delete_head_branch" icon="bi:scissors">
Deprecated — use GitHub's built-in "Automatically delete head branches" setting instead.
</Docset>
<Docset title="Dismiss Reviews" path="dismiss_reviews" icon="tabler:message-x">
Dismiss previous reviews on a pull request.
Expand Down
12 changes: 10 additions & 2 deletions src/content/docs/workflow/actions/delete_head_branch.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
---
title: Delete Head Branch
description: Delete pull request head branch. Useful to clean pull requests once closed.
title: Delete Head Branch (Deprecated)
description: Delete pull request head branch. Deprecated in favor of GitHub's built-in "Automatically delete head branches" setting.
---

import ActionOptionsTable from '../../../../components/Tables/ActionOptionsTable';

:::danger
The `delete_head_branch` action is **deprecated** and will be removed on
June 30, 2026. Use GitHub's built-in
[automatically delete head branches][gh-auto-delete] setting instead.
:::

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.
Expand Down Expand Up @@ -34,3 +40,5 @@ with "cleanup".

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

[gh-auto-delete]: https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-the-automatic-deletion-of-branches
115 changes: 0 additions & 115 deletions src/content/docs/workflow/delete-head-branches.mdx
View file
Open in desktop

This file was deleted.

7 changes: 1 addition & 6 deletions src/content/navItems.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,11 +212,6 @@ const navItems: NavItem[] = [
path: '/workflow/request-reviews',
icon: 'octicon:code-review-16',
},
{
title: 'Delete Head Branches',
path: '/workflow/delete-head-branches',
icon: 'bi:scissors',
},
{
title: 'Dismiss Reviews',
path: '/workflow/dismiss-reviews',
Expand All @@ -236,7 +231,7 @@ const navItems: NavItem[] = [
{ title: 'Copy', path: '/workflow/actions/copy', icon: 'fa6-solid:share-nodes' },
{ title: 'Comment', path: '/workflow/actions/comment', icon: 'fa-solid:list-alt' },
{
title: 'Delete Head Branch',
title: 'Delete Head Branch (Deprecated)',
path: '/workflow/actions/delete_head_branch',
icon: 'bi:scissors',
},
Expand Down
Loading