Skip “Percy screenshots” when secrets are unavailable on forks (fix) #3075
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
colinrotherham
added
🐛 bug
colinrotherham
force-pushed
the
percy-pr-filter
branch
from
767e5cd
to
93eca04
Compare
colinrotherham
force-pushed
the
percy-pr-filter
branch
2 times, most recently
from
a92fae6
to
a6a3cd4
Compare
govuk-design-system-ci
temporarily deployed
to
govuk-frontend-pr-3075
domoscargin
reviewed
Dec 15, 2022
colinrotherham
force-pushed
the
percy-pr-filter
branch
7 times, most recently
from
339def3
to
2f1c6f8
Compare
colinrotherham
force-pushed
the
percy-pr-filter
branch
from
2f1c6f8
to
8986fb2
Compare
colinrotherham
commented
Dec 21, 2022
| @@ -18,7 +18,14 @@ jobs: | |||
| PERCY_TOKEN: ${{ secrets.PERCY_TOKEN }} | |||
| PORT: 8888 | |||
|
|
|||
| # Skip when secrets are unavailable on forks | |||
| if: ${{ !github.event.pull_request.head.repo.fork }} | |||
There was a problem hiding this comment.
For our typical "PRs from forks" scenario this line skips the Percy screenshots
colinrotherham
commented
Dec 21, 2022
| steps: | ||
| - name: Check secrets | ||
| if: ${{ !env.PERCY_TOKEN }} | ||
| run: echo "::warning title=GitHub Actions secrets::Workflow requires 'PERCY_TOKEN' secret" |
There was a problem hiding this comment.
But for more advanced contributors that might run the GitHub Actions workflows manually (on their fork) we add a warning message alongside the error output to explain why the Percy run failed:
|
Ready for review again @domoscargin |
domoscargin
approved these changes
Dec 21, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Looks like our "local branches only" check for Percy screenshots didn't work
I'd forgotten that workflows for fork PRs identify our repo making this check always pass: 🙈
❌ Use the
github.repository_ownercontext✅ Use the
github.eventcontext to identify forksFor example, this PR (fork) has passed the incorrect check and tried to run Percy
But others (my fork) use the new check and Percy has been skipped:
main) to confirm Percy is skipped #3129Unlike the old fix, Percy is not skipped when run directly from the fork:
This allows contributors to add their own
${{ secrets.PERCY_TOKEN }}but with a warning if not provided: