Comments (5)
@borisrizov-zf in your case, the .helmdocsignore
file is at the wrong location:
$ find . -name .helmdocsignore
./charts/managed-identity-wallet/.helmdocsignore
$ cat $(!!)
charts/
$ helm-docs -l debug
DEBU[2024-03-02T13:43:41Z] No ignore file found at /tmp/managed-identity-wallet/.helmdocsignore, using empty ignore rules
...
The .helmdocsignore
file is like a .gitignore
file, it must be at the root of the repository.
$ mv charts/managed-identity-wallet/.helmdocsignore .
$ echo charts/managed-identity-wallet/charts > .helmdocsignore
$ helm-docs -l debug
DEBU[2024-03-02T13:46:38Z] Found ignore file at /tmp/managed-identity-wallet/.helmdocsignore, using those ignore rules
DEBU[2024-03-02T13:46:38Z] Ignoring directory /tmp/managed-identity-wallet/.git
DEBU[2024-03-02T13:46:38Z] Ignoring directory /tmp/managed-identity-wallet/charts/managed-identity-wallet/charts
I wouldn't be surprised if this is also @Pallavi028's problem, but I'm having trouble understanding for sure from their comment.
from helm-docs.
I can confirm the behaviour. I have a charts/pgadmin4
folder in my main charts/project
folder. Ignoring does nothing.
Might be useful to add a flag to ignore a folder without setting a .helmdocsignore
file, e.g. --ignore-dir some-dir/
.
The only thing that doesn't happen is to add the sub-documentation to the main documentation. Maybe that's the intended behaviour?
from helm-docs.
This is not intended behavior, however I cannot reproduce this. Can one of you send me a tar archive of your repository, or make one of these repositories publicly available in some way so I can test against your setup?
from helm-docs.
Hi,
the repository where I had the issue: https://github.com/eclipse-tractusx/managed-identity-wallet
from helm-docs.
@norwoodj Hey, awesome! Thank you so much, I'll make sure to fix that right away.
from helm-docs.
Related Issues (20)
- [Bug]: building for openSUSE fails with "unsafe.Slice requires go1.17 or later (-lang was set to go1.16; check go.mod)" HOT 4
- [Feat]: Move project to helm-docs organization HOT 3
- [Feat]: recursive with template from root (and template inside chart) HOT 1
- [Bug]: README shows the repo name as jnorwood/helm-docs rather than norwoodj/helm-docs in pre-commit examples
- [security] Vulnerabilities in the Container Image HOT 2
- Is it possible to add custom fields and use those values in generating docs
- [Feat]: Add an option for "deprecation warning" for a value HOT 1
- Collision between the actual helm-docs commands and the regular Markdown documentation of the helm charts HOT 1
- [Bug]: Segmentation violation when using templates in `values.yml` HOT 1
- [Bug]: Error with my go1.20 cannot compile Go 1.22 code HOT 1
- [Feat]: git-hook HOT 3
- [Feat]: pre-commit helm-docs-container pin docker version by default
- [Bug]: `helm-docs.versionFooter` missing when installing tool using Go HOT 1
- [Feat]: Documenting values not explicitly present in values.yaml file
- [Feat]: Fail if specified template does not exist
- [Feat]: Add markdown description to Sections
- [Bug]: Always failing when using the --documentation-strict-mode flag
- pre-commit scans the file only the first time HOT 1
- [Bug]: Subcharts Directory Structure not working with helm-docs
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from helm-docs.