[chore]: fix deprecatedComment issues from gocritic (#4813)

Signed-off-by: Matthieu MOREL <matthieu.morel35@gmail.com>

Author: mmorel-35

.golangci.yaml

@@ -28,7 +28,6 @@ linters:
         - builtinShadow
         - commentedOutCode
         - deferInLoop
-        - deprecatedComment
         - elseif
         - emptyFallthrough
         - emptyStringTest
@@ -202,6 +201,9 @@ linters:
       - legacy
       - std-error-handling
     rules:
+      - linters:
+          - staticcheck
+        text: ".*.VolumeSizeLimit is deprecated:"
       - linters:
           - gosec
         path: _test\.go

apis/v1alpha1/instrumentation_types.go

@@ -163,6 +163,7 @@ type Java struct {
 
 	// VolumeSizeLimit defines size limit for volume used for auto-instrumentation.
 	// The default size is 200Mi.
+	//
 	// Deprecated: use spec.<lang>.volume.size instead. This field will be inactive in a future release.
 	VolumeSizeLimit *resource.Quantity `json:"volumeLimitSize,omitempty"`
 
@@ -202,6 +203,7 @@ type NodeJS struct {
 
 	// VolumeSizeLimit defines size limit for volume used for auto-instrumentation.
 	// The default size is 200Mi.
+	//
 	// Deprecated: use spec.<lang>.volume.size instead. This field will be inactive in a future release.
 	VolumeSizeLimit *resource.Quantity `json:"volumeLimitSize,omitempty"`
 
@@ -228,6 +230,7 @@ type Python struct {
 
 	// VolumeSizeLimit defines size limit for volume used for auto-instrumentation.
 	// The default size is 200Mi.
+	//
 	// Deprecated: use spec.<lang>.volume.size instead. This field will be inactive in a future release.
 	VolumeSizeLimit *resource.Quantity `json:"volumeLimitSize,omitempty"`
 
@@ -254,6 +257,7 @@ type DotNet struct {
 
 	// VolumeSizeLimit defines size limit for volume used for auto-instrumentation.
 	// The default size is 200Mi.
+	//
 	// Deprecated: use spec.<lang>.volume.size instead. This field will be inactive in a future release.
 	VolumeSizeLimit *resource.Quantity `json:"volumeLimitSize,omitempty"`
 
@@ -278,6 +282,7 @@ type Go struct {
 
 	// VolumeSizeLimit defines size limit for volume used for auto-instrumentation.
 	// The default size is 200Mi.
+	//
 	// Deprecated: use spec.<lang>.volume.size instead. This field will be inactive in a future release.
 	VolumeSizeLimit *resource.Quantity `json:"volumeLimitSize,omitempty"`
 
@@ -304,6 +309,7 @@ type ApacheHttpd struct {
 
 	// VolumeSizeLimit defines size limit for volume used for auto-instrumentation.
 	// The default size is 200Mi.
+	//
 	// Deprecated: use spec.<lang>.volume.size instead. This field will be inactive in a future release.
 	VolumeSizeLimit *resource.Quantity `json:"volumeLimitSize,omitempty"`
 
@@ -345,6 +351,7 @@ type Nginx struct {
 
 	// VolumeSizeLimit defines size limit for volume used for auto-instrumentation.
 	// The default size is 200Mi.
+	//
 	// Deprecated: use spec.<lang>.volume.size instead. This field will be inactive in a future release.
 	VolumeSizeLimit *resource.Quantity `json:"volumeLimitSize,omitempty"`
 

apis/v1alpha1/opentelemetrycollector_types.go

@@ -106,10 +106,12 @@ type OpenTelemetryCollectorSpec struct {
 	Replicas *int32 `json:"replicas,omitempty"`
 	// MinReplicas sets a lower bound to the autoscaling feature.  Set this if you are using autoscaling. It must be at least 1
 	// +optional
+	//
 	// Deprecated: use "OpenTelemetryCollector.Spec.Autoscaler.MinReplicas" instead.
 	MinReplicas *int32 `json:"minReplicas,omitempty"`
 	// MaxReplicas sets an upper bound to the autoscaling feature. If MaxReplicas is set autoscaling is enabled.
 	// +optional
+	//
 	// Deprecated: use "OpenTelemetryCollector.Spec.Autoscaler.MaxReplicas" instead.
 	MaxReplicas *int32 `json:"maxReplicas,omitempty"`
 	// Autoscaler specifies the pod autoscaling configuration to use
@@ -448,11 +450,13 @@ type OpenTelemetryCollectorStatus struct {
 	// Messages about actions performed by the operator on this resource.
 	// +optional
 	// +listType=atomic
+	//
 	// Deprecated: use Kubernetes events instead.
 	Messages []string `json:"messages,omitempty"`
 
 	// Replicas is currently not being set and might be removed in the next version.
 	// +optional
+	//
 	// Deprecated: use "OpenTelemetryCollector.Status.Scale.Replicas" instead.
 	Replicas int32 `json:"replicas,omitempty"`
 }

docs/api/instrumentations.md

@@ -271,6 +271,7 @@ If omitted, an emptyDir is used with size limit VolumeSizeLimit<br/>
         <td>
           VolumeSizeLimit defines size limit for volume used for auto-instrumentation.
 The default size is 200Mi.
+
 Deprecated: use spec.<lang>.volume.size instead. This field will be inactive in a future release.<br/>
         </td>
         <td>false</td>
@@ -1591,6 +1592,7 @@ If omitted, an emptyDir is used with size limit VolumeSizeLimit<br/>
         <td>
           VolumeSizeLimit defines size limit for volume used for auto-instrumentation.
 The default size is 200Mi.
+
 Deprecated: use spec.<lang>.volume.size instead. This field will be inactive in a future release.<br/>
         </td>
         <td>false</td>
@@ -2983,6 +2985,7 @@ If omitted, an emptyDir is used with size limit VolumeSizeLimit<br/>
         <td>
           VolumeSizeLimit defines size limit for volume used for auto-instrumentation.
 The default size is 200Mi.
+
 Deprecated: use spec.<lang>.volume.size instead. This field will be inactive in a future release.<br/>
         </td>
         <td>false</td>
@@ -3941,6 +3944,7 @@ If omitted, an emptyDir is used with size limit VolumeSizeLimit<br/>
         <td>
           VolumeSizeLimit defines size limit for volume used for auto-instrumentation.
 The default size is 200Mi.
+
 Deprecated: use spec.<lang>.volume.size instead. This field will be inactive in a future release.<br/>
         </td>
         <td>false</td>
@@ -4942,6 +4946,7 @@ If omitted, an emptyDir is used with size limit VolumeSizeLimit<br/>
         <td>
           VolumeSizeLimit defines size limit for volume used for auto-instrumentation.
 The default size is 200Mi.
+
 Deprecated: use spec.<lang>.volume.size instead. This field will be inactive in a future release.<br/>
         </td>
         <td>false</td>
@@ -6231,6 +6236,7 @@ If omitted, an emptyDir is used with size limit VolumeSizeLimit<br/>
         <td>
           VolumeSizeLimit defines size limit for volume used for auto-instrumentation.
 The default size is 200Mi.
+
 Deprecated: use spec.<lang>.volume.size instead. This field will be inactive in a future release.<br/>
         </td>
         <td>false</td>
@@ -7181,6 +7187,7 @@ If omitted, an emptyDir is used with size limit VolumeSizeLimit<br/>
         <td>
           VolumeSizeLimit defines size limit for volume used for auto-instrumentation.
 The default size is 200Mi.
+
 Deprecated: use spec.<lang>.volume.size instead. This field will be inactive in a future release.<br/>
         </td>
         <td>false</td>

docs/api/opentelemetrycollectors.md

@@ -237,6 +237,7 @@ It is only effective when healthcheckextension is configured in the OpenTelemetr
         <td>integer</td>
         <td>
           MaxReplicas sets an upper bound to the autoscaling feature. If MaxReplicas is set autoscaling is enabled.
+
 Deprecated: use "OpenTelemetryCollector.Spec.Autoscaler.MaxReplicas" instead.<br/>
           <br/>
             <i>Format</i>: int32<br/>
@@ -247,6 +248,7 @@ Deprecated: use "OpenTelemetryCollector.Spec.Autoscaler.MaxReplicas" instead.<br
         <td>integer</td>
         <td>
           MinReplicas sets a lower bound to the autoscaling feature.  Set this if you are using autoscaling. It must be at least 1
+
 Deprecated: use "OpenTelemetryCollector.Spec.Autoscaler.MinReplicas" instead.<br/>
           <br/>
             <i>Format</i>: int32<br/>
@@ -19955,6 +19957,7 @@ OpenTelemetryCollectorStatus defines the observed state of OpenTelemetryCollecto
         <td>[]string</td>
         <td>
           Messages about actions performed by the operator on this resource.
+
 Deprecated: use Kubernetes events instead.<br/>
         </td>
         <td>false</td>
@@ -19963,6 +19966,7 @@ Deprecated: use Kubernetes events instead.<br/>
         <td>integer</td>
         <td>
           Replicas is currently not being set and might be removed in the next version.
+
 Deprecated: use "OpenTelemetryCollector.Status.Scale.Replicas" instead.<br/>
           <br/>
             <i>Format</i>: int32<br/>

pkg/collector/upgrade/versions.go

@@ -11,13 +11,13 @@ import (
 )
 
 type (
-	// Deprecated use upgradeFuncV1beta1.
+	// Deprecated: use upgradeFuncV1beta1.
 	upgradeFunc        func(u VersionUpgrade, otelcol *v1alpha1.OpenTelemetryCollector) (*v1alpha1.OpenTelemetryCollector, error)
 	upgradeFuncV1beta1 func(u VersionUpgrade, otelcol *v1beta1.OpenTelemetryCollector) (*v1beta1.OpenTelemetryCollector, error)
 )
 
 type otelcolVersion struct {
-	// deprecated use upgradeV1beta1.
+	// Deprecated: use upgradeV1beta1.
 	upgrade        upgradeFunc
 	upgradeV1beta1 upgradeFuncV1beta1
 	semver.Version