Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

✨ Add YAML Linting to CI Workflow for Scaffolded Charts #4512

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

sarthaksarthak9
Copy link
Contributor

fixes #4503

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jan 21, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: sarthaksarthak9
Once this PR has been reviewed and has the lgtm label, please assign kavinjsir for approval. For more information see the Code Review Process.

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

Needs approval from an approver in each of these files:

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

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jan 21, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @sarthaksarthak9. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@sarthaksarthak9 sarthaksarthak9 changed the title (:sparkles:): Add YAML Linting to CI Workflow for Scaffolded Charts (:sparkles:) Add YAML Linting to CI Workflow for Scaffolded Charts Jan 21, 2025
@sarthaksarthak9 sarthaksarthak9 changed the title (:sparkles:) Add YAML Linting to CI Workflow for Scaffolded Charts ✨ Add YAML Linting to CI Workflow for Scaffolded Charts Jan 21, 2025
Copy link
Contributor

Choose a reason for hiding this comment

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

would be better if users uses helm, to add yaml lint command to scaffold Makefile?

Copy link
Member

Choose a reason for hiding this comment

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

I think we cannot add the target only for helm by default.

Also, see that we have the lint in the Makefile for the project

https://github.com/kubernetes-sigs/kubebuilder/blob/master/Makefile#L119-L122

So, maybe the ONLY change we need here is to change this target to ensure that it will also lint the helm-chart in the dist dir and will ONLY ignore the install.yaml.

This target is called in the CI already:

yamllint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Run yamllint make target
run: make yamllint

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add YAML Linting for Sample Files and Scaffolded Chart Files
4 participants