comparadise/action.yml at main · ExpediaGroup/comparadise · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
name: 'comparadise'
description: 'A Github Action for using Comparadise with visual regression tests'
author: 'Dan Adajian'
inputs:
  workflow:
    description: 'The workflow to run. "pr" (default) runs visual tests and sets commit status. "merge" updates base images in S3.'
    required: false
    default: 'pr'
  visual-test-command:
    description: 'The command that runs your visual tests. Can be multiple lines! Required when workflow is pr.'
    required: false
  bucket-name:
    description: 'The S3 bucket name'
    required: true
  commit-hash:
    description: 'The commit hash'
    required: false
  diff-id:
    description: 'Alternative to commit-hash as a unique identifier for visual tests. GitHub integration will be disabled if diff-id is used.'
    required: false
  use-base-images:
    description: 'Optionally disables base images from being used'
    required: false
    default: 'true'
  screenshots-directory:
    description: 'The directory where your visual tests expect screenshots to be'
    required: false
    default: screenshots
  package-paths:
    description: 'Comma separated list of package paths for monorepos'
    required: false
  comparadise-host:
    description: 'The URL at which you are hosting Comparadise'
    required: false
  comment-details:
    description: 'Additional details you would like to leave on the Comparadise comment'
    required: false
  github-token:
    description: 'The GitHub access token'
    required: false
    default: ${{ github.token }}
  resize-width:
    description: 'Optional maximum width to resize images before upload'
    required: false
  resize-height:
    description: 'Optional maximum height to resize images before upload'
    required: false
  visual-test-command-fails-on-diff:
    description: 'Whether the visual-test-command fails if visual diffs are detected'
    required: false
    default: 'true'
  update-base-images-on-accept:
    description: 'Whether accepting visual changes in the web app should update base images in S3.'
    required: false
    default: 'true'
runs:
  using: 'node24'
  main: 'action/dist/main.js'
  post: 'action/dist/post.js'
branding:
  icon: layout
  color: green