Skip to content

Latest commit

 

History

History
28 lines (23 loc) · 1.32 KB

approve.md

File metadata and controls

28 lines (23 loc) · 1.32 KB

approve

Approve a test result to become the expected value for subsequent runs

Usage

appraise approve {OPTIONS}

Options

  • --page: The name of the page containing the example to approve
    • For example: hello-world
  • --example: (optional) The name of the example to approve. If not specified, all failed examples on a page will get approved.
    • For example: blue line
  • --examples-dir: (optional) The root directory for the example files
    • For example: specs
    • Defaults to: examples subdirectory of the current working directory
  • --results-dir: (optional) The output directory for results. Note - if it is an existing directory, the old contents will be removed.
    • For example: /tmp/output
    • Defaults to: results subdirectory in the current working directory
  • --templates-dir: (optional) The directory containing page templates for the resulting HTML
    • For example: src/templates
    • Defaults to: embedded templates included with the application
  • --image-subdir: (optional) the name of a subdirectory where to place images when generating results for examples without responses, relative to the corresponding page with examples.
    • For example: images
    • Defaults to: not set -- saving to the same directory as the page with examples