operator-sdk icon indicating copy to clipboard operation
operator-sdk copied to clipboard

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

Open jmrodri opened this issue 4 years ago • 4 comments

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

jmrodri avatar Feb 02 '21 20:02 jmrodri

In general there should be clear docs on using scorecard configs outside of a bundle, since the config doesn't necessarily have to be in the bundle itself (nor should it because test deps shouldn't be in bundles).

estroz avatar Feb 08 '21 19:02 estroz

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale. Stale issues rot after an additional 30d of inactivity and eventually close. Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

openshift-bot avatar May 10 '21 01:05 openshift-bot

Stale issues rot after 30d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle rotten. Rotten issues close after an additional 30d of inactivity. Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle rotten /remove-lifecycle stale

openshift-bot avatar Jun 09 '21 05:06 openshift-bot

/lifecycle frozen

estroz avatar Jun 09 '21 15:06 estroz