add option to ignore subcharts about helm-docs HOT 7 CLOSED

I lean towards @RothAndrew 's point, but if it's actually a use case, why not? Having some way to ignore certain directories in general would probably be useful. Up to @norwoodj in the end.

from helm-docs.

@knackaron Can I ask why you're using Git submodules in your charts/ directory? That seems to go against the whole workflow of the helm dependency command, as well as the point of the requirements.yaml and requirements.lock files in the first place.

from helm-docs.

@knackaron Can I ask why you're using Git submodules in your charts/ directory? That seems to go against the whole workflow of the helm dependency command, as well as the point of the requirements.yaml and requirements.lock files in the first place.

We maintain a large number of private charts, of which many helper charts and subcharts are included across the primary charts and umbrella charts. We found that maintaining chart dependencies as Git submodules to be better to keep everything in the Git workflow, versus relying on Helm's native dependency management and pulling in external artifacts from chart repositories. It also ensures portability of the charts in deployments where chart repositories are not available (e.g., isolated networks).

A public example of a large Helm chart that is equally complex as some of ours and that doesn't use Helm's dependency management is GitLab's chart: https://gitlab.com/charts/gitlab/tree/master/charts

from helm-docs.

Yeah, but, they should. GitLab's chart is confusing as hell, partly because it doesn't follow the standard convention of Helm's chart dependency system.

from helm-docs.

Opened a MR with the functionality I'm looking for. It doesn't affect the default behavior.

from helm-docs.

Hey, sorry I have been so slow on the response. I looked at your PR and I'm not sure if this is exactly the approach I want to go with. Thank you for the feature request, as it forced me to do something I have been meaning to do a long time.

See the PR I'll attach, it will add a .helmdocsignore file that can be used like a .gitignore file to exclude directories from processing. This way you can accomplish what you're going for, not having to supply the ignore-dir option everytime. It is also more flexible, in my opinion.

from helm-docs.

@norwoodj Thanks. That solution is superior and will work great for us.

from helm-docs.