expediagroup/comparadise
A Github Action for using Comparadise with visual regression tests
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| workflow | The workflow to run. Supported values: "pr" (default), "merge", "manifest-generate", "manifest-compare", "manifest-merge". | no | pr |
| visual-test-command | The command that runs your visual tests. Can be multiple lines! Required when workflow is pr. | no | — |
| bucket-name | The S3 bucket name | yes | — |
| commit-hash | The commit hash. Required for pr/merge/manifest-compare workflows. | no | — |
| diff-id | Alternative to commit-hash as a unique identifier for visual tests. GitHub integration will be disabled if diff-id is used. | no | — |
| use-base-images | Optionally disables base images from being used | no | true |
| screenshots-directory | The directory where your visual tests expect screenshots to be | no | screenshots |
| package-paths | Comma separated list of package paths for monorepos. For the manifest-generate workflow, pass the package(s) that matrix job covers (a "chunk"); the paths are sorted and MD5-hashed into a chunk-id used as the per-chunk manifest filename (manifests/{commit-sha}/{chunk-id}.json), so parallel jobs never overwrite one another. Manifest keys are the screenshot paths as they exist on disk (already package-prefixed by the monorepo's directory layout); no prefix is added. | no | — |
| comparadise-host | The URL at which you are hosting Comparadise | no | — |
| comment-details | Additional details you would like to leave on the Comparadise comment | no | — |
| github-token | The GitHub access token | no | ${{ github.token }} |
| resize-width | Optional maximum width to resize images before upload | no | — |
| resize-height | Optional maximum height to resize images before upload | no | — |
| visual-test-command-fails-on-diff | Whether the visual-test-command fails if visual diffs are detected | no | true |
| update-base-images-on-accept | Whether accepting visual changes in the web app should update base images in S3. | no | true |
Outputs
no outputs