Linting for K8s YAML files

[Rishit-dagli]

What this PR does / why we need it:

This PR verifies the format of YAML files in this repo using yamllint as discussed in #1734 (comment) and #1859

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #1859

Checklist:

• Docs included if any changes are user facing

[johnugeorge]

Thanks @Rishit-dagli for the PR

Charmed-Katib is not maintained by community. You can create a new one.

[Rishit-dagli]

Thanks @Rishit-dagli for the PR

Charmed-Katib is not maintained by community. You can create a new one.

Ah, thanks for the info. I'll create a new workflow.

[tenzen-y]

@Rishit-dagli Thanks for creating this PR!

@johnugeorge
Should we add scripts to run on the local machines in another PR?

[johnugeorge]

we can do the same as https://github.com/kubeflow/katib/blob/master/.github/workflows/test-shell-script.yaml#L17 using make

Also, should we treat warnings as errors using strict flag?

[tenzen-y]

we can do the same as https://github.com/kubeflow/katib/blob/master/.github/workflows/test-shell-script.yaml#L17 using make

SGTM @johnugeorge
Can you update this PR like shellcheck? @Rishit-dagli

@Rishit-dagli Do we already have any manifests to hit line-length violations?

--------------------------- edit ---------------------------

Also, should we treat warnings as errors using strict flag?

It might be better not to use a strict flag.
What do you think? @anencore94 @johnugeorge

[coveralls]

Coverage increased (+0.3%) to 73.232% when pulling a996aac on Rishit-dagli:Rishit-dagli-yamllint into 7bf3922 on kubeflow:master.

[anencore94]

Also, should we treat warnings as errors using strict flag?

I agree with you @tenzen-y :) Lots of our example manifests might violates line-length rule because of useful comments for users

[johnugeorge]

https://github.com/kubeflow/katib/runs/6989547788?check_suite_focus=true

I see two warnings here
warning missing document start "---" (document-start)
warning too few spaces before comment (comments)

[Rishit-dagli]

@tenzen-y

Do we already have any manifests to hit line-length violations?

Yes, please see this output for a list of the files that violate line-length: out.txt

Can you update this PR like shellcheck?

Sure thing 👍

[Rishit-dagli]

@johnugeorge

https://github.com/kubeflow/katib/runs/6989547788?check_suite_focus=true

I see two warnings here warning missing document start "---" (document-start) warning too few spaces before comment (comments)

I will edit the YAML files accordingly, I believe this should be done in a separate PR since it isn't actually "adding a linter", what do you think?

[johnugeorge]

Please rebase

[Rishit-dagli]

Please rebase

Done ✅

[tenzen-y]

Thanks! @Rishit-dagli
/lgtm

[Rishit-dagli]

This pull-request has been approved by: #1901, #1901 (review)
To complete the pull request process, please assign johnugeorge after the PR has been reviewed.

/assign @johnugeorge

[johnugeorge]

Thanks @Rishit-dagli

/approve

[google-oss-prow]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: johnugeorge, Rishit-dagli, tenzen-y

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [johnugeorge]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment