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.

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

Add information for the helmlintingore file usage and structure/fix #1617

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
43 changes: 43 additions & 0 deletions content/en/docs/chart_template_guide/helm_lint_ignore_file.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: "The .helmlintignore file"
description: "The `.helmlintignore` file is used to specify files or patterns to exclude from linting in your helm chart."
weight: 15
---

The `.helmlintignore` file allows you to specify files or patterns that you want to exclude from linting in your helm chart.

This file can be placed in the same directory as the `Chart.yaml` or in a separate directory. It can be specified by using the `--lint-ignore-file` flag when running the `helm lint` command. This allows for flexibility in managing lint exclusions, especially useful in projects with multiple subcharts or complex directory structures.

The `.helmlintignore` file helps manage lint results more effectively, particularly in larger charts where certain files may deviate from standard linting rules but are accepted by the maintainers.

The `.helmlintignore` file supports Unix shell glob matching, relative path matching, and specific error-triggering lines exclusion. Only one pattern per line is considered.

Here is an example `.helmlintignore` file:

```
# comment

# Exclude a specific script file
template/test/test.sh

# Exclude a yaml file
template/test/test.yaml

# Exclude a specific line from findings in a specific file
template/test/test.yaml {{template "yourtemplate" .}}

# Exclude specific Helm chart configurations
yourchart/yourfolder/yourfile.yaml <.Values.global.rbac>

# For errors that don't have a path in the description (e.g., metadata or directory errors), use error_lint_ignore=
error_lint_ignore=chart metadata is missing these dependencies*
```

When working with subcharts (e.g., adding the `--with-subcharts` option), the `.helmlintignore` file can be centralized by using the `--lint-ignore-file` flag. This setup allows all the subcharts to be linted with the same rules. Alternatively, each subchart can have its own `.helmlintignore` file, but if that is the case, the `--lint-ignore-file` flag needs to be removed from the `helm lint` command.

**Note:**
- The `.helmlintignore` file does not support the '**' syntax to match patterns across all directories; patterns apply only to the directory level specified.
- Trailing spaces are always ignored as there is no supported escape sequence in the `.helmlintignore` file.
- The `.helmlintignore` file does not exclude itself by default.

**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 pull request.
8 changes: 4 additions & 4 deletions content/en/docs/helm/helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,9 @@ By default, the default directories depend on the Operating System. The defaults
--kubeconfig string path to the kubeconfig file
-n, --namespace string namespace scope for this request
--qps float32 queries per second used when communicating with the Kubernetes API, not including bursting
--registry-config string path to the registry config file (default "~/.config/helm/registry/config.json")
--repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository")
--repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml")
--registry-config string path to the registry config file (default "~/Library/Preferences/helm/registry/config.json")
--repository-cache string path to the file containing cached repository indexes (default "~/Library/Caches/helm/repository")
--repository-config string path to the file containing repository names and URLs (default "~/Library/Preferences/helm/repositories.yaml")
```

### SEE ALSO
Expand Down Expand Up @@ -111,4 +111,4 @@ By default, the default directories depend on the Operating System. The defaults
* [helm verify](helm_verify.md) - verify that a chart at the given path has been signed and is valid
* [helm version](helm_version.md) - print the client version information

###### Auto generated by spf13/cobra on 24-Jan-2024
###### Auto generated by spf13/cobra on 16-Aug-2024
8 changes: 4 additions & 4 deletions content/en/docs/helm/helm_completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ Generate autocompletion scripts for Helm for the specified shell.
--kubeconfig string path to the kubeconfig file
-n, --namespace string namespace scope for this request
--qps float32 queries per second used when communicating with the Kubernetes API, not including bursting
--registry-config string path to the registry config file (default "~/.config/helm/registry/config.json")
--repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository")
--repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml")
--registry-config string path to the registry config file (default "~/Library/Preferences/helm/registry/config.json")
--repository-cache string path to the file containing cached repository indexes (default "~/Library/Caches/helm/repository")
--repository-config string path to the file containing repository names and URLs (default "~/Library/Preferences/helm/repositories.yaml")
```

### SEE ALSO
Expand All @@ -47,4 +47,4 @@ Generate autocompletion scripts for Helm for the specified shell.
* [helm completion powershell](helm_completion_powershell.md) - generate autocompletion script for powershell
* [helm completion zsh](helm_completion_zsh.md) - generate autocompletion script for zsh

