Skip to content

docs(release): name the full-queue startup failure in recovery - #882

Merged
ShaiShmuel merged 2 commits into
mainfrom
fix/release-workflow-startup
Nov 3, 2026
Merged

ShaiShmuel merged 2 commits into
mainfrom
fix/release-workflow-startup

Conversation

@ShaiShmuel

@ShaiShmuel ShaiShmuel commented Nov 2, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Every Release run since 2026-10-26 22:47 UTC fails at startup with zero jobs, and GitHub says it "likely failed because of a workflow file issue". The workflow files are fine. The release concurrency queue is full.

This PR changes no workflow behavior. It adds the symptom to the release-PR authoring recovery section of RELEASE.md, so the next person goes to the documented cleanup instead of debugging the workflow file.

Unblocking the release (maintainer action, not part of this PR)

Follow the existing "Release-PR authoring" recovery in RELEASE.md:

  1. Cancel the obsolete pending push runs. Keep only the one you intend to approve. The newest pending run, 40408909263, runs release.yml and release-please inputs that are identical to current main. Alternatively, cancel all of them and approve the run from the next push to main.
  2. Then cancel the old waiting run 38540932484. If it is cancelled first, the oldest pending run starts next.
  3. Approve the retained run's release-automation job, then review the release PR it opens as usual.

Test plan

  • python3 -m tools.ci.check_release_contract
  • mise run test -- tools/ci/tests/test_release_contract.py (94 passed)

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Clarified that a release authoring run awaiting approval holds the release queue and can delay later pushes.
    • Documented that when the pending queue reaches capacity, subsequent release runs may fail without starting any jobs and report a workflow-file issue.
    • Added troubleshooting guidance to check for a waiting release run and follow the existing cleanup steps before investigating workflow configuration.

When an authoring run waits for its release-automation approval, later
push runs queue behind it in the queue: max concurrency group. After
100 pending runs GitHub rejects every new Release run at startup with
zero jobs and reports a likely workflow file issue, which points the
investigation at the wrong place. Say so in the authoring recovery
section and point at the existing cleanup.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Nov 2, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review.

Walkthrough

RELEASE.md explains how an authoring run waiting for approval holds the release concurrency group and causes later pushes to queue. It describes the failure that occurs when 100 runs are pending and directs maintainers to check for a waiting Release run before debugging the workflow file.

Changes: Release documentation

Layer / File(s) Summary
Explain the Release run queue condition
RELEASE.md
The guidance describes the effect of an authoring run waiting for approval. It directs maintainers to check for a waiting Release run and apply the preceding cleanup before investigating the workflow file.

Suggested reviewers: mamayer19

Merge Risk: Minimal · up to e00ab

The release recovery guidance is mergeable; no actionable issue remains.

Pre-merge checks: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely identifies the documentation change: naming the full-queue startup failure in release recovery guidance.
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

Finishing Touches
Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Tip

🎯 Customize your risk assessments

Guide how CodeRabbit assesses merge risk and security architecture risk. Highlight sensitive changes and explain your security boundaries using Merge Risk Instructions and Security Risk Instructions in your review settings. Security architecture risk assessments require the Advanced plan or above.

✅ Automatic approvals, with your rules

Let CodeRabbit approve pull requests once required threads are resolved, pre-merge checks pass, and your risk limits are met. Enable Automatic approvals in review settings, with overrides for teams or file paths.

CodeRabbit Verify

  • Run CodeRabbit Verify to test the changes in this pull request.
Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Team
  • Run ID: cdd31d67-0e32-45e0-81f7-33885de0ad4f
Commits

Reviewing files that changed from the base of the PR and between 6d8440f and e00abbc.

Files selected for processing: 1
  • RELEASE.md
Files skipped from review as they are similar to previous changes: 1
  • RELEASE.md

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 7 remain after this review.

@coderabbitai coderabbitai Bot left a comment •

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

  • Fix comments: Fix CodeRabbit comments on this PR

Comment thread RELEASE.md Resolved
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@ShaiShmuel
ShaiShmuel marked this pull request as ready for review November 3, 2026 09:27
@ShaiShmuel
ShaiShmuel requested a review from a team as a code owner November 3, 2026 09:27
@ShaiShmuel
ShaiShmuel added this pull request to the merge queue Nov 3, 2026
Merged via the queue into main with commit cd9dd82 Nov 3, 2026
19 checks passed
@ShaiShmuel
ShaiShmuel deleted the fix/release-workflow-startup branch November 3, 2026 10:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant