Skip to content

Commit

Permalink
ci: Add Storybook visual testing results to PR comment
Browse files Browse the repository at this point in the history
  • Loading branch information
MoritzWeber0 committed Sep 4, 2024
1 parent edb9813 commit 9bc58d0
Showing 1 changed file with 40 additions and 3 deletions.
43 changes: 40 additions & 3 deletions .github/workflows/storybook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,14 +56,51 @@ jobs:
with:
projectToken: ${{ secrets.CHROMATIC_PROJECT_TOKEN }}
workingDir: ./frontend
- name: Create or update Storybook comment on PR
- name: Create Storybook comment (no changes)
if: github.event_name == 'pull_request'
uses: peter-evans/create-or-update-comment@v4
with:
comment-id: ${{ steps.cc.outputs.comment-id }}
issue-number: ${{ github.event.pull_request.number }}
body: |
A Storybook preview is available for commit ${{ github.sha }}.
[View Storybook](${{ steps.chromatic.outputs.storybookUrl }})
[View Chromatic build](${{ steps.chromatic.outputs.buildUrl }})
➡️ [View Storybook](${{ steps.chromatic.outputs.storybookUrl }})
➡️ [View Chromatic build](${{ steps.chromatic.outputs.buildUrl }})
edit-mode: replace
- name: Create Storybook comment (with changes)
if:
github.event_name == 'pull_request' &&
steps.chromatic.outputs.changeCount == 0
uses: peter-evans/create-or-update-comment@v4
with:
comment-id: ${{ steps.cc.outputs.comment-id }}
issue-number: ${{ github.event.pull_request.number }}
body: |
✅ Captured ${{ steps.chromatic.outputs.actualCaptureCount }} snapshots. No changes detected.
edit-mode: append
- name: Create Storybook comment (with changes)
if:
github.event_name == 'pull_request' &&
steps.chromatic.outputs.changeCount > 0
uses: peter-evans/create-or-update-comment@v4
with:
comment-id: ${{ steps.cc.outputs.comment-id }}
issue-number: ${{ github.event.pull_request.number }}
# prettier-ignore
body: >
🔍 ${{ steps.chromatic.outputs.changeCount }} out of
${{ steps.chromatic.outputs.componentCount }} snapshots have changed.
Please review the changes before merging.
edit-mode: append
- name: Create Storybook comment (failure)
# prettier-ignore
if:
github.event_name == 'pull_request' && steps.chromatic.outcome != 'success'
uses: peter-evans/create-or-update-comment@v4
with:
comment-id: ${{ steps.cc.outputs.comment-id }}
issue-number: ${{ github.event.pull_request.number }}
body: |
The Storybook preview generation failed for commit ${{ github.sha }}.
Check the log output of the GitHub action for more information.
edit-mode: replace

0 comments on commit 9bc58d0

Please sign in to comment.