Skip to content

docs(e2e): align recovery scope - #9060

Closed
cv wants to merge 1 commit into
mainfrom
codex/align-platform-recovery-docs
Closed

docs(e2e): align recovery scope#9060
cv wants to merge 1 commit into
mainfrom
codex/align-platform-recovery-docs

Conversation

@cv

@cv cv commented Aug 13, 2026

Copy link
Copy Markdown
Collaborator

Summary

Follow up on #9040 by correcting the two remaining references to the former platform-workflow layout. Hosted Runner Recovery guidance now names the consolidated CI / Platform Evidence workflow consistently.

Changes

  • Tie the recovery retirement window to CI / Platform Evidence.
  • Describe recovery telemetry as evidence from that workflow instead of three workflows.

Type of Change

  • Code change (feature, bug fix, or refactor)
  • Code change with doc updates
  • Doc only (prose changes, no code sample modifications)
  • Doc only (includes code sample changes)

Quality Gates

  • Tests added or updated for changed behavior
  • Existing tests cover changed behavior — justification:
  • Tests not applicable — justification: This is a prose-only workflow-name correction; executable behavior and code samples do not change.
  • Docs updated for user-facing behavior changes
  • Docs not applicable — justification:
  • Sensitive paths changed (security, policy, credentials, preflight, onboarding, inference, runner, sandbox, or messaging)
  • Sensitive-path review completed or maintainer-approved waiver recorded — reviewer/approval link/justification: An independent documentation writer review verified the recovery scope against .github/workflows/hosted-runner-recovery.yaml at the exact commit.
  • Non-success, skipped, or missing CI check accepted by maintainer — check name, approval link, and follow-up issue:

Documentation Writer Review

  • Documentation writer subagent reviewed the completed changes
  • Result: docs-updated
  • Evidence: test/e2e/README.md; the writing rules and documentation style were reviewed.
  • Agent: Codex Desktop

Verification

  • PR description includes a Signed-off-by: line and every commit appears as Verified in GitHub
  • Normal pre-commit, commit-msg, and pre-push hooks passed, or npm run validate:pr passed after refreshing origin/main when hooks were skipped or unavailable
  • Targeted behavior tests pass for the current change set, or tests are marked not applicable above — command/result or justification: Tests are not applicable because no executable behavior changed.
  • Applicable broad gate passed — npm test for broad runtime/test-harness changes; npm run check for repo-wide validation/coverage changes — command/result:
  • Quality Gates section completed with required justifications or waivers
  • No secrets, API keys, or credentials committed
  • npm run docs builds without warnings (doc changes only) — command passed; Fern reported two unrelated warnings for unauthenticated redirect checking and the existing light-mode accent contrast.
  • Doc pages follow the style guide (doc changes only)
  • New doc pages include SPDX header and frontmatter (new pages only)

Signed-off-by: Carlos Villela cvillela@nvidia.com

Summary by CodeRabbit

  • Documentation
    • Updated recovery-removal guidance to reference CI / Platform Evidence.
    • Clarified that runner-loss evidence no longer needs to originate from three separate platform workflows.

Signed-off-by: Carlos Villela <cvillela@nvidia.com>
@cv cv self-assigned this Aug 13, 2026
@coderabbitai

coderabbitai Bot commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: a03765f7-dfe9-450b-b056-5170b6e9f77f

📥 Commits

Reviewing files that changed from the base of the PR and between 8860d24 and 4f5b3f9.

📒 Files selected for processing (1)
  • test/e2e/README.md

📝 Walkthrough

Walkthrough

The E2E README now refers to CI / Platform Evidence for recovery-removal criteria and removes the three-workflow limitation from runner-loss evidence guidance.

Changes

E2E evidence guidance

Layer / File(s) Summary
Update evidence requirements
test/e2e/README.md
Recovery-removal guidance now requires 30 consecutive days without accepted recovery-classified failures from CI / Platform Evidence. Runner-loss evidence is no longer limited to three platform workflows.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Mergeability Score: ⚪ Minimal · up to 4f5b3

This PR only corrects workflow-name references in documentation and does not change executable behavior or production configuration. No actionable merge-blocking risk remains after normal checks and review.

Possibly related PRs

Suggested reviewers: aasthajh

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the documentation change to align Hosted Runner Recovery scope with the consolidated workflow.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/align-platform-recovery-docs

Comment @coderabbitai help to get the list of available commands.

@cv

cv commented Aug 13, 2026

Copy link
Copy Markdown
Collaborator Author

Closing as superseded by #8903. Its merge commit 0497b56 replaced both remaining references to three platform workflows on main with the singular platform-evidence workflow, so this branch no longer has an independently valuable change.

@cv cv closed this Aug 13, 2026
@github-actions

github-actions Bot commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

PR Review Advisor — No blocking findings reported

Advisor assessment: No blocking advisor findings reported
Next action: No advisor follow-up needed.
Findings: 0 blockers · 0 warnings · 0 suggestions

Model lanes

  • GPT-5.6 Terra (primary): Completed · high confidence · 0 blockers · 0 warnings · 0 suggestions
  • Nemotron 3 Ultra (second opinion): Completed · high confidence · 0 blockers · 0 warnings · 0 suggestions
  • Model comparison: normalized findings match; normalized terminology decisions differ; normalized E2E selections match; severity counts match.

Second-opinion terminology and E2E selections are advisory. Live E2E does not run automatically for pull requests.

2 semantic terminology decisions

Terminology decisions are advisory. They affect the assessment only when a separate finding identifies concrete semantic impact.

  • established — CI / Platform Evidence at test/e2e/README.md:666: Keep the established literal workflow name.
  • established — CI / Platform Evidence at test/e2e/README.md:791: Keep the established literal workflow name.

E2E guidance

Advisory only. A maintainer can dispatch the default E2E suite for the commit under review.

Recommended E2E: None

Workflow run details

This automated review informs maintainers. Warnings and suggestions do not require a response. A maintainer decides whether to merge.

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