sudansh/Compose Golden Snapshots

Run Jetpack Compose Preview screenshot tests on PRs, auto-open a reference-image update PR, and post a status comment.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
working-directoryDirectory to run Gradle from (where ./gradlew lives).noandroid
gradle-taskGradle task that validates Compose screenshot tests.novalidateDebugScreenshotTest
gradle-flagsExtra flags appended to the Gradle invocation.no--no-configuration-cache
reference-substringPath substring used to identify reference image files (relative to repo root).no/src/screenshotTestDebug/reference/
rendered-globGlob (under working-directory) for rendered screenshot outputs produced when the Gradle task fails.no**/build/outputs/screenshotTest-results/preview/debug/rendered
java-versionJDK version for actions/setup-java.no21
java-distributionJDK distribution for actions/setup-java.notemurin
ref-branch-prefixPrefix for the auto-created reference-image branch. PR number is appended.noscreenshot-refs/pr-
commit-messageCommit message used when pushing reference image updates.nochore: update Compose screenshot reference images
pr-titleTitle for the auto-opened reference PR. {pr} is replaced with the parent PR number.nochore: screenshot reference images for PR #{pr}
artifact-nameName of the uploaded diff report artifact.noscreenshot-diff-report
artifact-pathPath glob for diff report artifact contents.no**/build/reports/screenshotTest/
comment-headerHeader used to identify and replace prior bot comments. Must start with "## ".no## Compose screenshot tests
tokenGitHub token used to push, comment, and open PRs.no${{ github.token }}
fail-on-diffIf true, the action fails when reference images needed updating or validation failed.notrue
setup-javaIf true, the action installs JDK via actions/setup-java. Set to false if your workflow already sets up Java.notrue
setup-gradleIf true, the action runs gradle/actions/setup-gradle. Set to false to skip.notrue
namedescription
has_changestrue if reference images differ from base ref.
validate_failedtrue if the Gradle validate task failed (references were regenerated from renders).
pushedtrue if the reference branch was pushed.
nothing_to_committrue if there was nothing to stage after refresh.
ref_branchName of the reference branch (if pushed).
ref_pr_numberNumber of the auto-opened reference PR (if created).
ref_pr_urlURL of the auto-opened reference PR (if created).
summaryHuman-readable summary of detected changes.