fix: helm module to action conversion: do not require version with na…

…me (#4463)

* fix: helm module to action conversion: do not require version with name

* chore: yarn run generate-docs

* chore: add regression test for helm name+version requirement fix

core/src/plugins/kubernetes/helm/config.ts

@@ -153,7 +153,6 @@ const helmChartSpecSchema = () =>
       url: joi.string().uri().description("An absolute URL to a packaged URL."),
       version: helmChartVersionSchema(),
     })
-    .with("name", ["version"])
     .without("path", ["name", "repo", "version", "url"])
     .without("url", ["name", "repo", "version", "path"])
     .xor("name", "path", "url")
@@ -163,7 +162,7 @@ const helmChartSpecSchema = () =>
 
   If the chart is defined in the same directory as the action, you can skip this, and the chart sources will be detected. If the chart is in the source tree but in a sub-directory, you should set \`chart.path\` to the directory path, relative to the action directory.
 
-  If the chart is remote, you must specify \`chart.name\` and \`chart.version\, and optionally \`chart.repo\` (if the chart is not in the default "stable" repo).
+  If the chart is remote, you can specify \`chart.name\` and \`chart.version\, and optionally \`chart.repo\` (if the chart is not in the default "stable" repo).
 
   You may also specify an absolute URL to a packaged chart via \`chart.url\`.
 

core/test/data/test-projects/helm-name-version-regression/garden.yml

@@ -0,0 +1,16 @@
+kind: Project
+apiVersion: garden.io/v0
+name: repro
+environments:
+  - name: default
+providers:
+  - name: local-kubernetes
+
+---
+kind: Module
+description: mailhog service
+type: helm
+name: mailhog
+# version is not specified
+repo: https://codecentric.github.io/helm-charts
+chart: mailhog

core/test/integ/src/plugins/kubernetes/helm/config.ts

@@ -10,15 +10,20 @@ import { resolve } from "path"
 import { expect } from "chai"
 import { cloneDeep, omit } from "lodash"
 
-import { expectError, TestGarden } from "../../../../../helpers"
+import { expectError, getDataDir, makeTestGarden, TestGarden, withDefaultGlobalOpts } from "../../../../../helpers"
 import { PluginContext } from "../../../../../../src/plugin-context"
 import { dedent } from "../../../../../../src/util/string"
 import { ModuleConfig } from "../../../../../../src/config/module"
 import { apply } from "json-merge-patch"
 import { getHelmTestGarden } from "./common"
 import { defaultHelmTimeout } from "../../../../../../src/plugins/kubernetes/helm/module-config"
 import stripAnsi = require("strip-ansi")
-import { DEFAULT_BUILD_TIMEOUT_SEC, DEFAULT_DEPLOY_TIMEOUT_SEC, GardenApiVersion } from "../../../../../../src/constants"
+import {
+  DEFAULT_BUILD_TIMEOUT_SEC,
+  DEFAULT_DEPLOY_TIMEOUT_SEC,
+  GardenApiVersion,
+} from "../../../../../../src/constants"
+import { ValidateCommand } from "../../../../../../src/commands/validate"
 
 describe("configureHelmModule", () => {
   let garden: TestGarden
@@ -220,4 +225,16 @@ describe("configureHelmModule", () => {
       `)
     )
   })
+
+  it("should pass validation with a chart name but no version specified", async () => {
+    const projectRoot = getDataDir("test-projects", "helm-name-version-regression")
+    const g = await makeTestGarden(projectRoot)
+    const command = new ValidateCommand()
+    await command.action({
+      garden: g,
+      log: g.log,
+      args: {},
+      opts: withDefaultGlobalOpts({}),
+    })
+  })
 })

docs/reference/action-types/Deploy/helm.md

@@ -208,7 +208,7 @@ spec:
   # detected. If the chart is in the source tree but in a sub-directory, you should set `chart.path` to the directory
   # path, relative to the action directory.
   #
-  # If the chart is remote, you must specify `chart.name` and `chart.version\, and optionally `chart.repo` (if the
+  # If the chart is remote, you can specify `chart.name` and `chart.version\, and optionally `chart.repo` (if the
   # chart is not in the default "stable" repo).
   #
   # You may also specify an absolute URL to a packaged chart via `chart.url`.
@@ -804,7 +804,7 @@ Specify the Helm chart to use.
 
 If the chart is defined in the same directory as the action, you can skip this, and the chart sources will be detected. If the chart is in the source tree but in a sub-directory, you should set `chart.path` to the directory path, relative to the action directory.
 
-If the chart is remote, you must specify `chart.name` and `chart.version\, and optionally `chart.repo` (if the chart is not in the default "stable" repo).
+If the chart is remote, you can specify `chart.name` and `chart.version\, and optionally `chart.repo` (if the chart is not in the default "stable" repo).
 
 You may also specify an absolute URL to a packaged chart via `chart.url`.
 

docs/reference/action-types/Run/helm-pod.md

@@ -192,7 +192,7 @@ spec:
   # detected. If the chart is in the source tree but in a sub-directory, you should set `chart.path` to the directory
   # path, relative to the action directory.
   #
-  # If the chart is remote, you must specify `chart.name` and `chart.version\, and optionally `chart.repo` (if the
+  # If the chart is remote, you can specify `chart.name` and `chart.version\, and optionally `chart.repo` (if the
   # chart is not in the default "stable" repo).
   #
   # You may also specify an absolute URL to a packaged chart via `chart.url`.
@@ -658,7 +658,7 @@ Specify the Helm chart to use.
 
 If the chart is defined in the same directory as the action, you can skip this, and the chart sources will be detected. If the chart is in the source tree but in a sub-directory, you should set `chart.path` to the directory path, relative to the action directory.
 
-If the chart is remote, you must specify `chart.name` and `chart.version\, and optionally `chart.repo` (if the chart is not in the default "stable" repo).
+If the chart is remote, you can specify `chart.name` and `chart.version\, and optionally `chart.repo` (if the chart is not in the default "stable" repo).
 
 You may also specify an absolute URL to a packaged chart via `chart.url`.
 

docs/reference/action-types/Test/helm-pod.md

@@ -192,7 +192,7 @@ spec:
   # detected. If the chart is in the source tree but in a sub-directory, you should set `chart.path` to the directory
   # path, relative to the action directory.
   #
-  # If the chart is remote, you must specify `chart.name` and `chart.version\, and optionally `chart.repo` (if the
+  # If the chart is remote, you can specify `chart.name` and `chart.version\, and optionally `chart.repo` (if the
   # chart is not in the default "stable" repo).
   #
   # You may also specify an absolute URL to a packaged chart via `chart.url`.
@@ -658,7 +658,7 @@ Specify the Helm chart to use.
 
 If the chart is defined in the same directory as the action, you can skip this, and the chart sources will be detected. If the chart is in the source tree but in a sub-directory, you should set `chart.path` to the directory path, relative to the action directory.
 
-If the chart is remote, you must specify `chart.name` and `chart.version\, and optionally `chart.repo` (if the chart is not in the default "stable" repo).
+If the chart is remote, you can specify `chart.name` and `chart.version\, and optionally `chart.repo` (if the chart is not in the default "stable" repo).
 
 You may also specify an absolute URL to a packaged chart via `chart.url`.