Merge pull request #2103 from sbueringer/pr-deprecate-auto-configure

🌱 Deprecate AutoConfigure functionality
kubernetes-sigs · Jul 28, 2023 · d55ab7f · d55ab7f
2 parents 64f7ddd + eb47894
commit d55ab7f
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 4 deletions.
diff --git a/.golangci.yml b/.golangci.yml
@@ -52,6 +52,11 @@ issue:
   max-per-linter: 0
 issues:
   exclude-rules:
+    # Specific exclude rules for deprecated fields that are still part of the codebase. These
+    # should be removed as the referenced deprecated item is removed from the project.
+    - linters:
+      - staticcheck
+      text: "SA1019: failureDomain.AutoConfigure is deprecated"
     - path: "test/e2e/*"
       linters:
         - gosec

diff --git a/apis/v1beta1/vspherefailuredomain_types.go b/apis/v1beta1/vspherefailuredomain_types.go
@@ -54,6 +54,8 @@ type FailureDomain struct {
 	TagCategory string `json:"tagCategory"`
 
 	// AutoConfigure tags the Type which is specified in the Topology
+	//
+	// Deprecated: This field is going to be removed in a future release.
 	AutoConfigure *bool `json:"autoConfigure,omitempty"`
 }
 

diff --git a/config/default/crd/bases/infrastructure.cluster.x-k8s.io_vspherefailuredomains.yaml b/config/default/crd/bases/infrastructure.cluster.x-k8s.io_vspherefailuredomains.yaml
@@ -283,8 +283,9 @@ spec:
                 description: Region defines the name and type of a region
                 properties:
                   autoConfigure:
-                    description: AutoConfigure tags the Type which is specified in
-                      the Topology
+                    description: "AutoConfigure tags the Type which is specified in
+                      the Topology \n Deprecated: This field is going to be removed
+                      in a future release."
                     type: boolean
                   name:
                     description: Name is the name of the tag that represents this
@@ -347,8 +348,9 @@ spec:
                 description: Zone defines the name and type of a zone
                 properties:
                   autoConfigure:
-                    description: AutoConfigure tags the Type which is specified in
-                      the Topology
+                    description: "AutoConfigure tags the Type which is specified in
+                      the Topology \n Deprecated: This field is going to be removed
+                      in a future release."
                     type: boolean
                   name:
                     description: Name is the name of the tag that represents this