operator-framework / enhancements

Apache License 2.0
9 stars 40 forks source link

Standard definition for the Validators (linters) #105

Closed camilamacedo86 closed 2 years ago

camilamacedo86 commented 2 years ago

Description

The Validators are static checks (linters) that can scan the manifests and provide with low-cost valuable results to ensure the quality of the distributions which will be distributed via OLM, as to ensure that they are respecting some specific criteria for vendors and/or catalogs.

This proposal aims to provide a standard definition to reduce the complexities of keeping these rules maintained and consumed.

The goal of this proposal is to ensure that we can along with a defined standard concept and vision which can help us in the medium/long term have solutions with better maintainability, usability and understandability levering in what we have implemented currently.

camilamacedo86 commented 2 years ago

Hi @fgiloux,

About : https://github.com/operator-framework/enhancements/pull/105#pullrequestreview-822578799

As we spoke:

That is implemented already. See that we are moving some checks from operator-framowork/API. The standard/idea can be applied outside but that is more for us. The main goal is to clarify why we are moving them out, what is the idea/suggestion to work with the validators ( examples section ) and why/how.

camilamacedo86 commented 2 years ago

Closing since it seems that the info here did not fit well in the EP. But we tried to address the usage in : https://github.com/operator-framework/api/pull/205