Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
clobrano opened this issue Sep 11, 2023 · 5 comments
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. scorecard Issue relates to the scorecard subcomponent
Milestone

Comments

@clobrano
Copy link

clobrano commented Sep 11, 2023

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.
@oceanc80
Copy link
Collaborator

Per a suggestion from @joelanford, we could explore some sort of silencing mechanism similar to golangci-lint's nolint directive: https://golangci-lint.run/usage/false-positives/#nolint-directive

@varshaprasad96
Copy link
Member

This seems a reasonable request. We would like to mark this as triage-accepted.

@varshaprasad96 varshaprasad96 added scorecard Issue relates to the scorecard subcomponent help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. labels Sep 11, 2023
@varshaprasad96 varshaprasad96 added this to the Backlog milestone Sep 11, 2023
@openshift-bot
Copy link

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-ci openshift-ci bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Dec 11, 2023
@clobrano
Copy link
Author

Please don't close it 😄

@varshaprasad96
Copy link
Member

/lifecycle frozen

@clobrano This issue was added to the backlog, since we don't have enough contributors in the project to help us with implementing the feature. Adding lifecycle/frozen label so that it doesn't get closed and can be picked up by the community.

@openshift-ci openshift-ci bot added lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Dec 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. scorecard Issue relates to the scorecard subcomponent
Projects
None yet
Development

No branches or pull requests

4 participants