Skip to content

docs(markers): remove obsolete marker entries, add drift CI test#764

Draft
Copilot wants to merge 1 commit into
mainfrom
copilot/audit-template-markers-usage
Draft

docs(markers): remove obsolete marker entries, add drift CI test#764
Copilot wants to merge 1 commit into
mainfrom
copilot/audit-template-markers-usage

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 26, 2026

Two fully-removed template markers ({{ mcp_client_config }} and {{ copilot_version }}) were still documented in docs/template-markers.md with no corresponding code in src/. No mechanism existed to catch this kind of drift going forward.

Changes

docs/template-markers.md

  • Remove {{ mcp_client_config }} section — marker was absorbed into the runtime MCPG→Copilot config pipeline step; no src/ references remain
  • Remove {{ copilot_version }} section — absorbed into {{ engine_install_steps }} long ago; no src/ references remain
  • All 47 markers present in src/data/*.yml are confirmed documented and accurate

tests/compiler_tests.rs

  • Add test_template_marker_docs_coverage: scans every src/data/*.yml for {{ marker }} patterns and asserts each has a matching ## {{ marker }} heading in docs/template-markers.md; runs as part of cargo test

.github/workflows/rust-tests.yml

  • Add docs/template-markers.md to the PR path filter so the drift test fires on doc-only edits too

Test plan

cargo test test_template_marker_docs_coverage — passes. Full cargo test suite — all 1800+ tests pass, 0 failures.

- Remove {{ mcp_client_config }} (obsolete) section from docs/template-markers.md
- Remove {{ copilot_version }} (removed) section from docs/template-markers.md
- Add test_template_marker_docs_coverage in tests/compiler_tests.rs to
  catch future marker drift between src/data/*.yml and docs
- Extend rust-tests.yml trigger paths to include docs/template-markers.md

Co-authored-by: jamesadevine <4742697+jamesadevine@users.noreply.github.com>
@github-actions github-actions Bot mentioned this pull request May 27, 2026
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.

2 participants