update golangci-lint to v2.5.0

Signed-off-by: dongjiang <[email protected]>

Author: dongjiang1989

.github/workflows/golangci-lint.yml

@@ -33,6 +33,6 @@ jobs:
       - name: golangci-lint
         uses: golangci/golangci-lint-action@4afd733a84b1f43292c63897423277bb7f4313a9 # tag=v8.0.0
         with:
-          version: v2.4.0
+          version: v2.5.0
           args: --output.text.print-linter-name=true --output.text.colors=true --timeout 10m
           working-directory: ${{matrix.working-directory}}

.golangci.yml

@@ -24,10 +24,12 @@ linters:
     - goconst
     - gocritic
     - gocyclo
+    - godoclint
     - goprintffuncname
     - govet
     - importas
     - ineffassign
+    - iotamixing
     - makezero
     - misspell
     - nakedret

pkg/applyconfiguration/doc.go

@@ -14,5 +14,5 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-// Package applyconfigurations generates types for constructing declarative apply configurations.
+// Package applyconfiguration generates types for constructing declarative apply configurations.
 package applyconfiguration

pkg/crd/known_types.go

@@ -13,6 +13,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */
+
 package crd
 
 import (

pkg/crd/markers/validation.go

@@ -164,95 +164,94 @@ func init() {
 	AllDefinitions = append(AllDefinitions, ValidationIshMarkers...)
 }
 
-// +controllertools:marker:generateHelp:category="CRD validation"
 // Maximum specifies the maximum numeric value that this field can have.
+// +controllertools:marker:generateHelp:category="CRD validation"
 type Maximum float64
 
 func (m Maximum) Value() float64 {
 	return float64(m)
 }
 
-// +controllertools:marker:generateHelp:category="CRD validation"
 // Minimum specifies the minimum numeric value that this field can have. Negative numbers are supported.
+// +controllertools:marker:generateHelp:category="CRD validation"
 type Minimum float64
 
 func (m Minimum) Value() float64 {
 	return float64(m)
 }
 
-// +controllertools:marker:generateHelp:category="CRD validation"
 // ExclusiveMinimum indicates that the minimum is "up to" but not including that value.
+// +controllertools:marker:generateHelp:category="CRD validation"
 type ExclusiveMinimum bool
 
-// +controllertools:marker:generateHelp:category="CRD validation"
 // ExclusiveMaximum indicates that the maximum is "up to" but not including that value.
+// +controllertools:marker:generateHelp:category="CRD validation"
 type ExclusiveMaximum bool
 
-// +controllertools:marker:generateHelp:category="CRD validation"
 // MultipleOf specifies that this field must have a numeric value that's a multiple of this one.
+// +controllertools:marker:generateHelp:category="CRD validation"
 type MultipleOf float64
 
 func (m MultipleOf) Value() float64 {
 	return float64(m)
 }
 
-// +controllertools:marker:generateHelp:category="CRD validation"
 // MaxLength specifies the maximum length for this string.
+// +controllertools:marker:generateHelp:category="CRD validation"
 type MaxLength int
 
-// +controllertools:marker:generateHelp:category="CRD validation"
 // MinLength specifies the minimum length for this string.
+// +controllertools:marker:generateHelp:category="CRD validation"
 type MinLength int
 
-// +controllertools:marker:generateHelp:category="CRD validation"
 // Pattern specifies that this string must match the given regular expression.
+// +controllertools:marker:generateHelp:category="CRD validation"
 type Pattern string
 
-// +controllertools:marker:generateHelp:category="CRD validation"
 // MaxItems specifies the maximum length for this list.
+// +controllertools:marker:generateHelp:category="CRD validation"
 type MaxItems int
 
-// +controllertools:marker:generateHelp:category="CRD validation"
 // MinItems specifies the minimum length for this list.
+// +controllertools:marker:generateHelp:category="CRD validation"
 type MinItems int
 
-// +controllertools:marker:generateHelp:category="CRD validation"
 // UniqueItems specifies that all items in this list must be unique.
+// +controllertools:marker:generateHelp:category="CRD validation"
 type UniqueItems bool
 
-// +controllertools:marker:generateHelp:category="CRD validation"
 // MaxProperties restricts the number of keys in an object
+// +controllertools:marker:generateHelp:category="CRD validation"
 type MaxProperties int
 
-// +controllertools:marker:generateHelp:category="CRD validation"
 // MinProperties restricts the number of keys in an object
+// +controllertools:marker:generateHelp:category="CRD validation"
 type MinProperties int
 
-// +controllertools:marker:generateHelp:category="CRD validation"
 // Enum specifies that this (scalar) field is restricted to the *exact* values specified here.
+// +controllertools:marker:generateHelp:category="CRD validation"
 type Enum []interface{}
 
-// +controllertools:marker:generateHelp:category="CRD validation"
 // Format specifies additional "complex" formatting for this field.
 //
 // For example, a date-time field would be marked as "type: string" and
 // "format: date-time".
+// +controllertools:marker:generateHelp:category="CRD validation"
 type Format string
 
-// +controllertools:marker:generateHelp:category="CRD validation"
 // Type overrides the type for this field (which defaults to the equivalent of the Go type).
 //
 // This generally must be paired with custom serialization.  For example, the
 // metav1.Time field would be marked as "type: string" and "format: date-time".
+// +controllertools:marker:generateHelp:category="CRD validation"
 type Type string
 
-// +controllertools:marker:generateHelp:category="CRD validation"
 // Nullable marks this field as allowing the "null" value.
 //
 // This is often not necessary, but may be helpful with custom serialization.
+// +controllertools:marker:generateHelp:category="CRD validation"
 type Nullable struct{}
 
-// +controllertools:marker:generateHelp:category="CRD validation"
 // Default sets the default value for this field.
 //
 // A default value will be accepted as any value valid for the
@@ -261,23 +260,23 @@ type Nullable struct{}
 // "delete"}`). Defaults should be defined in pruned form, and only best-effort
 // validation will be performed. Full validation of a default requires
 // submission of the containing CRD to an apiserver.
+// +controllertools:marker:generateHelp:category="CRD validation"
 type Default struct {
 	Value interface{}
 }
 
-// +controllertools:marker:generateHelp:category="CRD validation"
 // Title sets the title for this field.
 //
 // The title is metadata that makes the OpenAPI documentation more user-friendly,
 // making the schema more understandable when viewed in documentation tools.
 // It's a metadata field that doesn't affect validation but provides
 // important context about what the schema represents.
+// +controllertools:marker:generateHelp:category="CRD validation"
 type Title struct {
 	Value interface{}
 }
 
-// +controllertools:marker:generateHelp:category="CRD validation"
-// Default sets the default value for this field.
+// KubernetesDefault sets the default value for this field.
 //
 // A default value will be accepted as any value valid for the field.
 // Only JSON-formatted values are accepted. `ref(...)` values are ignored.
@@ -286,11 +285,11 @@ type Title struct {
 // "delete"}`). Defaults should be defined in pruned form, and only best-effort
 // validation will be performed. Full validation of a default requires
 // submission of the containing CRD to an apiserver.
+// +controllertools:marker:generateHelp:category="CRD validation"
 type KubernetesDefault struct {
 	Value interface{}
 }
 
-// +controllertools:marker:generateHelp:category="CRD validation"
 // Example sets the example value for this field.
 //
 // An example value will be accepted as any value valid for the
@@ -299,12 +298,12 @@ type KubernetesDefault struct {
 // "delete"}`). Examples should be defined in pruned form, and only best-effort
 // validation will be performed. Full validation of an example requires
 // submission of the containing CRD to an apiserver.
+// +controllertools:marker:generateHelp:category="CRD validation"
 type Example struct {
 	Value interface{}
 }
 
-// +controllertools:marker:generateHelp:category="CRD processing"
-// PreserveUnknownFields stops the apiserver from pruning fields which are not specified.
+// XPreserveUnknownFields stops the apiserver from pruning fields which are not specified.
 //
 // By default the apiserver drops unknown fields from the request payload
 // during the decoding step. This marker stops the API server from doing so.
@@ -316,33 +315,34 @@ type Example struct {
 // NB: The kubebuilder:validation:XPreserveUnknownFields variant is deprecated
 // in favor of the kubebuilder:pruning:PreserveUnknownFields variant.  They function
 // identically.
+// +controllertools:marker:generateHelp:category="CRD processing"
 type XPreserveUnknownFields struct{}
 
-// +controllertools:marker:generateHelp:category="CRD validation"
-// EmbeddedResource marks a fields as an embedded resource with apiVersion, kind and metadata fields.
+// XEmbeddedResource marks a fields as an embedded resource with apiVersion, kind and metadata fields.
 //
 // An embedded resource is a value that has apiVersion, kind and metadata fields.
 // They are validated implicitly according to the semantics of the currently
 // running apiserver. It is not necessary to add any additional schema for these
 // field, yet it is possible. This can be combined with PreserveUnknownFields.
+// +controllertools:marker:generateHelp:category="CRD validation"
 type XEmbeddedResource struct{}
 
-// +controllertools:marker:generateHelp:category="CRD validation"
-// IntOrString marks a fields as an IntOrString.
+// XIntOrString marks a fields as an IntOrString.
 //
 // This is required when applying patterns or other validations to an IntOrString
 // field. Known information about the type is applied during the collapse phase
 // and as such is not normally available during marker application.
+// +controllertools:marker:generateHelp:category="CRD validation"
 type XIntOrString struct{}
 
-// +controllertools:marker:generateHelp:category="CRD validation"
 // Schemaless marks a field as being a schemaless object.
 //
 // Schemaless objects are not introspected, so you must provide
 // any type and validation information yourself. One use for this
 // tag is for embedding fields that hold JSONSchema typed objects.
 // Because this field disables all type checking, it is recommended
 // to be used only as a last resort.
+// +controllertools:marker:generateHelp:category="CRD validation"
 type Schemaless struct{}
 
 func hasNumericType(schema *apiext.JSONSchemaProps) bool {
@@ -357,12 +357,12 @@ func isIntegral(value float64) bool {
 	return value == math.Trunc(value) && !math.IsNaN(value) && !math.IsInf(value, 0)
 }
 
-// +controllertools:marker:generateHelp:category="CRD validation"
 // XValidation marks a field as requiring a value for which a given
 // expression evaluates to true.
 //
 // This marker may be repeated to specify multiple expressions, all of
 // which must evaluate to true.
+// +controllertools:marker:generateHelp:category="CRD validation"
 type XValidation struct {
 	Rule              string
 	Message           string `marker:",optional"`
@@ -372,22 +372,22 @@ type XValidation struct {
 	OptionalOldSelf   *bool  `marker:"optionalOldSelf,optional"`
 }
 
-// +controllertools:marker:generateHelp:category="CRD validation"
 // AtMostOneOf adds a validation constraint that allows at most one of the specified fields.
 //
 // This marker may be repeated to specify multiple AtMostOneOf constraints that are mutually exclusive.
+// +controllertools:marker:generateHelp:category="CRD validation"
 type AtMostOneOf []string
 
-// +controllertools:marker:generateHelp:category="CRD validation"
 // ExactlyOneOf adds a validation constraint that allows at exactly one of the specified fields.
 //
 // This marker may be repeated to specify multiple ExactlyOneOf constraints that are mutually exclusive.
+// +controllertools:marker:generateHelp:category="CRD validation"
 type ExactlyOneOf []string
 
-// +controllertools:marker:generateHelp:category="CRD validation"
 // AtLeastOneOf adds a validation constraint that allows at least one of the specified fields.
 //
 // This marker may be repeated to specify multiple AtLeastOneOf constraints that are mutually exclusive.
+// +controllertools:marker:generateHelp:category="CRD validation"
 type AtLeastOneOf []string
 
 func (m Maximum) ApplyToSchema(schema *apiext.JSONSchemaProps) error {
@@ -561,7 +561,7 @@ func (m Nullable) ApplyToSchema(schema *apiext.JSONSchemaProps) error {
 	return nil
 }
 
-// Defaults are only valid CRDs created with the v1 API
+// ApplyToSchema defaults are only valid CRDs created with the v1 API
 func (m Default) ApplyToSchema(schema *apiext.JSONSchemaProps) error {
 	marshalledDefault, err := json.Marshal(m.Value)
 	if err != nil {
@@ -601,7 +601,7 @@ func (m *KubernetesDefault) ParseMarker(_ string, _ string, restFields string) e
 	return json.Unmarshal([]byte(restFields), &m.Value)
 }
 
-// Defaults are only valid CRDs created with the v1 API
+// ApplyToSchema defaults are only valid CRDs created with the v1 API
 func (m KubernetesDefault) ApplyToSchema(schema *apiext.JSONSchemaProps) error {
 	if m.Value == nil {
 		// only apply to the schema if we have a non-nil default value

pkg/crd/spec.go

@@ -13,6 +13,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */
+
 package crd
 
 import (

pkg/deepcopy/traverse.go

@@ -61,7 +61,7 @@ func (c *codeWriter) If(setup string, block func()) {
 	c.Line("}")
 }
 
-// If writes if and else statements with the given setup/condition clause, executing
+// IfElse writes if and else statements with the given setup/condition clause, executing
 // the given functions to write the contents of the blocks.
 func (c *codeWriter) IfElse(setup string, ifBlock func(), elseBlock func()) {
 	c.Linef("if %s {", setup)

pkg/markers/parse.go

@@ -80,7 +80,7 @@ type RawArguments []byte
 type ArgumentType int
 
 const (
-	// Invalid represents a type that can't be parsed, and should never be used.
+	// InvalidType represents a type that can't be parsed, and should never be used.
 	InvalidType ArgumentType = iota
 	// IntType is an int
 	IntType