helm-docs icon indicating copy to clipboard operation
helm-docs copied to clipboard

document-dependency-values does not work with OCI dependency

Open hlavki opened this issue 1 year ago • 6 comments

Hi, I tried to run helm-docs --document-dependency-values for umbrella chart:

name: user
version: 0.0.1
description: User API

dependencies:
  - name: spring-boot
    version: 0.0.3
    repository: oci://harbor.company.com/charts

But result does not contain values from spring-boot dependency chart.

hlavki avatar Aug 24 '22 21:08 hlavki

Because this currently only work for file dependencies https://github.com/norwoodj/helm-docs/blob/7717a245cecabec154eccc0e9f7dbc43fb514754/pkg/document/dependency_values.go#L35

Implementing for OCI and HTTPS charts would be awesome but it looks really hard (because those dependencies can also be umbrella charts)

QuentinBisson avatar Jan 24 '23 12:01 QuentinBisson

Would be a really nice feature since its more and more used

newbenji avatar Feb 28 '23 10:02 newbenji

Could it be done lsomehow similiar to how the cli for helm does it helm show values --repo url, --version it can use oci and https request to get values for remote charts

newbenji avatar Feb 28 '23 12:02 newbenji

Because this currently only work for file dependencies Implementing for OCI and HTTPS charts would be awesome but it looks really hard (because those dependencies can also be umbrella charts)

Indeed, and it'll probably meet some fields description issues as well since the remote chart might not use the same -- <comment> format..

The use case seem useful, but maybe limiting the nesting to 1 (only your chart's closest dependencies) or letting the user pick the nesting level of his choice.

Grraahaam avatar Mar 01 '24 16:03 Grraahaam

Alternatively it might make sense to define that to include dependency values, they must be fetched first using helm dep build, which results in the *.tgz to be downloaded.

This way helm-docs would only have to handle unpacking those files, and getting their values, and doesn't have to care about implementing different registries.

peschmae avatar Mar 27 '24 17:03 peschmae

I have noticed that in case of an OCI repository entry in Chart.yaml, helm-docs is ignoring even the presence of the chart available under charts. Would a CLI flag to ignore the repository entry be an acceptable feature/solution to allow helm-docs to use entries placed under charts?

bennythejudge avatar May 07 '24 10:05 bennythejudge