Skip to content

Conversation

@mogottsch
Copy link
Contributor

@mogottsch mogottsch commented Jan 16, 2023

What does this PR do?

This PR adds a new rule to the cluster-app rule set, which checks whether all properties have a title. The requirement for this rule is defined in this RFC.

In addition:

  • Improves the output format of the verify command
  • Refactors the file/package structure

What is the effect of this change to users?

schemalint verify PATH --rule-set cluster-app

The command will check if every property has a description. If not the property will be printed out.
The verification will not fail, as this rule is not a requirement (MUST), but only a recommendation (SHOULD).

How does it look like?

image

Any background context you can provide?

What is needed from the reviewers?

You can test these changes, with the following command.

go run ./main.go verify ./pkg/lint/rulesmeta/rules/testdata/8_missing_titles_and_descriptions.json --rule-set cluster-app`

Do the docs/README need to be updated?

No.

Should this change be mentioned in the release notes?

  • CHANGELOG.md has been updated

@mogottsch mogottsch requested a review from a team January 16, 2023 10:24
Copy link
Member

@marians marians left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving on the basis of the screenshot. Looks good!

@mogottsch mogottsch merged commit 9ed9c5a into main Jan 16, 2023
@mogottsch mogottsch deleted the implement-cluster-app-schema-r5 branch January 16, 2023 14:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants