Skip to content

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

Open

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

  1. added
    scorecardIssue relates to the scorecard subcomponent
    on Feb 5, 2021
  2. estroz commented on Feb 8, 2021

    @estroz
    Contributor

    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).

  3. added this to the Backlog milestone on Feb 8, 2021
  4. added
    help wantedDenotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.
    on Feb 8, 2021
  5. openshift-bot commented on May 10, 2021

    @openshift-bot

    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

  6. added
    lifecycle/staleDenotes an issue or PR has remained open with no activity and has become stale.
    on May 10, 2021
  7. openshift-bot commented on Jun 9, 2021

    @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

  8. added
    lifecycle/rottenDenotes an issue or PR that has aged beyond stale and will be auto-closed.
    and removed
    lifecycle/staleDenotes an issue or PR has remained open with no activity and has become stale.
    on Jun 9, 2021
  9. estroz commented on Jun 9, 2021

    @estroz
    Contributor

    /lifecycle frozen

  10. added
    lifecycle/frozenIndicates that an issue or PR should not be auto-closed due to staleness.
    and removed
    lifecycle/rottenDenotes an issue or PR that has aged beyond stale and will be auto-closed.
    on Jun 9, 2021
  11. added 2 commits that reference this issue on Aug 20, 2026
    8ad0fce
    9375a08
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