Merge pull request #2937 from tejal29/add_better_recreate_docs

add better docs for recreate pods
GoogleContainerTools · Sep 25, 2019 · 78b3c71 · 78b3c71
2 parents 207ccf9 + 1946a06
commit 78b3c71
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/docs/content/en/schemas/v1beta15.json b/docs/content/en/schemas/v1beta15.json
@@ -1069,8 +1069,8 @@
         },
         "recreatePods": {
           "type": "boolean",
-          "description": "if `true`, Skaffold will send `--recreate-pods` flag to Helm CLI.",
-          "x-intellij-html-description": "if <code>true</code>, Skaffold will send <code>--recreate-pods</code> flag to Helm CLI.",
+          "description": "if `true`, Skaffold will send `--recreate-pods` flag to Helm CLI when upgrading a new version of a chart in subsequent dev loop deploy.",
+          "x-intellij-html-description": "if <code>true</code>, Skaffold will send <code>--recreate-pods</code> flag to Helm CLI when upgrading a new version of a chart in subsequent dev loop deploy.",
           "default": "false"
         },
         "remote": {

diff --git a/pkg/skaffold/schema/latest/config.go b/pkg/skaffold/schema/latest/config.go
@@ -471,7 +471,8 @@ type HelmRelease struct {
 	// Defaults to `false`.
 	Wait bool `yaml:"wait,omitempty"`
 
-	// RecreatePods if `true`, Skaffold will send `--recreate-pods` flag to Helm CLI.
+	// RecreatePods if `true`, Skaffold will send `--recreate-pods` flag to Helm CLI
+	// when upgrading a new version of a chart in subsequent dev loop deploy.
 	// Defaults to `false`.
 	RecreatePods bool `yaml:"recreatePods,omitempty"`