docs: warn users on ingoring tgz files in helmignore #1594
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Evans Mungai <[email protected]>
gjenkins8
reviewed
Aug 7, 2024
| - 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.
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.
(put the above comment on the issue)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Users may find themselves adding
*.tgzin.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
tgzfiles, we need to warn users of this behaviour.