From e9459e606a23f909e6d8eb24bdd07194f1e153f3 Mon Sep 17 00:00:00 2001 From: Shane Starcher Date: Fri, 30 Mar 2018 08:42:01 -0400 Subject: [PATCH] [docs] Chart.yaml change some fields from optional to recommended --- docs/charts.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/charts.md b/docs/charts.md index 8722e6862..9fa8f8b07 100644 --- a/docs/charts.md +++ b/docs/charts.md @@ -49,7 +49,7 @@ kubeVersion: A SemVer range of compatible Kubernetes versions (optional) description: A single-sentence description of this project (optional) keywords: - A list of keywords about this project (optional) -home: The URL of this project's home page (optional) +home: The URL of this project's home page (recommended) sources: - A list of URLs to source code for this project (optional) maintainers: # (optional) @@ -57,12 +57,14 @@ maintainers: # (optional) email: The maintainer's email (optional for each maintainer) url: A URL for the maintainer (optional for each maintainer) engine: gotpl # The name of the template engine (optional, defaults to gotpl) -icon: A URL to an SVG or PNG image to be used as an icon (optional). -appVersion: The version of the app that this contains (optional). This needn't be SemVer. +icon: A URL to an SVG or PNG image to be used as an icon (recommended). +appVersion: The version of the app that this contains (recommended). This needn't be SemVer. deprecated: Whether this chart is deprecated (optional, boolean) tillerVersion: The version of Tiller that this chart requires. This should be expressed as a SemVer range: ">2.0.0" (optional) ``` +Recommended fields if missing will fail linting. + If you are familiar with the `Chart.yaml` file format for Helm Classic, you will notice that fields specifying dependencies have been removed. That is because the new Chart format expresses dependencies using the `charts/` directory.