Skip to content

Commit 30ae1b9

Browse files
authored
Update description of instrumentation tests (#1)
1 parent 27243d2 commit 30ae1b9

2 files changed

Lines changed: 8 additions & 10 deletions

File tree

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ jobs:
4444
uses: ./.github/workflows/_build-examples.yml
4545

4646
instrumented-test:
47-
name: Instrumentation Tests (PR only)
47+
name: Instrumentation Tests
4848
if: github.event_name == 'pull_request'
4949
uses: ./.github/workflows/_instrumentation.yml
5050

docs/GITHUB_WORKFLOWS.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Located in `.github/workflows/`:
7171
- **Runs**: Tests on both phone (Nexus 6) and automotive (automotive_1024p_landscape) profiles
7272
- **Artifacts**: Uploads test results and reports for both device types
7373
- **Usage**: Called by daily.yml and ci.yml (PR only)
74-
- **Duration**: ~10-15 minutes (may vary due to emulator startup and potential flakiness)
74+
- **Duration**: ~10-15 minutes (may vary due to emulator startup)
7575

7676
#### `_docs.yml`
7777
- **Purpose**: Build API documentation with Dokka
@@ -123,11 +123,11 @@ instrumented-test (Phone + Automotive)
123123
5. **coverage** - Checks test coverage meets 20% minimum (depends on format + copyright)
124124
6. **build-library** - Builds library AAR (depends on format + copyright + test + docs + coverage, runs in parallel with build-examples)
125125
7. **build-examples** - Builds example APKs (depends on format + copyright + test + docs + coverage, runs in parallel with build-library)
126-
8. **instrumented-test** - Runs instrumentation tests on phone and automotive emulators (PR only, runs independently)
126+
8. **instrumented-test** - Runs instrumentation tests on phone and automotive emulators (PR only, required status check)
127127

128128
**Total Duration**:
129129
- **Maintainer pushes to main**: ~3-4 minutes (no instrumentation tests)
130-
- **External PRs**: ~10-15 minutes (includes instrumentation tests on phone + automotive)
130+
- **Pull Requests**: ~10-15 minutes (includes instrumentation tests on phone + automotive)
131131

132132
**Benefits**:
133133
- Catches formatting issues early (before expensive builds)
@@ -206,14 +206,13 @@ Phone Tests Automotive Tests
206206
**Jobs**:
207207
1. **instrumented-test** - Calls the reusable `_instrumentation.yml` workflow
208208

209-
**Total Duration**: ~10-15 minutes (may vary due to emulator startup and flakiness)
209+
**Total Duration**: ~10-15 minutes (may vary due to emulator startup)
210210

211211
**Benefits**:
212212
- Catches device-specific regressions early
213213
- Tests on both phone and automotive form factors
214-
- Runs independently from main CI pipeline
215214
- Manual trigger available for on-demand testing
216-
- Acceptable flakiness since it doesn't block development workflow
215+
- Runs daily for continuous quality monitoring
217216

218217
#### `docs-deploy.yml` - API Documentation Deployment
219218
**Trigger**: Push to `main` or `master` branch (paths: `openmapview/src/**/*.kt`, `README.md`, `.github/workflows/_docs.yml`, `.github/workflows/docs-deploy.yml`)
@@ -418,7 +417,7 @@ All core checks pass (3-4 min)
418417
419418
Meanwhile (in parallel, PR only):
420419
instrumented-test: Phone + Automotive tests
421-
(10-15 min) - PASS (may be flaky)
420+
(10-15 min) - PASS
422421
|
423422
v
424423
All checks complete -> PR is ready to merge
@@ -485,9 +484,8 @@ This single workflow definition powers both daily scheduled tests and PR validat
485484
486485
### 5. Flexible Testing Strategy
487486
- **Maintainer commits to main**: Fast feedback (~3-4 min) without instrumentation delays
488-
- **External PRs**: Comprehensive testing (~10-15 min) including phone and automotive instrumentation tests
487+
- **Pull Requests**: Comprehensive testing (~10-15 min) including phone and automotive instrumentation tests required for merge
489488
- **Daily scheduled runs**: Proactive regression detection on both platforms
490-
- **Test flakiness handled gracefully**: Instrumentation tests run independently and don't block merges
491489
492490
### 6. Clear Separation of Concerns
493491
- Format checks catch simple issues fast

0 commit comments

Comments
 (0)