github-action/action.yml at master · ShiplightAI/github-action · 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
63
64
65
66
67
68
69
70
71
72
73
74
name: shiplight-runner
description:
  Run Shiplight end-to-end tests in CI. AI-driven browser tests that self-heal,
  with results commented on every pull request.
author: Shiplight AI

branding:
  icon: 'cloud-lightning'
  color: 'blue'

inputs:
  api-token:
    description: api token for shiplight
    required: true
  test-suite-id:
    description:
      test suite ID (single ID or comma-separated list, e.g., "1" or "1,2,3")
    required: true
  preflight-test-case-id:
    description:
      optional preflight test case ID. If set, the preflight test runs before
      main test suites
    required: false
  environment-id:
    description: environment id
    required: true
  environment-url:
    description: environment url
    required: false
  github-comment:
    description:
      If enabled, the action will comment on the pull request with the test run
      results
    default: 'true'
  github-token:
    description: This token used for leaving a comment on the pull request
    default: ${{ github.token }}
  async:
    description: |
      If enabled, will launch the tests but not wait for them to finish and the action will always output success.
      Note: GitHub comments will not function if this is set.
    default: 'false'
  commit-sha:
    description: 'The commit SHA to find the pull request for comment'
    required: false
  timeout-seconds:
    description: 'Maximum time to wait for test runs to complete (in seconds)'
    required: false
    default: '86400'
  test-context:
    description: |
      Test context key-value pairs to pass to the test run, one per line in KEY=VALUE format.
      Example:
        env=staging
        feature-flag=enabled
    required: false

outputs:
  success:
    description: Whether all test runs were successful
  results:
    description: JSON string containing results for each test suite
  run-id:
    description: Shiplight run ID
  run-url:
    description: Shiplight run result URL
  preflight-result:
    description: Preflight result (Passed|Failed|Skipped|Pending)
  metadata:
    description: Trigger metadata JSON string

runs:
  using: node20
  main: dist/index.js