operator-framework / operator-framework/operator-sdk
Allow to opt-out from Scorecard's olm-status-descriptors-test missing Status warning
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 7.7k
- Forks
- 1.8k
- PR merge metrics
- No merged PRs in 30d
Description
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the implementation of Scorecard's olm-status-descriptors-test and the logic that reports missing .Status definitions. Determine how an opt-out for specific CRDs should be represented, then verify that opted-out CRDs no longer produce warnings while other CRDs remain checked.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- testing-qa
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100