puppeteer_tests: Update the instruction to view generated screenshots.

On puppeteer test failure, screenshots are generated which are
helpful in debugging.

Earlier, the instruction to see those screenshot in github actions
was not the easy way. It linked to a github doc which suggests to
make API calls using artifact ID (which can be confusing to find)
to download the artifact and extract it to see the screenshots.

The easier way is to download the artifact directly using the
download URL present in the "Store puppeteer artifacts" step of
the job.

This commit updates the instruction for the reason mentioned above.
This commit is contained in:
Prakhar Pratyush 2024-06-14 17:16:24 +05:30 committed by Tim Abbott
parent 9caf8b8b2b
commit f5a1869c5b
1 changed files with 4 additions and 3 deletions

View File

@ -143,9 +143,10 @@ or report and ask for help in chat.zulip.org""",
print("", file=sys.stderr)
print(
"""
See https://docs.github.com/en/rest/reference/actions#artifacts for information
on how to view the generated screenshots, which are uploaded as Artifacts.
Screenshots are extremely helpful for understanding puppeteer test failures.
Screenshots generated on failure are extremely helpful for understanding
puppeteer test failures, which are uploaded as artifacts. Use the
artifact download URL available in the "Store Puppeteer artifacts" step
below to download and view the generated screenshots.
""",
file=sys.stderr,
)