operator-framework / operator-courier

Build, verify and push operators
Apache License 2.0
41 stars 53 forks source link

document --ui_validate_io switch #77

Open brianwcook opened 5 years ago

brianwcook commented 5 years ago

--ui_validate_io was asked to be used to verify data for operatorhub.io, but it isn't documented in readme or in the --help output.

csomh commented 5 years ago

@brianwcook, is this an issue with the verify or the push subcommand? Should both have this option?

With the version from master I see this:

$ operator-courier verify -h
usage: operator-courier [-h] [--ui_validate_io]
                        [--validation-output VALIDATION_OUTPUT]
                        source_dir

Build and verify an operator bundle to test

positional arguments:
  source_dir            Path of your directory of yaml files to bundle. Either
                        set this or use the files argument for bundle data.

optional arguments:
  -h, --help            show this help message and exit
  --ui_validate_io      Validate bundle for operatorhub.io UI. To visually
                        confirm that your operator will be displayed
                        correctly, please visit https://operatorhub.io/preview
                        and paste your operator CSV.
  --validation-output VALIDATION_OUTPUT
                        A file to write validation warnings and errors toin
                        JSON format

and

$ operator-courier push -h
usage: operator-courier [-h] [--validation-output VALIDATION_OUTPUT]
                        source_dir namespace repository release token

Build, verify and push an operator bundle into external app registry.

positional arguments:
  source_dir            Path of your directory of yaml files to bundle.
  namespace             Name of the Quay namespace to push operator to.
  repository            Application repository name the application is bundled
                        for.
  release               The release version of the bundle.
  token                 Authorization token for Quay api.

optional arguments:
  -h, --help            show this help message and exit
  --validation-output VALIDATION_OUTPUT
                        A file to write validation warnings and errors toin
                        JSON format
kevinrizza commented 5 years ago

@brianwcook Could you elaborate on this a little bit? What sort of documentation are you looking for? Docs on how to invoke this flag? Or docs on how to use the output? Both?