Move 'Deprecated' comments to own paragraph

As described at https://go.dev/wiki/Deprecated, the `Deprecated` comments shall start a new paragraph. This way, the deprecation is also visible to other tools like staticcheck and vscode.

Signed-off-by: Martin Hoffmann <hoffimar@gmail.com>
Signed-off-by: Matheus Pimenta <matheuscscp@gmail.com>
This commit is contained in:
Martin Hoffmann 2024-05-31 14:30:44 +02:00 committed by Matheus Pimenta
parent bd9fad5238
commit 0887009d50
No known key found for this signature in database
GPG Key ID: 86D878C779EB9A95
5 changed files with 20 additions and 4 deletions

View File

@ -1045,11 +1045,13 @@ type HelmReleaseStatus struct {
// LastAttemptedValuesChecksum is the SHA1 checksum for the values of the last // LastAttemptedValuesChecksum is the SHA1 checksum for the values of the last
// reconciliation attempt. // reconciliation attempt.
//
// Deprecated: Use LastAttemptedConfigDigest instead. // Deprecated: Use LastAttemptedConfigDigest instead.
// +optional // +optional
LastAttemptedValuesChecksum string `json:"lastAttemptedValuesChecksum,omitempty"` LastAttemptedValuesChecksum string `json:"lastAttemptedValuesChecksum,omitempty"`
// LastReleaseRevision is the revision of the last successful Helm release. // LastReleaseRevision is the revision of the last successful Helm release.
//
// Deprecated: Use History instead. // Deprecated: Use History instead.
// +optional // +optional
LastReleaseRevision int `json:"lastReleaseRevision,omitempty"` LastReleaseRevision int `json:"lastReleaseRevision,omitempty"`

View File

@ -1205,6 +1205,7 @@ func (in *HelmRelease) SetConditions(conditions []metav1.Condition) {
} }
// GetStatusConditions returns a pointer to the Status.Conditions slice. // GetStatusConditions returns a pointer to the Status.Conditions slice.
//
// Deprecated: use GetConditions instead. // Deprecated: use GetConditions instead.
func (in *HelmRelease) GetStatusConditions() *[]metav1.Condition { func (in *HelmRelease) GetStatusConditions() *[]metav1.Condition {
return &in.Status.Conditions return &in.Status.Conditions

View File

@ -52,11 +52,13 @@ type Kustomize struct {
Patches []kustomize.Patch `json:"patches,omitempty"` Patches []kustomize.Patch `json:"patches,omitempty"`
// Strategic merge patches, defined as inline YAML objects. // Strategic merge patches, defined as inline YAML objects.
//
// Deprecated: use Patches instead. // Deprecated: use Patches instead.
// +optional // +optional
PatchesStrategicMerge []apiextensionsv1.JSON `json:"patchesStrategicMerge,omitempty"` PatchesStrategicMerge []apiextensionsv1.JSON `json:"patchesStrategicMerge,omitempty"`
// JSON 6902 patches, defined as inline YAML objects. // JSON 6902 patches, defined as inline YAML objects.
//
// Deprecated: use Patches instead. // Deprecated: use Patches instead.
// +optional // +optional
PatchesJSON6902 []kustomize.JSON6902Patch `json:"patchesJson6902,omitempty"` PatchesJSON6902 []kustomize.JSON6902Patch `json:"patchesJson6902,omitempty"`
@ -1011,6 +1013,7 @@ type HelmReleaseStatus struct {
// LastAppliedRevision is the revision of the last successfully applied // LastAppliedRevision is the revision of the last successfully applied
// source. // source.
//
// Deprecated: the revision can now be found in the History. // Deprecated: the revision can now be found in the History.
// +optional // +optional
LastAppliedRevision string `json:"lastAppliedRevision,omitempty"` LastAppliedRevision string `json:"lastAppliedRevision,omitempty"`
@ -1028,11 +1031,13 @@ type HelmReleaseStatus struct {
// LastAttemptedValuesChecksum is the SHA1 checksum for the values of the last // LastAttemptedValuesChecksum is the SHA1 checksum for the values of the last
// reconciliation attempt. // reconciliation attempt.
//
// Deprecated: Use LastAttemptedConfigDigest instead. // Deprecated: Use LastAttemptedConfigDigest instead.
// +optional // +optional
LastAttemptedValuesChecksum string `json:"lastAttemptedValuesChecksum,omitempty"` LastAttemptedValuesChecksum string `json:"lastAttemptedValuesChecksum,omitempty"`
// LastReleaseRevision is the revision of the last successful Helm release. // LastReleaseRevision is the revision of the last successful Helm release.
//
// Deprecated: Use History instead. // Deprecated: Use History instead.
// +optional // +optional
LastReleaseRevision int `json:"lastReleaseRevision,omitempty"` LastReleaseRevision int `json:"lastReleaseRevision,omitempty"`
@ -1266,6 +1271,7 @@ func (in *HelmRelease) SetConditions(conditions []metav1.Condition) {
} }
// GetStatusConditions returns a pointer to the Status.Conditions slice. // GetStatusConditions returns a pointer to the Status.Conditions slice.
//
// Deprecated: use GetConditions instead. // Deprecated: use GetConditions instead.
func (in *HelmRelease) GetStatusConditions() *[]metav1.Condition { func (in *HelmRelease) GetStatusConditions() *[]metav1.Condition {
return &in.Status.Conditions return &in.Status.Conditions

View File

@ -1147,6 +1147,7 @@ spec:
description: |- description: |-
LastAttemptedValuesChecksum is the SHA1 checksum for the values of the last LastAttemptedValuesChecksum is the SHA1 checksum for the values of the last
reconciliation attempt. reconciliation attempt.
Deprecated: Use LastAttemptedConfigDigest instead. Deprecated: Use LastAttemptedConfigDigest instead.
type: string type: string
lastHandledForceAt: lastHandledForceAt:
@ -1169,6 +1170,7 @@ spec:
lastReleaseRevision: lastReleaseRevision:
description: |- description: |-
LastReleaseRevision is the revision of the last successful Helm release. LastReleaseRevision is the revision of the last successful Helm release.
Deprecated: Use History instead. Deprecated: Use History instead.
type: integer type: integer
observedCommonMetadataDigest: observedCommonMetadataDigest:
@ -3021,6 +3023,7 @@ spec:
patchesJson6902: patchesJson6902:
description: |- description: |-
JSON 6902 patches, defined as inline YAML objects. JSON 6902 patches, defined as inline YAML objects.
Deprecated: use Patches instead. Deprecated: use Patches instead.
items: items:
description: JSON6902Patch contains a JSON6902 patch and description: JSON6902Patch contains a JSON6902 patch and
@ -3117,6 +3120,7 @@ spec:
patchesStrategicMerge: patchesStrategicMerge:
description: |- description: |-
Strategic merge patches, defined as inline YAML objects. Strategic merge patches, defined as inline YAML objects.
Deprecated: use Patches instead. Deprecated: use Patches instead.
items: items:
x-kubernetes-preserve-unknown-fields: true x-kubernetes-preserve-unknown-fields: true
@ -3626,6 +3630,7 @@ spec:
description: |- description: |-
LastAppliedRevision is the revision of the last successfully applied LastAppliedRevision is the revision of the last successfully applied
source. source.
Deprecated: the revision can now be found in the History. Deprecated: the revision can now be found in the History.
type: string type: string
lastAttemptedConfigDigest: lastAttemptedConfigDigest:
@ -3662,6 +3667,7 @@ spec:
description: |- description: |-
LastAttemptedValuesChecksum is the SHA1 checksum for the values of the last LastAttemptedValuesChecksum is the SHA1 checksum for the values of the last
reconciliation attempt. reconciliation attempt.
Deprecated: Use LastAttemptedConfigDigest instead. Deprecated: Use LastAttemptedConfigDigest instead.
type: string type: string
lastHandledForceAt: lastHandledForceAt:
@ -3683,6 +3689,7 @@ spec:
lastReleaseRevision: lastReleaseRevision:
description: |- description: |-
LastReleaseRevision is the revision of the last successful Helm release. LastReleaseRevision is the revision of the last successful Helm release.
Deprecated: Use History instead. Deprecated: Use History instead.
type: integer type: integer
observedGeneration: observedGeneration:

View File

@ -1694,8 +1694,8 @@ string
<td> <td>
<em>(Optional)</em> <em>(Optional)</em>
<p>LastAttemptedValuesChecksum is the SHA1 checksum for the values of the last <p>LastAttemptedValuesChecksum is the SHA1 checksum for the values of the last
reconciliation attempt. reconciliation attempt.</p>
Deprecated: Use LastAttemptedConfigDigest instead.</p> <p>Deprecated: Use LastAttemptedConfigDigest instead.</p>
</td> </td>
</tr> </tr>
<tr> <tr>
@ -1707,8 +1707,8 @@ int
</td> </td>
<td> <td>
<em>(Optional)</em> <em>(Optional)</em>
<p>LastReleaseRevision is the revision of the last successful Helm release. <p>LastReleaseRevision is the revision of the last successful Helm release.</p>
Deprecated: Use History instead.</p> <p>Deprecated: Use History instead.</p>
</td> </td>
</tr> </tr>
<tr> <tr>