From 1946a06424ab1fbca738cb5dd8548d5f3dceb6f5 Mon Sep 17 00:00:00 2001 From: Tejal Desai Date: Tue, 24 Sep 2019 13:59:37 -0700 Subject: [PATCH] add better docs for recreate pods --- docs/content/en/schemas/v1beta15.json | 4 ++-- pkg/skaffold/schema/latest/config.go | 3 ++- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/content/en/schemas/v1beta15.json b/docs/content/en/schemas/v1beta15.json index 7ae4640e71e..15910ea91df 100755 --- 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 true, Skaffold will send --recreate-pods 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 true, Skaffold will send --recreate-pods 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 index 97efdee1b77..386ece0c7c1 100644 --- 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"`