Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve README.md Noticeability #1405

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+10 −8
Open

Improve README.md Noticeability #1405

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
758daf9
Highlight Note.
Jaehwa-Noh Apr 27, 2024
1db2dc4
Highlight Note.
Jaehwa-Noh Apr 27, 2024
7f2d17c
Change style.
Jaehwa-Noh May 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 10 additions & 8 deletions README.md
View file
Open in desktop
Expand Up @@ -114,9 +114,10 @@ To run the tests execute the following gradle tasks:
- `testDemoDebug` run all local tests against the `demoDebug` variant.
- `connectedDemoDebugAndroidTest` run all instrumented tests against the `demoDebug` variant.

**Note:** You should not run `./gradlew test` or `./gradlew connectedAndroidTest` as this will execute
tests against _all_ build variants which is both unecessary and will result in failures as only the
`demoDebug` variant is supported. No other variants have any tests (although this might change in future).
> [!NOTE]
> You should not run `./gradlew test` or `./gradlew connectedAndroidTest` as this will execute
> tests against _all_ build variants which is both unecessary and will result in failures as only the
> `demoDebug` variant is supported. No other variants have any tests (although this might change in future).

## Screenshot tests
A screenshot test takes a screenshot of a screen or a UI component within the app, and compares it
Expand All @@ -137,11 +138,12 @@ stored in `modulename/src/test/screenshots`.
- `compareRoborazziDemoDebug` create comparison images between failed tests and the known correct
images. These can also be found in `modulename/src/test/screenshots`.

**Note:** The known correct screenshots stored in this repository are recorded on CI using Linux. Other
platforms may (and probably will) generate slightly different images, making the screenshot tests fail.
When working on a non-Linux platform, a workaround to this is to run `recordRoborazziDemoDebug` on the
`main` branch before starting work. After making changes, `verifyRoborazziDemoDebug` will identify only
legitimate changes.
> [!NOTE]
> The known correct screenshots stored in this repository are recorded on CI using Linux. Other
> platforms may (and probably will) generate slightly different images, making the screenshot tests fail.
> When working on a non-Linux platform, a workaround to this is to run `recordRoborazziDemoDebug` on the
> `main` branch before starting work. After making changes, `verifyRoborazziDemoDebug` will identify only
> legitimate changes.

For more information about screenshot testing
[check out this talk](https://www.droidcon.com/2023/11/15/easy-screenshot-testing-with-compose/).
Expand Down