-
Notifications
You must be signed in to change notification settings - Fork 520
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
docs: warn users on ingoring tgz files in helmignore #1594
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: Evans Mungai <[email protected]>
- The '**' syntax is not supported. | ||
- The globbing library is Go's 'filepath.Match', not fnmatch(3) | ||
- Trailing spaces are always ignored (there is no supported escape sequence) | ||
- There is no support for '\!' as a special leading sequence. | ||
- It does not exclude itself by default, you have to add an explicit entry for `.helmignore` | ||
|
||
#### Pitfalls to avoid | ||
- Do not add `*.tgz` to your list of ignore rules because `helm package` will ignore dependency archives from being packaged in your chart. Instead, narrow down your glob filter or specify exact file names in your rule that does not conflict with any dependency packages |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Did we consider having the package functionality ignore .helmignore
rules for dependency archives? Not against documenting this behavior in the interim. But the behavior seems wrong / should be fixed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(put the above comment on the issue)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It makes sense implementing this in code.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
Users may find themselves adding
*.tgz
in.helmignore
. Doing so will ignore all chart dependencies from being packaged usinghelm package
. The command will fail in mysterious ways as can be seen in helm/helm#12992.Since dependencies are usually
tgz
files, we need to warn users of this behaviour.