docs(release): write down the orphaned-anchor recovery - #282
Merged
Conversation
The publish-analyzer job declares `container:`, and a container job's default shell is `sh`, not the `bash` a runner-hosted job gets. Its build step opens with `set -euo pipefail`, which dash rejects: the 0.40.0 release died on that first line with "Illegal option -o pipefail", 59 seconds in, having compiled nothing. The job is gated on `release_created`, so it had never once run before that release — cancelled in the run that added it, skipped in the next. Its first execution was also its first failure, and it fails every time, not intermittently. Declaring the shell for the whole job rather than the one broken step keeps a later step from silently inheriting dash again. publish-helm is the other container job and carries the same trap, but it uses no bash-only syntax, so it stays untouched here. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
A failed publish job strands the GitHub Release as a draft, and a draft is invisible to release-please twice over: it is skipped in the release search and it creates no tag. The manifest still names the version, so the next run has a version it cannot anchor and proposes the entire history as one release. It has now happened twice, and both times the recovery was rediscovered from scratch rather than looked up. The fix is a lightweight tag at the release commit, which the troubleshooting section now spells out alongside the log line that identifies the case, so the next person matches the symptom instead of deriving it. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThe release guide adds recovery instructions for oversized Release PRs caused by missing tags, while the publish analyzer job is configured to execute scripts with Bash. ChangesRelease operations
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Twice now a release has produced a PR containing the entire repository history, and both times the recovery was rediscovered from scratch. This writes it into the Troubleshooting section of
.github/RELEASES.md, keyed to the log line that identifies the case:The mechanism
release-please-config.jsonsetsdraft: true, which the publish jobs require so they can attach assets before immutable releases freeze the release. A publish job that fails therefore strands the release as a draft, and a draft is invisible to release-please twice over: it is skipped in the release search, and it creates no tag..release-please-manifest.jsonstill names the version, so the next run holds a version it cannot anchor and falls back to collecting every commit in the repository.That is what produced PR #280 (
0.41.0, re-announcing the already-shipped breaking analyzer change) after the 0.40.0 publish failed on the dash/bash bug fixed in #279.What the entry gives the reader
last-release-shadoes not rescue this, because release-please reads it only as a top-level key and this repo's copy is nested underpackages["."].Documentation only, no behaviour change.
task lint-docspasses; I also ran Vale directly on the file since it is not in.docs-lint-scope. The two Vale errors it reports are pre-existing em dashes at lines 68 and 73; the added prose has none, and its headings follow the file's existing Title Case rather than introducing a second convention mid-document.🤖 Generated with Claude Code
Summary by CodeRabbit
Bug Fixes
Documentation