norwoodj/helm-docs

[Bug]: Subcharts Directory Structure not working with helm-docs

rahul799 opened this issue · 0 comments

Is there an existing issue for this?

  • I have searched the existing issues

Current Behavior

When using helm-docs to generate documentation for a Helm chart with subcharts, the tool expects(as per my understanding) the subcharts to be placed inside a charts directory within the main chart directory. However, the directory structure in our project is organized differently:

helm/
|- subchart-a/
|- subchart-b/
|- main/
    |- charts/   <-- This directory doesn't exist in our structure
    |- chart.yaml

But it's throwing

 Dependency with path "../subchart-a" was not found. Dependency values will not be included. 
 Dependency with path "../subchart-b" was not found. Dependency values will not be included. 

Expected Behavior

We expect helm-docs to support our directory structure where subcharts are located directly within the parent chart directory, without the need for a separate charts directory. The chart.yaml file in the main chart properly references the subcharts:

dependencies:
  - name: subchart-a
    version: 0.1.0
    repository: file://../subchart-a

Reference Chart

https://github.com/norwoodj/helm-docs/tree/master/example-charts/umbrella

Reference Template

No response

Environment

  • Operating system:
  • Helm version (output of helm version): - v3
  • GO version (output of go version):
  • Method of calling helm-docs - manual

Link to helm-docs Logs

No response

Further Information

No response