helm docs

My charts use helm-docs to generate and update the README.md file from a the README.md.gotmpl template file using values from the Chart.yaml file.

Template

The README.md.gotmpl template file can be updated to generate different sections of the README.md file. Everything starting with the {{ template "chart.header" . }} and below is what generates the sections in the README.md. Everything above the line are just definitions. Custom definitions can be created by encapsulating the definition with {{- define "definitionName" -}} and {{- end -}}. Lower in the template, you can then put {{ template "definitionName" . }} where you want to definition to show.

Updating README.md

# From the chartname directory
$ helm-docs
INFO[2021-02-08T21:47:20-08:00] Found Chart directories [.]                  
INFO[2021-02-08T21:47:20-08:00] Generating README Documentation for chart helm-charts/charts/chartname