Skip to content

Fix doc drift in CI/CD workflows README and repo layout#74

Draft
Copilot wants to merge 3 commits intomainfrom
copilot/improve-onboarding-documentation
Draft

Fix doc drift in CI/CD workflows README and repo layout#74
Copilot wants to merge 3 commits intomainfrom
copilot/improve-onboarding-documentation

Conversation

Copy link
Contributor

Copilot AI commented Feb 27, 2026

  • Discover: audited repo structure, CI workflows, and documentation files
  • Audit: built Doc Drift Candidate List (found 3 HIGH, 2 MEDIUM, 2 LOW severity mismatches)
  • Select: chose theme "Correct CI/CD and onboarding docs to match actual workflows and repo structure"
  • Fix .github/workflows/README.md — wrong output names, wrong UI test command, wrong test path, incomplete test list, duplicate numbering
  • Fix root README.md — incomplete Cargo workspace description, incomplete repository layout
  • Add drift-prevention script (scripts/check-doc-drift.sh) to verify docs match CI reality
  • Verify: drift-prevention script passes all checks
  • Create .jules/atlas.md journal
  • Code review — addressed all comments (1 false positive, 2 acceptable edge cases)
  • Security scan — no issues (shell script and docs only)

💡 What

Fix documentation drift in CI/CD workflow docs and root README that had incorrect output names, wrong commands, wrong file paths, and incomplete repository layout.

Files touched:

  • .github/workflows/README.md — Fixed 3 HIGH-severity mismatches and 2 LOW-severity issues
  • README.md — Fixed 2 MEDIUM-severity omissions in repository layout
  • scripts/check-doc-drift.sh — NEW drift prevention script
  • .jules/atlas.md — NEW Atlas journal

🎯 Why

New contributors following the workflows README would:

  1. Reference wrong output names (debug-artifact-name instead of test-artifact-name) when extending CI
  2. Run a non-existent Gradle task (pixel7Api34DebugAndroidTest instead of pixel7Api34StagingDebugAndroidTest)
  3. Look for test files in wrong path (com/btreemap/letterbox/ instead of org/joefang/letterbox/)
  4. Not know about the rust/letterbox-proxy crate or the docs/ directory

🧾 Evidence (Parity Table)

Claim (doc) Source of truth (repo) Result
Output: debug-artifact-name build.yml defines test-artifact-name ✅ Fixed
Output: release-artifact-name build.yml defines prod-release-artifact-name ✅ Fixed
Command: pixel7Api34DebugAndroidTest android-ui.yml runs pixel7Api34StagingDebugAndroidTest ✅ Fixed
Path: com/btreemap/letterbox/ Files are in org/joefang/letterbox/ ✅ Fixed
3 test files listed 11 test files exist ✅ Fixed
Cargo.toml: "pointing to rust/letterbox-core" Workspace has 2 members ✅ Fixed
Repo layout: 5 items Missing proxy, docs, workflows ✅ Fixed

🧪 Verification

./scripts/check-doc-drift.sh

🔒 Drift Prevention

scripts/check-doc-drift.sh verifies:

  1. build.yml output names match workflows README
  2. UI test command in android-ui.yml matches workflows README
  3. androidTest file path in README exists on disk
  4. Every test file listed in README exists
  5. All Cargo workspace members are mentioned in root README

✅ Final Checklist

  • All edited operational claims are verified against repo files
  • Validation commands run (scripts/check-doc-drift.sh)
  • Drift prevention added (scripts/check-doc-drift.sh)
  • No secrets committed

🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

Copilot AI and others added 2 commits February 28, 2026 00:02
- Fix wrong UI test command in workflows README (pixel7Api34DebugAndroidTest -> pixel7Api34StagingDebugAndroidTest)
- Fix wrong artifact output names (debug-artifact-name -> test-artifact-name, release-artifact-name -> prod-release-artifact-name)
- Fix wrong package path (com/btreemap/letterbox -> org/joefang/letterbox)
- Update test file listing from 3 to all 11 actual test files
- Add missing rust/letterbox-proxy and docs/ to README repo layout
- Fix Cargo.toml description to mention both workspace members
- Add scripts/check-doc-drift.sh for drift prevention
- Add .jules/atlas.md journal

Co-authored-by: MinecraftFuns <25814618+MinecraftFuns@users.noreply.github.com>
…clean up dead code

Co-authored-by: MinecraftFuns <25814618+MinecraftFuns@users.noreply.github.com>
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