operator-sdk
operator-sdk copied to clipboard
operator-framework
Allow to opt-out from Scorecard's olm-status-descriptors-test missing Status warning
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
.Statussection.
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.
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
This seems a reasonable request. We would like to mark this as triage-accepted.
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
/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.