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.

Sign up for GitHub

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

Jump to bottom

docs: warn users on ingoring tgz files in helmignore #1594

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: warn users on ingoring tgz files in helmignore #1594

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion content/en/docs/chart_template_guide/helm_ignore_file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,15 @@ a[b-d].txt
temp?
```

Some notable differences from .gitignore:
#### Some notable differences from .gitignore:
- 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
Copy link
Contributor

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.

Copy link
Contributor

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)


**We'd love your help** making this document better. To add, correct, or remove
information, [file an issue](https://github.com/helm/helm-www/issues) or send us a
Expand Down