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 Maintainers to Chart YAML to Pass CT Linter #71

Open
pierluigilenoci opened this issue Dec 6, 2024 · 6 comments
Open

Add Maintainers to Chart YAML to Pass CT Linter #71

pierluigilenoci opened this issue Dec 6, 2024 · 6 comments

Comments

@pierluigilenoci
Copy link

The current Komoplane Helm chart fails the ct linter due to the absence of the maintainers field in the Chart.yaml file.
The ct linter requires this field to ensure that charts have identifiable maintainers for support and accountability purposes.

Including the maintainers field in the Chart.yaml will ensure that the Helm chart passes the ct linter, adhering to Helm chart best practices and improving quality control.

For more information on the maintainers field, please refer to the Helm Chart Best Practices.

@undera
Copy link
Collaborator

undera commented Dec 7, 2024

I have read "Helm Chart Best Practices" section linked above, and there's no mention of maintainer fields there. Can it be that it's not part of Best Practices?

@pierluigilenoci
Copy link
Author

pierluigilenoci commented Dec 7, 2024

@undera more refs:

To get the "maintainers' error", run the command ct lint . in the Chart's root folder.

@undera
Copy link
Collaborator

undera commented Dec 7, 2024

I have added chart-testing lint step to our CI, it does not complain on maintainers: https://github.com/komodorio/komoplane/actions/runs/12213639829/job/34073479712

@pierluigilenoci
Copy link
Author

pierluigilenoci commented Dec 8, 2024

@undera It's not just complaining because the charts/ct.yaml configuration is not correct and doesn't lint the chart.
If you look at the logs, it is clear.
There should have been something like:

------------------------------------------------------------------------------------------------------------------------
 Charts to be processed:
------------------------------------------------------------------------------------------------------------------------
 komoplane => (version: "0.1.5", path: "charts/komoplane")
------------------------------------------------------------------------------------------------------------------------

Linting chart "komoplane => (version: \"0.1.5\", path: \"charts/komoplane\")"
Validating /home/runner/work/komoplane/komoplane/charts/komoplane/Chart.yaml...
Validation success! 👍
Validating maintainers...
==> Linting charts/komoplane
[INFO] Chart.yaml: icon is recommended

1 chart(s) linted, 0 chart(s) failed

------------------------------------------------------------------------------------------------------------------------
 ✔︎ komoplane => (version: "0.1.5", path: "charts/komoplane")
------------------------------------------------------------------------------------------------------------------------
All charts linted successfully

@pierluigilenoci
Copy link
Author

To quickly test run ct lint --all . inside the chart folder.

@undera
Copy link
Collaborator

undera commented Dec 9, 2024

I have added the maintainers field to the chart.yaml, but it still complains on some 404 error. I don't have more time to spend on this, sorry.

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

No branches or pull requests

2 participants