render-evidence

Solid

Capture the before/after rendered PNGs a UI-affecting PR in this repository needs as visual evidence, including bringing an Android SDK up in a fresh sandbox. Use when a change touches a Compose @Preview, a catalog, the VS Code webview, an overlay, a theme, an icon or a fixture, and the PR body needs real pixels.

Code & Development 111 stars 5 forks Updated today Apache-2.0

Install

View on GitHub

Quality Score: 83/100

Stars 20%
68
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Capturing visual evidence Root [`AGENTS.md`](../../../AGENTS.md#pr-workflow) says a UI-affecting PR must carry before/after evidence as **embedded, viewable images** — describing an image, or deferring to the diff bot's auto-comment, does not count. This is how to produce them here. ## Check what already exists first Rendering is not free. Before capturing anything: - Read the sticky `<!-- preview-diff -->` comment on the PR — CI may already have rendered and diffed exactly the surface you changed. - Reuse renders published on the `compose-preview/pr` and `compose-preview/main` branches where they cover the change. - Scan [`.github/workflows`](../../../.github/workflows) for the preview-diff CI this repo already runs, and cite it. The bot's comment is a convenience, not a substitute: your PR body still needs *your* change's before/after embedded in it. ## Rendering Whole sample modules: ``` ./gradlew :samples:android:composePreviewRenderAll ./gradlew :samples:cmp:composePreviewRenderAll ``` One preview, which is what a before/after pair usually wants: ``` ./gradlew :samples:android:composePreviewRender --rerun \ -PcomposePreview.filter=<PreviewFunctionName> ``` `--rerun` matters. A failed render leaves `.error.json` sidecars that count as task outputs, so `composePreviewRender` goes `UP-TO-DATE` and re-reports the stale failure. PNGs land under `<module>/build/compose-previews/renders/`. The samples consume the plugin through `includeBuild("gradle-plugin...

Details

Author
yschimke
Repository
yschimke/compose-ai-tools
Created
5 months ago
Last Updated
today
Language
Kotlin
License
Apache-2.0

Similar Skills

Semantically similar based on skill content — not just same category