ghost-inspector / node-ghost-inspector

Ghost Inspector CLl & API Library for Node.js
https://ghostinspector.com/docs/api/
MIT License
28 stars 6 forks source link

On demand error options #37

Closed aaronfay closed 3 years ago

aaronfay commented 3 years ago

Adds missing explicit options for errorOnFail and errorOnScreenshotFail for execute on demand. These options still work without these definitions, this change just explicitly lists them in the command help:

ghost-inspector test execute-on-demand <organizationId> <file> [options]

Execute an on-demand test against your organization providing the path to your local JSON <file>.

Options:
  --version                Show version number                                                                 [boolean]
  --apiKey                 Your Ghost Inspector API key. You may also pass GHOST_INSPECTOR_API_KEY through your
                           environment.
  --json                   Provide output in JSON format.
  --jsonInput              Provide options input in JSON format
  --help                   Show help                                                                           [boolean]
  --errorOnFail            Exit the command with a non-0 status if the test passing value is not `true`. Ignored when
                           used with --immediate.                                                       [default: false]
  --errorOnScreenshotFail  Exit the command with a non-0 status if the test screenshotComparePassing value is not
                           `true`. Ignored when used with --immediate.                                  [default: false]
  --immediate              Initiate the execution, then immediate return a response when provided
                                                                                              [boolean] [default: false]
aaronfay commented 3 years ago

@justinklemm I'll need you to merge this down again if you're šŸ†— with the change. šŸ™šŸ»