Skip to content

docs: add deprecation banner to delete_head_branch action #10790

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

Closed
JulianMaurin wants to merge 1 commit into from
Closed

docs: add deprecation banner to delete_head_branch action #10790

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
7 changes: 7 additions & 0 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
Expand Up @@ -5,6 +5,13 @@ description: Delete pull request head branch. Useful to clean pull requests once

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](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-the-automatic-deletion-of-branches)
setting instead.
Comment on lines +8 to +12
Copy link

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The banner says this action is deprecated, but the page frontmatter still presents it as an active feature (title/description). To keep search results/navigation consistent with other deprecated action docs (e.g., src/content/docs/workflow/actions/post_check.mdx), update the frontmatter to clearly indicate deprecation/removal timeline.

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown
Contributor Author

@JulianMaurin JulianMaurin Apr 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot apply changes based on this feedback

Copy link
Copy Markdown

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated the frontmatter to match the post_check.mdx pattern:

  • title: Delete Head Branch (Deprecated)
  • description: mentions deprecation and the June 30, 2026 removal date

Comment on lines +9 to +12
Copy link

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This banner advises users to use GitHub’s built-in auto-delete setting, but there is an existing doc page (src/content/docs/workflow/delete-head-branches.mdx) that currently recommends delete_head_branch as the ideal tool and contrasts it favorably against GitHub’s setting. Please update that page (or otherwise align cross-links/messaging) to avoid conflicting guidance.

Copilot uses AI. Check for mistakes.
:::

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
Loading