###### Auto generated by spf13/cobra on 24-Jan-2024
###### Auto generated by spf13/cobra on 16-Aug-2024
8 changes: 4 additions & 4 deletions content/en/docs/helm/helm_completion_bash.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,13 +52,13 @@ helm completion bash [flags]
--kubeconfig string path to the kubeconfig file
-n, --namespace string namespace scope for this request
--qps float32 queries per second used when communicating with the Kubernetes API, not including bursting
--registry-config string path to the registry config file (default "~/.config/helm/registry/config.json")
--repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository")
--repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml")
--registry-config string path to the registry config file (default "~/Library/Preferences/helm/registry/config.json")
--repository-cache string path to the file containing cached repository indexes (default "~/Library/Caches/helm/repository")
--repository-config string path to the file containing repository names and URLs (default "~/Library/Preferences/helm/repositories.yaml")
```

### SEE ALSO

* [helm completion](helm_completion.md) - generate autocompletion scripts for the specified shell

###### Auto generated by spf13/cobra on 24-Jan-2024
###### Auto generated by spf13/cobra on 16-Aug-2024
8 changes: 4 additions & 4 deletions content/en/docs/helm/helm_completion_fish.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,13 +49,13 @@ helm completion fish [flags]
--kubeconfig string path to the kubeconfig file
-n, --namespace string namespace scope for this request
--qps float32 queries per second used when communicating with the Kubernetes API, not including bursting
--registry-config string path to the registry config file (default "~/.config/helm/registry/config.json")
--repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository")
--repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml")
--registry-config string path to the registry config file (default "~/Library/Preferences/helm/registry/config.json")
--repository-cache string path to the file containing cached repository indexes (default "~/Library/Caches/helm/repository")
--repository-config string path to the file containing repository names and URLs (default "~/Library/Preferences/helm/repositories.yaml")
```

### SEE ALSO

* [helm completion](helm_completion.md) - generate autocompletion scripts for the specified shell

###### Auto generated by spf13/cobra on 24-Jan-2024
###### Auto generated by spf13/cobra on 16-Aug-2024
8 changes: 4 additions & 4 deletions content/en/docs/helm/helm_completion_powershell.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,13 @@ helm completion powershell [flags]
--kubeconfig string path to the kubeconfig file
-n, --namespace string namespace scope for this request
--qps float32 queries per second used when communicating with the Kubernetes API, not including bursting
--registry-config string path to the registry config file (default "~/.config/helm/registry/config.json")
--repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository")
--repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml")
--registry-config string path to the registry config file (default "~/Library/Preferences/helm/registry/config.json")
--repository-cache string path to the file containing cached repository indexes (default "~/Library/Caches/helm/repository")
--repository-config string path to the file containing repository names and URLs (default "~/Library/Preferences/helm/repositories.yaml")
```

### SEE ALSO

* [helm completion](helm_completion.md) - generate autocompletion scripts for the specified shell

###### Auto generated by spf13/cobra on 24-Jan-2024
###### Auto generated by spf13/cobra on 16-Aug-2024
8 changes: 4 additions & 4 deletions content/en/docs/helm/helm_completion_zsh.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,13 @@ helm completion zsh [flags]
--kubeconfig string path to the kubeconfig file
-n, --namespace string namespace scope for this request
--qps float32 queries per second used when communicating with the Kubernetes API, not including bursting
--registry-config string path to the registry config file (default "~/.config/helm/registry/config.json")
--repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository")
--repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml")
--registry-config string path to the registry config file (default "~/Library/Preferences/helm/registry/config.json")
--repository-cache string path to the file containing cached repository indexes (default "~/Library/Caches/helm/repository")
--repository-config string path to the file containing repository names and URLs (default "~/Library/Preferences/helm/repositories.yaml")
```

### SEE ALSO

* [helm completion](helm_completion.md) - generate autocompletion scripts for the specified shell

###### Auto generated by spf13/cobra on 24-Jan-2024
###### Auto generated by spf13/cobra on 16-Aug-2024
8 changes: 4 additions & 4 deletions content/en/docs/helm/helm_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,13 @@ helm create NAME [flags]
--kubeconfig string path to the kubeconfig file
-n, --namespace string namespace scope for this request
--qps float32 queries per second used when communicating with the Kubernetes API, not including bursting
--registry-config string path to the registry config file (default "~/.config/helm/registry/config.json")
--repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository")
--repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml")
--registry-config string path to the registry config file (default "~/Library/Preferences/helm/registry/config.json")
--repository-cache string path to the file containing cached repository indexes (default "~/Library/Caches/helm/repository")
--repository-config string path to the file containing repository names and URLs (default "~/Library/Preferences/helm/repositories.yaml")
```

### SEE ALSO

* [helm](helm.md) - The Helm package manager for Kubernetes.

###### Auto generated by spf13/cobra on 24-Jan-2024
###### Auto generated by spf13/cobra on 16-Aug-2024
8 changes: 4 additions & 4 deletions content/en/docs/helm/helm_dependency.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,9 @@ for this case.
--kubeconfig string path to the kubeconfig file
-n, --namespace string namespace scope for this request
--qps float32 queries per second used when communicating with the Kubernetes API, not including bursting
--registry-config string path to the registry config file (default "~/.config/helm/registry/config.json")
--repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository")
--repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml")
--registry-config string path to the registry config file (default "~/Library/Preferences/helm/registry/config.json")
--repository-cache string path to the file containing cached repository indexes (default "~/Library/Caches/helm/repository")
--repository-config string path to the file containing repository names and URLs (default "~/Library/Preferences/helm/repositories.yaml")
```

