Skip to content

Commit

Permalink
Changed the screenshots Github workflow to run in the PR's branch by …
Browse files Browse the repository at this point in the history
…using pull_request as event trigger.

The original event trigger pull_request_target runs against the target branch (main), not the branch associated with the PR. Consequently, any new screenshots added in a PR are not captured, and the available screenshots reflect the state of the main branch code, not the code from the PR's branch.

This update addresses the issue by changing the event trigger to pull_request. However, it's important to note that this adjustment breaks the comments functionality since the action no longer has write permissions.
  • Loading branch information
knyghty authored Dec 12, 2023
1 parent a93375e commit ed65610
Showing 1 changed file with 1 addition and 33 deletions.
34 changes: 1 addition & 33 deletions .github/workflows/screenshots.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: Visual Regression Tests

on:
pull_request_target:
pull_request:
types: [labeled, synchronize, opened, reopened]
paths-ignore:
- 'docs/**'
Expand Down Expand Up @@ -45,35 +45,3 @@ jobs:
with:
name: screenshots-${{ github.event.pull_request.head.sha }}
path: tests/screenshots/

- name: Find comment to update
uses: peter-evans/find-comment@v2
id: find-comment
with:
issue-number: ${{ github.event.pull_request.number }}
comment-author: 'github-actions[bot]'
body-includes: You can download the generated screenshots from the workflow artifacts.

- name: Create comment
if: steps.find-comment.outputs.comment-id == ''
uses: peter-evans/create-or-update-comment@v3
with:
token: ${{ secrets.GITHUB_TOKEN }}
issue-number: ${{ github.event.pull_request.number }}
body: |
🖼️ **Screenshots created**
You can download the generated screenshots from the workflow artifacts.
_Please note that artifacts are only available for download for ${{ github.retention_days }} days._
- Generated screenshots for ${{ github.event.pull_request.head.sha }} at ${{ steps.generate-screenshots.outputs.date }} ([download](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }})).
- name: Update comment
if: steps.find-comment.outputs.comment-id != ''
uses: peter-evans/create-or-update-comment@v3
with:
token: ${{ secrets.GITHUB_TOKEN }}
comment-id: ${{ steps.find-comment.outputs.comment-id }}
body: |
- Generated screenshots for ${{ github.event.pull_request.head.sha }} at ${{ steps.generate-screenshots.outputs.date }} ([download](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }})).

0 comments on commit ed65610

Please sign in to comment.