Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
1 task done
muja opened this issue Mar 10, 2025 · 0 comments
Open
1 task done

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

muja opened this issue Mar 10, 2025 · 0 comments
Assignees
Labels
bug Something isn't working triage Issues that need to be triaged and categorized

Comments

@muja
Copy link

muja commented Mar 10, 2025

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

@muja muja added bug Something isn't working triage Issues that need to be triaged and categorized labels Mar 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working triage Issues that need to be triaged and categorized
Projects
None yet
Development

No branches or pull requests

3 participants