Loading Helm Chart Validator...

How to Validate Helm Charts - Step by Step Guide

Step 1

Prepare Your Chart.yaml File

Locate your Chart.yaml file in your Helm chart directory. This file contains metadata about your chart including name, version, and dependencies. Copy the contents of the file to validate it.

•
Required fields: apiVersion, name, and version must be present in Chart.yaml
•
Helm 3: Use apiVersion: v2 for Helm 3 charts
•
Try the sample: Click "Sample" to see a properly formatted Chart.yaml

Example: Helm Chart.yaml File

Here's what a typical Chart.yaml file looks like:

apiVersion: v2
name: myapp
description: A Helm chart for Kubernetes
type: application
version: 1.0.0
appVersion: "1.0"
maintainers:
  - name: John Doe
    email: [email protected]
Step 2

Automatic Validation

Paste your Chart.yaml content into the editor. The validator checks for YAML syntax errors (with line and column), missing required fields and invalid values, and points out a few Helm best practices such as lowercase chart names. The check runs a moment after you stop typing.

•
Required fields: apiVersion must be v1 or v2, name and version must be present, and type must be application or library if you set it
•
Version check: Checks semantic versioning format (MAJOR.MINOR.PATCH)
•
Dependencies: Checks that each dependency has a name and version, and warns when the repository is missing

Example: Common Validation Issues

The validator catches typical errors:

Missing required field: apiVersion

Chart.yaml must specify an apiVersion (v1 or v2).

Invalid version format

Write the version as SemVer, e.g. 1.0.0. Short forms like 1.0 get a warning.

Missing description field

Adding a description helps users understand your chart's purpose.

Step 3

Review Errors, Warnings & Suggestions

The validator categorizes feedback to help you fix issues efficiently. Review the results panel to understand what needs attention before packaging your chart.

•
Errors (red): Critical issues that must be fixed before deploying
•
Warnings (yellow): Best practice violations that should be addressed
•
Tips (blue): Optional improvements for chart quality and discoverability

Example: Validation Results

The validator provides clear feedback:

✓ Your Chart.yaml looks good!
No errors in Chart.yaml. Run helm lint on the whole chart before packaging.
⚠ Warning
No maintainers specified. Add maintainer contact information.
Suggestions
Add keywords to improve chart discoverability on Artifact Hub.
Step 4

Download and Package Chart

Once there are no errors left, copy or download the Chart.yaml from the editor. Save it back to your chart directory, then package and deploy using helm package and helm install commands.

•
Test packaging: Run helm lint . to verify your entire chart
•
Version control: Commit your validated Chart.yaml to git
•
Publishing: After helm lint passes, you can publish to Artifact Hub or private registries

Example: Package and Deploy Your Chart

After validation, package and deploy your Helm chart:

# Lint the entire chart
$ helm lint ./myapp
==> Linting myapp
1 chart(s) linted, 0 chart(s) failed

# Package the chart
$ helm package ./myapp
Successfully packaged chart and saved it to: myapp-1.0.0.tgz

# Install the chart
$ helm install myapp-release ./myapp-1.0.0.tgz
NAME: myapp-release
STATUS: deployed

Frequently Asked Questions

What fields are required in a Chart.yaml file?

Helm needs apiVersion (v2 for Helm 3, v1 for old Helm 2 charts), name and version. The validator reports any of those as an error when it is missing. description, type (application or library), appVersion, maintainers and keywords are optional, so missing ones only show up as warnings or tips.

What's the difference between Helm 2 and Helm 3 Chart.yaml?

Helm 2 charts use apiVersion: v1, Helm 3 charts use apiVersion: v2. Version 2 added the type field (application or library) and moved dependencies from a separate requirements.yaml into Chart.yaml. The validator warns if a v1 chart uses either of those.

How do I fix semantic versioning errors?

Write the chart version as MAJOR.MINOR.PATCH, for example 1.0.0 or 2.3.1-beta.1, and put it in quotes if YAML could read it as a number. Helm itself also reads short forms like 1.0 or v1.0.0, so the validator only warns about those; anything Helm cannot read at all, or a version written as a bare number, is an error.

Can I validate Chart.yaml without the full Helm chart?

Yes. The validator only looks at the Chart.yaml text you paste, so you don't need templates or values.yaml. It does not render templates or check values.yaml, so run helm lint on the whole chart before you package it.

What does "Add Missing Fields" change in my file?

Only what is missing: it adds apiVersion, name, version or description with a placeholder value, and a name for a maintainer that has none. Everything you wrote stays as it was, including comments, quotes and values like 00501 or 14.50. Placeholders such as my-chart and 0.1.0 are meant to be replaced with your real values.

Is this validator the same as helm lint?

No. helm lint checks the whole chart, including templates, values and dependency files. This page checks the Chart.yaml text on its own, so it is good for a quick look while you edit, but run helm lint before packaging.

Is my Chart.yaml sent anywhere?

No. The check runs in your browser, and the text you paste or upload never leaves your computer.

More on chart dependencies and helm lint in the Helm docs. To see what a chart renders to, try the Helm to Kubernetes converter.