Meshtastic-Android/docs/agent-playbooks/testing-and-ci-playbook.md
James Rich d076361c55
refactor: migrate core UI and features to KMP, adopt Navigation 3 (#4750)
Signed-off-by: James Rich <2199651+jamesarich@users.noreply.github.com>
2026-03-10 17:29:47 +00:00

2.4 KiB

Testing and CI Playbook

Use this matrix to choose the right verification depth for a change.

1) Baseline local verification order

Run in this order for routine changes:

./gradlew clean
./gradlew spotlessCheck
./gradlew spotlessApply
./gradlew detekt
./gradlew assembleDebug
./gradlew test

Notes:

  • This order aligns with repository guidance in AGENTS.md and .github/copilot-instructions.md.
  • CI additionally runs testDebugUnitTest in .github/workflows/reusable-check.yml.

2) Change-type matrix

  • docs-only changes:
    • Usually no Gradle run required.
    • If you touched code examples or command docs, at least run spotlessCheck if practical.
  • UI text/resource changes:
    • spotlessCheck, detekt, assembleDebug.
  • feature/commonMain logic changes:
    • spotlessCheck, detekt, test, assembleDebug.
  • navigation/DI wiring changes (app graph, Koin module/wrapper changes):
    • spotlessCheck, detekt, assembleDebug, test, plus testDebugUnitTest if available locally.
  • worker/service/background changes:
    • spotlessCheck, detekt, assembleDebug, test, and targeted tests around WorkManager/service behavior.
  • BLE/networking/core repository changes:
    • spotlessCheck, detekt, assembleDebug, test.

3) Flavor and instrumentation checks

Run these when relevant to map/provider/flavor-specific behavior:

./gradlew lintFdroidDebug lintGoogleDebug
./gradlew testFdroidDebug
./gradlew testGoogleDebug
./gradlew connectedAndroidTest

4) CI parity checks

Current reusable check workflow includes:

  • spotlessCheck detekt
  • testDebugUnitTest testFdroidDebugUnitTest testGoogleDebugUnitTest
  • koverXmlReport app:koverXmlReportFdroidDebug app:koverXmlReportGoogleDebug
  • assembleDebug
  • lintDebug
  • connectedDebugAndroidTest (when emulator tests are enabled)

Reference: .github/workflows/reusable-check.yml

PR workflow note:

  • .github/workflows/pull-request.yml ignores docs-only changes (**.md, docs/**), so doc-only PRs may skip Android CI by design.
  • Android CI on PRs runs with run_instrumented_tests: false; emulator tests are handled in other workflow contexts.

5) Practical guidance for agents

  • Start with the smallest set that validates your touched area.
  • If modifying cross-module contracts (routes, repository interfaces, DI graph), run the broader baseline.
  • If unable to run full validation locally, report exactly what ran and what remains.