### SEE ALSO
Expand All @@ -90,4 +90,4 @@ for this case.
* [helm dependency list](helm_dependency_list.md) - list the dependencies for the given chart
* [helm dependency update](helm_dependency_update.md) - update charts/ based on the contents of Chart.yaml

###### Auto generated by spf13/cobra on 24-Jan-2024
###### Auto generated by spf13/cobra on 16-Aug-2024
8 changes: 4 additions & 4 deletions content/en/docs/helm/helm_dependency_build.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,13 @@ helm dependency build CHART [flags]
--kubeconfig string path to the kubeconfig file
-n, --namespace string namespace scope for this request
--qps float32 queries per second used when communicating with the Kubernetes API, not including bursting
--registry-config string path to the registry config file (default "~/.config/helm/registry/config.json")
--repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository")
--repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml")
--registry-config string path to the registry config file (default "~/Library/Preferences/helm/registry/config.json")
--repository-cache string path to the file containing cached repository indexes (default "~/Library/Caches/helm/repository")
--repository-config string path to the file containing repository names and URLs (default "~/Library/Preferences/helm/repositories.yaml")
```

### SEE ALSO

* [helm dependency](helm_dependency.md) - manage a chart's dependencies

###### Auto generated by spf13/cobra on 24-Jan-2024
###### Auto generated by spf13/cobra on 16-Aug-2024
8 changes: 4 additions & 4 deletions content/en/docs/helm/helm_dependency_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,13 +44,13 @@ helm dependency list CHART [flags]
--kubeconfig string path to the kubeconfig file
-n, --namespace string namespace scope for this request
--qps float32 queries per second used when communicating with the Kubernetes API, not including bursting
--registry-config string path to the registry config file (default "~/.config/helm/registry/config.json")
--repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository")
--repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml")
--registry-config string path to the registry config file (default "~/Library/Preferences/helm/registry/config.json")
--repository-cache string path to the file containing cached repository indexes (default "~/Library/Caches/helm/repository")
--repository-config string path to the file containing repository names and URLs (default "~/Library/Preferences/helm/repositories.yaml")
```

### SEE ALSO

* [helm dependency](helm_dependency.md) - manage a chart's dependencies

###### Auto generated by spf13/cobra on 24-Jan-2024
###### Auto generated by spf13/cobra on 16-Aug-2024
8 changes: 4 additions & 4 deletions content/en/docs/helm/helm_dependency_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,13 +52,13 @@ helm dependency update CHART [flags]
--kubeconfig string path to the kubeconfig file
-n, --namespace string namespace scope for this request
--qps float32 queries per second used when communicating with the Kubernetes API, not including bursting
--registry-config string path to the registry config file (default "~/.config/helm/registry/config.json")
--repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository")
--repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml")
--registry-config string path to the registry config file (default "~/Library/Preferences/helm/registry/config.json")
--repository-cache string path to the file containing cached repository indexes (default "~/Library/Caches/helm/repository")
--repository-config string path to the file containing repository names and URLs (default "~/Library/Preferences/helm/repositories.yaml")
```

### SEE ALSO

* [helm dependency](helm_dependency.md) - manage a chart's dependencies

###### Auto generated by spf13/cobra on 24-Jan-2024
###### Auto generated by spf13/cobra on 16-Aug-2024
8 changes: 4 additions & 4 deletions content/en/docs/helm/helm_env.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,13 @@ helm env [flags]
--kubeconfig string path to the kubeconfig file
-n, --namespace string namespace scope for this request
--qps float32 queries per second used when communicating with the Kubernetes API, not including bursting
--registry-config string path to the registry config file (default "~/.config/helm/registry/config.json")
--repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository")
--repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml")
--registry-config string path to the registry config file (default "~/Library/Preferences/helm/registry/config.json")
--repository-cache string path to the file containing cached repository indexes (default "~/Library/Caches/helm/repository")
--repository-config string path to the file containing repository names and URLs (default "~/Library/Preferences/helm/repositories.yaml")
```

### SEE ALSO

* [helm](helm.md) - The Helm package manager for Kubernetes.

###### Auto generated by spf13/cobra on 24-Jan-2024
###### Auto generated by spf13/cobra on 16-Aug-2024
Loading