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 check for the existence of NOTES.txt template in a given chart #428

Closed
zvigrinberg opened this issue Mar 19, 2024 · 2 comments · Fixed by #430
Closed

Add check for the existence of NOTES.txt template in a given chart #428

zvigrinberg opened this issue Mar 19, 2024 · 2 comments · Fixed by #430

Comments

@zvigrinberg
Copy link
Contributor

In helm chart that contains NOTES.txt template, it rendered and printed to the screen after helm install/upgrade command completed.

It's very recommended to have a NOTES.txt template in any chart, because in this way, we can supply for the user many interesting details and information about the deployment that helm install command just deployed, and how to use it, customize it , and even more.

obviously implementing this check is very simple and straightforward.

More details of helm NOTES.txt template:

https://helm.sh/docs/chart_template_guide/notes_files/

@rocrisp
Copy link

rocrisp commented Mar 21, 2024

Hi Zvi, Thank you for posting this issue. So Chart verifier doesn't care about NOTES.txt is in the chart. Are you seeing error? Or perhaps you want the chart owner to include NOTES.txt if not found when validating the helm chart.

@zvigrinberg
Copy link
Contributor Author

Hi Zvi, Thank you for posting this issue. So Chart verifier doesn't care about NOTES.txt is in the chart. Are you seeing error? Or perhaps you want the chart owner to include NOTES.txt if not found when validating the helm chart.

Hi @rocrisp
It's not an error, just a recommendation to add this simple check as an improvement, to verify existence of NOTES.txt, and if not found, fail the check... it could be even an optional check, not mandatory , but this is up to you.

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 a pull request may close this issue.

2 participants