github-action icon indicating copy to clipboard operation
github-action copied to clipboard

Readme `Input` section does not have `format` option

Open mirzaprangon opened this issue 1 year ago • 1 comments

As the title. The Inputs section of readme does not have the format option listed.

I was curious if values are possible for format other than sarif, idk like sbom etc.

mirzaprangon avatar Mar 18 '24 23:03 mirzaprangon

Late to the party and not being dismissive of the feedback, but for anyone else looking the easiest way to see it without installing kubescape and running kubescape scan -h is to look in the action.yml specification for the inputs.

  format:
    description: |
      Output format.

      Can take one or more formats. To use one format, omit the comma, e.g
      `format: json`. To produce results in multiple formats, separate them with
      a comma: `format: sarif,json`.

      For example, when using `output: "results"` and `format: "sarif,json"`,
      Kubescape will produce 2 files: `results.sarif` and `results.json`. You
      can then use `results.sarif` to publish results to Github Code Scanning
      and `results.json` to suggest automatic fixes.

      Run `kubescape scan -h` to see a list of supported formats.
    required: false
    default: junit

anerdwithaknife avatar Feb 26 '25 14:02 anerdwithaknife