Skip to content

Update scorecard docs to be more clear how to use the configuration file. #4464

Description

@jmrodri

What is the URL of the document?

https://sdk.operatorframework.io/docs/advanced-topics/scorecard/scorecard/#configuration

Which section(s) is the issue in?

Configuration

What needs fixing?

A better description of when and how to use the configuration. There are no examples of passing in a configuration on the command line to override the existing config in a bundle. It isn't clear how to add my own tests to this configuration file either.

Additional context

One scenario we'd like is to be able to define tests in a config file and use that file for multiple bundles.

for b in bundles:
    operator-sdk scorecard b --config mytests.yaml

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    help wantedDenotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.kind/documentationCategorizes issue or PR as related to documentation.lifecycle/frozenIndicates that an issue or PR should not be auto-closed due to staleness.scorecardIssue relates to the scorecard subcomponent

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions