README.md templating about helm-docs HOT 6 CLOSED

Hi Scott!

Yes, I have been wanting to allow for users to put some amount of custom content into the README for a while, but couldn't find the right abstraction for making that happen. I think this is a wonderful idea, especially if we maintain backwards compatibility by implementing the following rules:

• If no README.md.gotpl (or other file specified with --template) file is found, default to the existing rules for generation
• Otherwise, render the README.md file (or other output file specified with a new --output flag)

I don't have time to do this work immediately, but would be happy to review a pull request, or get on it in the coming weeks.

from helm-docs.

@norwoodj Maybe I can help? What have you looked into thus far? I know there is a tool called confd (https://github.com/kelseyhightower/confd) that I used previously. It was for a different purpose, but case in point, it did file templating, and is written in Go as well.

from helm-docs.

I have a good idea of how it would be implemented, just lacking the time to do it at present. I made some updates to the project yesterday to at least make further extension easier, but I probably won't have the time to implement the templating functionality for a week or two.

from helm-docs.

@sc250024 I've implemented this feature and updated the documentation to reflect the changed behaviour. Please let me know when you get a chance to test this out if there's anything confusing, or if things don't work the way you expect. Thanks for the suggestion!

from helm-docs.

@norwoodj Thank you so much ! I tested out the README.md rendering with our CI pipeline, and it works great. Kudos for all the hard work :)

from helm-docs.

Hello,

Firstly, this is a great tool. Wanted to understand a couple of things if they are supported.

1. We have a requirement of helm of helms where we have multiple charts as dependencies in a single chart. Can I use this tool to generate single README file with values from all the dependent charts ?
2. Is it possible to run this tool against a tar.gz file or is it necessary to explode the chart directory to run the helm-docs tool ?

from helm-docs.