Skip to content

Allow to opt-out from Scorecard's olm-status-descriptors-test missing Status warning #6564

Description

@clobrano

Feature Request

Describe the problem you need a feature to resolve.

This feature request revolves around Scorecard's olm-status-descriptors-test, which generates warnings for Custom Resource Definitions lacking a .Status definition. This warning is intended to encourage authors to include a .Status section, even though it's not strictly mandatory 1.

However, a significant problem arises when pipelines relying on this test continue to produce warnings for CRDs that legitimately do not need a .Status section, requiring to inspect any report to verify if the warning is a new entry or the known one.

Describe the solution you'd like.

It would be beneficial to introduce an option for opting out of these warnings for specific CRDs.

Pros:

  • Without any intentional intervention, the test will continue to promote best practices and adherence to conventions.
  • In projects with multiple CRDs, the test can still be applied comprehensively to those that require and possess a .Status section.

Cons:

  • The only potential downside is that once this decision is made, authors must remember to remove the opt-out code/flag if the CRD's requirements change.

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