norwoodj / helm-docs

A tool for automatically generating markdown documentation for helm charts
GNU General Public License v3.0
1.4k stars 187 forks source link

[Feat]: Add `skip-footer-version` flag #252

Open stevehipwell opened 4 months ago

stevehipwell commented 4 months ago

General Summary

The new skip-version-footer flag solves the issue with the generated docs changing with new helm-docs versions but does so by removing the whole footer instead of only fixing the source of the problem. I'd like to keep the footer but remove the helm-docs version which was used for generation as having a footer to say that the docs were generated with helm-docs is really useful.

Is your feature request related to a problem? Please describe and/or link to a bug issue.

I'd like my docs to have a footer attributing them to helm-docs without the helm-docs version used to generate them embedded in it. This is because my automation checks the docs diff and expects there to be no changes or it blocks as an error.

Expected Behavior

I should be able to set a flag to always get reproducible docs which include a footer without needing to override the whole default template for every chart.

Current Behavior

I have to duplicate the whole template for all charts to remove the version from the footer.

Possible Solution

I'd like to see a new flag skip-footer-version added to remove the version of helm-docs used from the footer without removing the whole footer.

Alternatives you've considered

See above.

Further Information

No response

norwoodj commented 4 months ago

Hey, I think this is reasonable. I'd take a look at a PR if you made one.

stevehipwell commented 4 months ago

@norwoodj I think this would actually require more changes to the structure of the system than I thought. After reading through the code again I've managed to get a shared template working for my use case so I don't think I've got the time to warrant doing the work for this.