docs(architecture): update env delivery to reflect current schema - #2861
docs(architecture): update env delivery to reflect current schema#2861ralphbean wants to merge 1 commit into
Conversation
Replace stale runner_env references with the current env.runner / env.sandbox terminology (ADR 0055). The deprecation period is over; describe the scheme as-is rather than as a migration in progress. Assisted-by: Claude claude-opus-4-6 <noreply@anthropic.com> Signed-off-by: Ralph Bean <rbean@redhat.com>
PR Summary by QodoDocs: align architecture env terminology with current env.runner/env.sandbox schema
AI Description
Diagram
High-Level Assessment
Files changed (1)
|
Site previewPreview: https://cf6d15de-site.fullsend-ai.workers.dev Commit: |
|
🤖 Finished Review · ✅ Success · Started 6:26 PM UTC · Completed 6:34 PM UTC |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
|
Looks good to me Labels: Docs-only change updating architecture.md terminology. |
| deprecated ([ADR 0055](ADRs/0055-unified-env-var-delivery.md), amending | ||
| sub-maps delivers environment variables. `env.runner` configures host-side | ||
| scripts; `env.sandbox` generates the sandbox `.env` file at bootstrap | ||
| ([ADR 0055](ADRs/0055-unified-env-var-delivery.md), amending |
There was a problem hiding this comment.
LOW — Removing deprecation language may be premature
runner_env is still functional: scaffold harnesses (code.yaml, review.yaml, retro.yaml) still use it, the Go struct still defines RunnerEnv, and lint.go emits deprecation warnings at runtime. ADR 0055 Phase 2–3 are not yet complete.
Consider a brief nod to the transition, e.g.:
a single
env:key withrunnerandsandboxsub-maps delivers environment variables (superseding the deprecatedrunner_env)
This is a judgment call — the PR is correct as-is if the intent is to document the target state rather than the transitional state.
|
Wayne's right — runner_env is still in active use and the migration isn't done. The text on main already accurately describes the transitional state. Closing this as premature; we can revisit once ADR 0055 Phase 2–3 are complete. |
|
🤖 Finished Retro · ✅ Success · Started 12:02 PM UTC · Completed 12:08 PM UTC |
Retro: PR #2861 — docs(architecture): update env delivery to reflect current schemaTimeline
AnalysisReview quality gap: The review agent approved a PR that described the target state of an incomplete migration rather than the current transitional state. The human reviewer caught this by cross-referencing the codebase (harness YAML files, Go structs, linter warnings) — exactly the kind of verification the review agent's docs-currency and correctness sub-agents should have performed but did not. Impact: Moderate. The Existing coverageThis pattern is well-recognized in the backlog. The following open issues already propose the improvements needed to prevent this class of miss:
Implementing any of #2199, #2172, or #2676 would likely have prevented this specific miss. No new proposals are warranted — this retro serves as additional evidence supporting those existing issues. Autonomy assessmentThe review agent's docs-currency and correctness sub-agents treated this as a straightforward terminology update without verifying the underlying migration status. Until the capabilities described in #2199/#2172 are implemented, the review agent should not be granted full autonomy on docs PRs that describe feature deprecation or migration status. The existing issue #1772 (defer |
Summary
runner_envreferences indocs/architecture.mdwith the currentenv.runner/env.sandboxterminologyFollows up on #2756.
Test plan
runner_envreferences indocs/architecture.md🤖 Generated with Claude Code