actions-marketplace-validations/action-visual-snapshot
Visual snapshot tester for GitHub Actions
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
- Runtime
- Deprecated runtime
Inputs
| name | description | required | default |
|---|---|---|---|
| threshold | Matching threshold, ranges from 0 to 1. Smaller values make the comparison more sensitive. 0.1 by default. | no | 0.05 |
| antialiasing | Blending factor of unchanged pixels in the diff output. Ranges from 0 for pure white to 1 for original brightness. 0.1 by default. | no | false |
| diffMask | Draw the diff over a transparent background (a mask), rather than over the original image. Will not draw anti-aliased pixels (if detected). | no | — |
| snapshot-path | path where snapshots are saved | no | — |
| merge-base | the merge base sha, will use from github context otherwise. If you use `pull_request_target` you will need to supply the merge base. | no | — |
| api-token | Visual Snapshot API token, should be `VISUAL_SNAPSHOT_SECRET` from GitHub Secrets | yes | — |
| api-endpoint | Custom API endpoint | no | — |
| github-token | github token | no | ${{ github.token }} |
| results-path | path to write snapshot diffs | no | /tmp/visual-snapshot-results |
| save-only | should action only be used to save snapshots | no | false |
| base-workflow-id | id of the workflow that saves your base snapshots (the name of the yaml file including extension) | no | — |
| base-branch | name of the branch to use as base comparison | no | master |
| base-artifact-name | defining this artifact will diff from an artifact from the PR workflow instead of a branch | — | — |
| artifact-name | the artifact name | no | visual-snapshots |
| action-name | The name to be displayed in GitHub Checks | no | Visual Snapshot |
| gcp-service-account-key | Google Cloud service account key (base64) | no | — |
| gcs-bucket | if this is set, upload to google cloud storage | no | — |
| parallelism | number of threads to use when diffing images | no | — |
Outputs
| name | description |
|---|---|
| results-path | path where results are saved |
| base-images-path | path where base images are saved |
| merge-base-images-path | path where merge base images are saved |