Update best practice format for Helm chart specifications

projectsyn / documentation

The Project Syn main documentation repository

https://docs.syn.tools/

BSD 3-Clause "New" or "Revised" License

6 stars 3 forks source link

Update best practice format for Helm chart specifications #150

Closed simu closed 2 years ago

simu commented 2 years ago

The new format makes the implementation for extracting Helm chart dependencies in commodore-renovate much easier.

Checklist

[x] Keep pull requests small so they can be easily reviewed.
[x] Update the documentation.

simu commented 2 years ago

One thing I'm unsure about is the not very explicit requirement that the charts key needs to equal the chart_name for renovate to work. However the alternative of having an explicit chart_name field in the defaults.yml is also not great (and ironically what we just talked about being a code smell sweat_smile ). So I'm fine with leaving it as is.

Added an extra IMPORTANT box noting that the name must match for Renovate to be able to extract the dependency.