Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

document --ui_validate_io switch #77

Open
brianwcook opened this issue Mar 20, 2019 · 2 comments
Open

document --ui_validate_io switch #77

brianwcook opened this issue Mar 20, 2019 · 2 comments

Comments

@brianwcook
Copy link

--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
Copy link
Contributor

csomh commented Mar 21, 2019

@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
Copy link
Member

@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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants