Skip to content

ci: improve README screenshot failure report - #125

Merged
vitormattos merged 1 commit into
mainfrom
feat/improve-screenshot-report
Sep 22, 2026
Merged

vitormattos merged 1 commit into
mainfrom
feat/improve-screenshot-report

Conversation

@vitormattos

Copy link
Copy Markdown
Member

This improves the README screenshot failure feedback in pull requests.

Changes:

  • include structured comparison metadata in the screenshot artifact;
  • show difference percentage, allowed tolerance and changed pixel count at the top of the comment;
  • keep the visual diff expanded and move expected/generated screenshots into collapsible sections;
  • link directly to the failed workflow run;
  • update one persistent PR comment instead of creating a new comment on every failure;
  • publish the same report to the GitHub Actions job summary.

The report still uses the existing trusted workflow_run flow and does not execute pull request code with elevated permissions.

@vitormattos
vitormattos requested a review from a team as a code owner September 22, 2026 00:03
github-actions Bot added a commit that referenced this pull request Sep 22, 2026
github-actions Bot added a commit that referenced this pull request Sep 22, 2026
@github-actions

Copy link
Copy Markdown

README screenshot check failed

The generated README screenshot differs from the committed version.

Expected

Expected screenshot

Generated

Generated screenshot

Diff

Visual diff

If the visual change is expected, run npm run screenshots:update and commit the updated screenshot.

github-actions Bot added a commit that referenced this pull request Sep 22, 2026
Signed-off-by: Vitor Mattos <vitor@php.rio>
@vitormattos
vitormattos force-pushed the feat/improve-screenshot-report branch from 97293cd to 4c53eb2 Compare September 22, 2026 00:54
@vitormattos
vitormattos merged commit fbdf257 into main Sep 22, 2026
6 checks passed
@vitormattos
vitormattos deleted the feat/improve-screenshot-report branch September 22, 2026 00:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant