Developer tag description
View All Tags
New feature unlocked! You can now share your projects to Discord (Slack, and email coming soon).
Webshot Archive now supports integration with Discord via webhooks. What this means is that developers can now send clips of changes to your projects to Discord channel. This will help teams catch changes, bugs, and features earlier in the development cycle.
View the example in the Webshot Archive Discord docs channel.
Github Actions run on a Github Event, however, the default behavior of the Webshot Archive Github Action will differ based on the type of event being run.
When running a workflow on pull_request, the Webshot Archive Github Action will default its compareCommitSha (the commit to compare against) based on ${{ github.event.pull_request.base.sha }}.
For a workflow that runs on push, the compareCommitSha is based on ${{ github.event.before }}. Override this behavior by setting the compareCommitSha in the action input options.
See the API docs for more information of customizing the action input options.
To comment on a pull request with the captured images, the workflow must run on pull_request.
One feature of Webshot Archive is the ability to share your projects with others.
There are two primary ways to share a project:
Understanding diffs are at the core of Webshot Archive. This blog post will explain how diffs work and where they are used.
When the Webshot Archive Github Action runs, your screenshots are uploaded to our hosted storage. The server will then create a diff of the new screenshot and the screenshot the action tells it to compare to. This diff is then uploaded to the Webshot Archive storage along with the original screenshot and added to the Github comment on your PR.
You can also see the diff on the Screenshot Comparison Carousel. In this example the diff is almost 4000 pixels which is a lot but can give some context to what a little value might be. In my opinion 250 pixels is a good starting point. Some pages though may have a lot of noise and a higher value may be needed which can be done on an individual basis (details below).
