Document release failure recovery procedure#408
Conversation
Add a "Handling a failed release" subsection to the Release Process section in AGENTS.md, covering: deleting the release and tag, fixing the issue via the normal PR process, updating the release summary issue if needed, and re-publishing from the publish step.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #408 +/- ##
=======================================
Coverage 85.30% 85.30%
=======================================
Files 12 12
Lines 939 939
=======================================
Hits 801 801
Misses 138 138 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
Adds operational documentation to AGENTS.md describing how to recover when the release CI workflow fails after a GitHub release has already been published, so maintainers can safely delete and re-run the release after fixing the underlying issue.
Changes:
- Add a “Handling a failed release” subsection under the Release Process section.
- Document steps to delete the release/tag, apply a fix via the normal PR process, optionally update the release summary issue, and re-publish.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Add a "Handling a failed release" subsection to the Release Process section of
AGENTS.md, and add a new## Issuessection with guidance on opening issues before starting work. Also improves the PR template to include theFixes #<number>line.The "Handling a failed release" subsection covers:
mainto pass.The
## Issuessection documents that work should start with a GitHub issue including a structured template (Problem/Goal, Context, Reproduction, Considerations),--assignee @me, and a note to proceed with branching immediately unless told to wait.The need for the failure recovery docs was identified during the
v2.10.0release, where the release workflow failed due to a missingworkflowspermission (see #406 / #407).Squash commit message
Click to view squash commit message