diff --git a/pkg/ignore/doc.go b/pkg/ignore/doc.go index b21a661d3..e576e9cee 100644 --- a/pkg/ignore/doc.go +++ b/pkg/ignore/doc.go @@ -64,5 +64,18 @@ Notable differences from .gitignore: - Trailing spaces are always ignored (there is no supported escape sequence) - The evaluation of escape sequences has not been tested for compatibility - There is no support for '\\!' as a special leading sequence for files that begin with `!` + - The first filename match will determine if it is included or excluded, subsequent lines are ignored + +Example: + + # This is valid .gitignore syntax to only include Chart.yaml and values.yaml, but invalid for .helmignore + * + !Chart.yaml + !values.yaml + + # Instead, this syntax will work as .helmignore takes the first match per file + !Chart.yaml + !values.yaml + * */ package ignore // import "helm.sh/helm/v3/pkg/ignore"