cashapp / paparazzi

Render your Android screens without a physical device or emulator
https://cashapp.github.io/paparazzi/
Apache License 2.0
2.23k stars 212 forks source link

FR: Github reporting / Advice on reporting tools #602

Open yschimke opened 1 year ago

yschimke commented 1 year ago

Looking at HtmlReportWriter, it outputs executable data for the Web display of results. I'd like to change it to output structured data such as failing/non-zero diff tests and then have a github action that displays the results.

Curious for guidance of whether I should implement an alternative to HtmlReportWriter, or change it directly. It also seems like a lot of the logic for golden files is specific to HtmlReportWriter, so if I want to keep using that I'll need to duplicate the logic.

My idea was to integrate into Github CI reporting, similar to https://github.com/dorny/test-reporter which updates the workflow results during the execution.

https://github.com/dorny/test-reporter/blob/0d9714ddc7ff86918ec725a527a3a069419d301a/src/main.ts#L181-L192

See an example result here https://github.com/dorny/test-reporter/runs/7983076223

yschimke commented 1 year ago

No urgency for this, just looking at how to simplify our workflow when using paparazzi. We are currently uploading artifacts at the end of runs and downloading them when something goes wrong in CI, especially if it differs from local results.