mirror of
https://github.com/meshtastic/Meshtastic-Android.git
synced 2026-04-20 22:23:37 +00:00
2.4 KiB
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.mdand.github/copilot-instructions.md. - CI additionally runs
testDebugUnitTestin.github/workflows/reusable-check.yml.
2) Change-type matrix
docs-onlychanges:- Usually no Gradle run required.
- If you touched code examples or command docs, at least run
spotlessCheckif practical.
UI text/resourcechanges:spotlessCheck,detekt,assembleDebug.
feature/commonMain logicchanges:spotlessCheck,detekt,test,assembleDebug.
navigation/DI wiringchanges (app graph, Koin module/wrapper changes):spotlessCheck,detekt,assembleDebug,test, plustestDebugUnitTestif available locally.
worker/service/backgroundchanges:spotlessCheck,detekt,assembleDebug,test, and targeted tests around WorkManager/service behavior.
BLE/networking/core repositorychanges: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 detekttestDebugUnitTest testFdroidDebugUnitTest testGoogleDebugUnitTestkoverXmlReport app:koverXmlReportFdroidDebug app:koverXmlReportGoogleDebugassembleDebuglintDebugconnectedDebugAndroidTest(when emulator tests are enabled)
Reference: .github/workflows/reusable-check.yml
PR workflow note:
.github/workflows/pull-request.ymlignores 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.