Skip to content

docs: fix stale engine template docs, add TODO for test engine hardcode#295

Merged
jamesadevine merged 1 commit intomainfrom
engine-followup-fixes
Apr 22, 2026
Merged

docs: fix stale engine template docs, add TODO for test engine hardcode#295
jamesadevine merged 1 commit intomainfrom
engine-followup-fixes

Conversation

@jamesadevine
Copy link
Copy Markdown
Collaborator

Summary

Follow-up to #286 — fixes two items missed in the merge:

Changes

  1. AGENTS.md: Replace stale {{ copilot_ado_env }} section with correct {{ engine_env }} docs. The template marker was renamed but the docs still described the old semantics (ADO token passthrough). The actual {{ engine_env }} generates engine-specific env vars (GITHUB_TOKEN, OTEL config) via Engine::env().

  2. CompileContext::for_test(): Add TODO comment flagging that Engine::Copilot is hardcoded. Currently correct (only engine), but will need to resolve from front_matter.engine when additional engines are added.

Testing

All 930 tests pass.

…hardcode

- Replace obsolete {{ copilot_ado_env }} AGENTS.md section with correct
  {{ engine_env }} docs (engine-specific env vars: GITHUB_TOKEN, OTEL)
- Add TODO to CompileContext::for_test() flagging hardcoded Engine::Copilot
  as tech debt for when multiple engines are supported

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@jamesadevine jamesadevine merged commit a078012 into main Apr 22, 2026
4 of 7 checks passed
@jamesadevine jamesadevine deleted the engine-followup-fixes branch April 22, 2026 07:40
@github-actions
Copy link
Copy Markdown
Contributor

🔍 Rust PR Review

Summary: Looks good — clean docs fix with accurate content, and a well-placed TODO.

Findings

✅ What Looks Good

  • AGENTS.md update is accurate: The new {{ engine_env }} docs correctly reflect what Engine::Copilot::env() actually generates (GITHUB_TOKEN, GITHUB_READ_ONLY, COPILOT_OTEL_*). The code in src/engine.rs matches the docs exactly, and {{ acquire_ado_token }} correctly handling ADO tokens separately is well-explained.
  • No stale references: copilot_ado_env is fully removed — no dangling references in templates or code.
  • TODO placement: The comment in for_test() is accurate and actionable — the current hardcode of Engine::Copilot is safe since it's the only variant.

⚠️ Suggestion

  • [src/compile/extensions/mod.rs:174] for_test_with_org() has the same Engine::Copilot hardcode but the TODO only covers for_test(). Minor, but worth adding the same note there for consistency when this comes up for real.

Generated by Rust PR Reviewer for issue #295 · ● 355.8K ·

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