docs: document Roborazzi screenshot tests in README - #11
Merged
Conversation
added 2 commits
July 25, 2026 23:43
The Testing section predated the screenshot suite: it omitted the 7 Roborazzi test classes and 20 goldens entirely, undercounted unit test files (21 -> 28), and the CI summary did not mention that the fast lane runs verifyRoborazziDebug.
The build-and-test job already runs verifyRoborazziDebug, but its name only listed build, unit tests, detekt, and lint, so screenshot coverage was invisible in the PR checks list. Renaming changes the status check context, so the main branch protection rule is updated to match.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Brings the README's Testing section in line with the screenshot suite added in #6–#9.
app/src/test/screenshots/, pinned to Pixel 5 / SDK 34 with fixed locale and timezone, including French-locale and large-font variants. Documents therecordRoborazziDebug/verifyRoborazziDebugcommands and links the strategy doc.ci.ymlhas been running viaverifyRoborazziDebugsince test(screenshot): Roborazzi screenshot testing — Phase 1 (Status) #6.Not included
The
build-and-testjob is still named "Build, unit tests, detekt, lint", so screenshot verification is invisible in the PR checks list. Renaming it would break the required status check now that branch protection is on — worth doing, but paired with a protection-rule update rather than here.Docs only; no code or CI changes.