helm-docs
helm-docs copied to clipboard
norwoodj
Add an optional flag to remove the helm-docs version footer from the default template
This change adds a new flag named skip-version-footer. When set to true, the version footer is removed from the default README template. By default, the flag is set to false so the version footer is kept for backwards compatibility.
I had a similar issue as this comment https://github.com/norwoodj/helm-docs/issues/162#issuecomment-1819415642 where the default README template is great for the majority of our charts. For maintenance, it would be much easier for us to avoid copying README templates for each chart just to remove the version footer.
Fixes https://github.com/norwoodj/helm-docs/issues/162
I guess this PR would supercede my one to update at least the documentation https://github.com/norwoodj/helm-docs/pull/219
There have been requests to do this in the past and I still feel the same way:
If you don't want the versionFooter in your template, you can use a README.md.gotmpl file to define the template that you want to use when rendering your README. The default template is what it is, if you don't like it, there is already a mechanism to define your own. I don't want to go down the road of adding a ton of options to augment the default template like this.
There have been requests to do this in the past and I still feel the same way:
If you don't want the versionFooter in your template, you can use a README.md.gotmpl file to define the template that you want to use when rendering your README. The default template is what it is, if you don't like it, there is already a mechanism to define your own. I don't want to go down the road of adding a ton of options to augment the default template like this.
Could you comment on the idea of keeping the footer but removing the version? I think that would solve the problem of unexpected/untimely changes that complicated workflows such as validation in CD and pre-commit.
Thanks!
