docs(gate): describe runtime dependency preflight

[stranske]

Summary

• make the runtime dependency helper docstring describe both managed-runtime preflight and YAML-triggered repair
• keep source and consumer template copies identical

Validation

• 105 focused tests pass
• Black, Ruff, mypy
• source/template parity and diff check

Source follow-up from review on the generated consumer wave after #2934.

Summary by CodeRabbit

• Documentation
  • Clarified documentation for runtime dependency handling and PyYAML environment repair.
  • No user-visible behavior or functionality changed.

[cursor]

Bugbot is not enabled for your account, so this pull request was not reviewed.

Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs.

[stranske]

@codex review\n\nPlease review exact head aeb1a93. This follow-up corrects the shared runtime-repair documentation; 105 focused tests and all local quality/parity gates pass. The mandatory seven-minute window began with this push.

[coderabbitai]

Warning

Review limit reached

You’ve reached a temporary PR review limit under our Fair Usage Limits Policy.

Your recent review volume is higher than typical usage, so adaptive limits are currently applied.

Next review available in: 56 minutes

Your organization has reached its usage spending cap. Adjust your spending cap in the billing tab.

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 194f1875-4a18-46fe-a2c4-ef07e6d3b127

📥 Commits

Reviewing files that changed from the base of the PR and between aeb1a93 and 8aa618f.

📒 Files selected for processing (2)

• scripts/check_deliberate_break.py
• templates/consumer-repo/scripts/check_deliberate_break.py

📝 Walkthrough

Walkthrough

The PR updates _run_with_runtime_deps documentation in both the main script and consumer-repository template. It replaces retry-focused wording with descriptions of PyYAML runtime preflight management and YAML-triggered failure repair. No executable behavior changes.

Changes

PyYAML runtime documentation

Layer / File(s)	Summary
Update runtime management documentation scripts/check_deliberate_break.py, templates/consumer-repo/scripts/check_deliberate_break.py	The _run_with_runtime_deps docstrings now describe PyYAML runtime preflight management and YAML-triggered failure repair.

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

Possibly related PRs

• stranske/Workflows#2928: Adds the PyYAML runtime repair behavior documented by this PR.
• stranske/Workflows#2930: Updates related _run_with_runtime_deps documentation.
• stranske/Workflows#2932: Changes the related runtime-detection logic.

Suggested reviewers: copilot, codex-automation

🚥 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 for runtime dependency preflight.
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 docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch codex/runtime-repair-doc-followup

---

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

[stranske-keepalive]

Workflow source needed

PR #2936 needs either a linked GitHub issue or one valid non-issue Workflow Source before PR metadata automation can manage it safely.

Please do one of:

• Add <!-- meta:issue:123 --> or a normal Closes #123 / Related to #123 line.
• Check one Workflow Source option in the PR body.
• Add a hidden marker such as <!-- workflow-source:local_request -->, <!-- workflow-source:manual_remote -->, <!-- workflow-source:review_followup -->, <!-- workflow-source:sync_campaign -->, or <!-- workflow-source:dependabot -->.
• Add a workflow source label such as workflow:source-direct-pr, workflow:source-local-request, workflow:source-review-followup, workflow:source-sync, or workflow:no-automation.

Once a valid source is present, this warning will not be reposted.

[chatgpt-codex-connector]

Codex Review: Didn't find any major issues. Swish!

Reviewed commit: aeb1a93f6b

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

• Open a pull request for review
• Mark a draft as ready
• Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

[Copilot]

Pull request overview

This PR updates the documentation (docstring) for the runtime dependency helper in check_deliberate_break.py to describe both the managed-runtime PyYAML preflight and the YAML-traceback-triggered repair path, while keeping the source and consumer-template copies in sync.

Changes:

• Updated _run_with_runtime_deps docstring to reflect PyYAML runtime dependency preflight and YAML-triggered repair behavior.
• Mirrored the same docstring change in templates/consumer-repo/ to preserve source/template parity.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File	Description
scripts/check_deliberate_break.py	Updates _run_with_runtime_deps docstring describing managed-runtime PyYAML preflight + YAML-triggered repair.
templates/consumer-repo/scripts/check_deliberate_break.py	Mirrors the same docstring update to keep consumer template aligned with source.

[stranske]

@codex review\n\nExact head is now 8aa618f with the managed-pytest/PyYAML relationship clarified in both copies. Please review this exact head; the seven-minute window restarted.

[agents-workflows-bot]

Automated Status Summary

Head SHA: 229961d
Latest Runs: ⏳ pending — Gate
Required contexts: summary
Required: core tests (3.12): ⏳ pending, core tests (3.13): ⏳ pending, docker smoke: ⏳ pending, gate: ⏳ pending

Workflow / Job	Result	Logs
(no jobs reported)	⏳ pending	—

Coverage Overview

• Coverage history entries: 1

Coverage Trend

Metric	Value
Current	76.19%
Baseline	85.00%
Delta	-8.81%
Minimum	70.00%
Status	✅ Pass

Top Coverage Hotspots (lowest coverage)

File	Coverage	Missing
scripts/issue_dedup_smoke.py	0.0%	4
scripts/runner_lib/__main__.py	0.0%	3
scripts/validate_template_sync.py	0.0%	81
scripts/langchain/topic_splitter.py	19.1%	57
tools/codex_log_analyzer.py	19.6%	140
scripts/repo_review_round2_runner.py	25.1%	344
scripts/prune_agent_stubs.py	39.7%	26
scripts/repo_review_round1_runner.py	40.7%	133
tools/ensure_workflow_timeout_variables.py	42.1%	74
scripts/sync_label_docs.py	42.9%	64
tools/discover_model_catalog.py	44.8%	55
scripts/repo_review_backlog_scan.py	45.3%	116
scripts/repo_review_body_writer.py	46.5%	86
tools/codex_session_analyzer.py	47.9%	59
scripts/create_verifier_labels.py	48.3%	58

Low Coverage Files (<50.0%)

File	Coverage	Missing
scripts/issue_dedup_smoke.py	0.0%	4
scripts/runner_lib/__main__.py	0.0%	3
scripts/validate_template_sync.py	0.0%	81
scripts/langchain/topic_splitter.py	19.1%	57
tools/codex_log_analyzer.py	19.6%	140
scripts/repo_review_round2_runner.py	25.1%	344
scripts/prune_agent_stubs.py	39.7%	26
scripts/repo_review_round1_runner.py	40.7%	133
tools/ensure_workflow_timeout_variables.py	42.1%	74
scripts/sync_label_docs.py	42.9%	64
tools/discover_model_catalog.py	44.8%	55
scripts/repo_review_backlog_scan.py	45.3%	116
scripts/repo_review_body_writer.py	46.5%	86
tools/codex_session_analyzer.py	47.9%	59
scripts/create_verifier_labels.py	48.3%	58

Updated automatically; will refresh on subsequent CI/Docker completions.

---

Keepalive checklist

Scope

No scope information available

Tasks

• No tasks defined

Acceptance criteria

• No acceptance criteria defined

[chatgpt-codex-connector]

Codex Review: Didn't find any major issues. Can't wait for the next one!

Reviewed commit: 8aa618f499

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

• Open a pull request for review
• Mark a draft as ready
• Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".