docs: add deprecation banner to delete_head_branch action#10790
Conversation
The delete_head_branch action is deprecated (engine#27721) and will be removed on June 30, 2026. Users should use GitHub's built-in auto-delete branches setting instead. Refs: MRGFY-6799 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Change-Id: I86761e73de36c68ad13a723a17628acdd39bd221
Merge ProtectionsYour pull request matches the following merge protections and will not be merged until they are valid. 🔴 👀 Review RequirementsThis rule is failing.
🔴 🔎 ReviewsThis rule is failing.
🟢 🤖 Continuous IntegrationWonderful, this rule succeeded.
🟢 Enforce conventional commitWonderful, this rule succeeded.Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/
🟢 📕 PR descriptionWonderful, this rule succeeded.
|
There was a problem hiding this comment.
Pull request overview
Adds a prominent deprecation notice to the delete_head_branch action documentation so users are directed toward GitHub’s built-in automatic branch deletion ahead of the planned removal date.
Changes:
- Introduces a
:::dangerdeprecation banner at the top of thedelete_head_branchaction doc. - Provides an external link to GitHub documentation for enabling automatic head-branch deletion.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| :::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. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
@copilot apply changes based on this feedback
There was a problem hiding this comment.
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
| 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. |
There was a problem hiding this comment.
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.
JulianMaurin
deleted the
devs/JulianMaurin/deprecate-queue-branch-merge-method/I86761e73de36c68ad13a723a17628acdd39bd221
branch
The delete_head_branch action is deprecated (engine#27721) and will be
removed on June 30, 2026. Users should use GitHub's built-in auto-delete
branches setting instead.
Refs: MRGFY-6799
Co-Authored-By: Claude Opus 4.6 (1M context) noreply@anthropic.com