Skip to content

[Bug]: Does not work in symlinked folder #286

@muja

Description

@muja

Is there an existing issue for this?

  • I have searched the existing issues

Current Behavior

When cding into a symlinked helm chart and running helm-docs ., helm-docs is not able to find any charts.

E.g.

❯ docker run -it --rm --entrypoint sh --volume $(pwd):/helm-docs -u $(id -u) jnorwood/helm-docs -c 'set -x; ln -s /helm-docs /tmp/foo; cd /tmp/foo; helm-docs .; cd $(realpath /tmp/foo); helm-docs .'
+ ln -s /helm-docs /tmp/foo
+ cd /tmp/foo
+ helm-docs .
INFO[2025-03-10T04:47:12Z] Found Chart directories []
+ realpath /tmp/foo
+ cd /helm-docs
+ helm-docs .
INFO[2025-03-10T04:47:12Z] Found Chart directories [.]
INFO[2025-03-10T04:47:12Z] Generating README Documentation for chart .

Expected Behavior

helm-docs does not care whether it's in a symlink or not

Reference Chart

not necessary

Reference Template

No response

Environment

docker latest

Link to helm-docs Logs

No response

Further Information

No response

Metadata

Metadata

Labels

bugSomething isn't workingtriageIssues that need to be triaged and categorized

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions