Add deprecation notice to SkipCRDs attribute.

Signed-off-by: Alexander Berger <alex-berger@gmx.ch>
fluxcd · Apr 20, 2021 · e32e706 · e32e706
1 parent 614e849
commit e32e706
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 1 deletion.
diff --git a/api/v2beta1/helmrelease_types.go b/api/v2beta1/helmrelease_types.go
@@ -325,6 +325,10 @@ type Install struct {
 
 	// SkipCRDs tells the Helm install action to not install any CRDs. By default,
 	// CRDs are installed if not already present.
+	//
+	// Deprecated use CRD policy (`crds`) attribute with value `Skip` instead.
+	//
+	// +deprecated
 	// +optional
 	SkipCRDs bool `json:"skipCRDs,omitempty"`
 

diff --git a/config/crd/bases/helm.toolkit.fluxcd.io_helmreleases.yaml b/config/crd/bases/helm.toolkit.fluxcd.io_helmreleases.yaml
@@ -195,8 +195,10 @@ spec:
                       remains in the history.
                     type: boolean
                   skipCRDs:
-                    description: SkipCRDs tells the Helm install action to not install
+                    description: "SkipCRDs tells the Helm install action to not install
                       any CRDs. By default, CRDs are installed if not already present.
+                      \n Deprecated use CRD policy (`crds`) attribute with value `Skip`
+                      instead."
                     type: boolean
                   timeout:
                     description: Timeout is the time to wait for any individual Kubernetes

diff --git a/docs/api/helmrelease.md b/docs/api/helmrelease.md
@@ -1182,6 +1182,7 @@ bool
 <em>(Optional)</em>
 <p>SkipCRDs tells the Helm install action to not install any CRDs. By default,
 CRDs are installed if not already present.</p>
+<p>Deprecated use CRD policy (<code>crds</code>) attribute with value <code>Skip</code> instead.</p>
 </td>
 </tr>
 <tr>

diff --git a/docs/spec/v2beta1/helmreleases.md b/docs/spec/v2beta1/helmreleases.md
@@ -196,6 +196,10 @@ type Install struct {
 
 	// SkipCRDs tells the Helm install action to not install any CRDs. By default,
 	// CRDs are installed if not already present.
+	//
+	// Deprecated use CRD policy (`crds`) attribute with value `Skip` instead.
+	//
+	// +deprecated
 	// +optional
 	SkipCRDs bool `json:"skipCRDs,omitempty"`