golangci plugin for sorting feature gates #132438

dims · 2025-06-21T03:16:00Z

We have a bunch of files where we want the var or const block with a bunch of variables/constants that need to be in the correct order for longer term maintainability.

In this PR, we are adding a golangci based linter in the following files:

cmd/kubeadm/app/features/features.go
pkg/features/kube_features.go
staging/src/k8s.io/apiserver/pkg/features/kube_features.go
staging/src/k8s.io/client-go/features/known_features.go
staging/src/k8s.io/controller-manager/pkg/features/kube_features.go
staging/src/k8s.io/apiextensions-apiserver/pkg/features/kube_features.go
test/e2e/feature/feature.go
test/e2e/environment/environment.go

There is an additional commit that sorts all the above files as well to ensure a clean run of the linter for posterity.

What type of PR is this?

xref: #130779

/kind cleanup

What this PR does / why we need it:

Which issue(s) this PR is related to:

Special notes for your reviewer:

Does this PR introduce a user-facing change?

NONE

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

dims · 2025-06-21T11:51:15Z

/area code-organization

dims · 2025-06-21T11:51:23Z

/assign @aojea @pohly

dims · 2025-06-21T11:52:12Z

/priority important-soon

This is a good time to add this as we just had the enhancement freeze and we have about 30+ days before code freeze.

dims · 2025-06-25T13:30:37Z

/retest

dims · 2025-06-25T15:57:52Z

@pohly here's the output after i unsorted a few things in pkg/features/features.go

ERROR: pkg/features/kube_features.go:41:1: not sorted alphabetically:
ERROR:          // Allow kubelet to request a certificate without any Node IP available, only
ERROR:          // with DNS names.
ERROR:          AllowDNSOnlyNodeCSR = value
ERROR: -
ERROR: -        // owner: @krmayankk
ERROR: -        //
ERROR: -        // Enables maxUnavailable for StatefulSet
ERROR: -        MaxUnavailableStatefulSet = value
ERROR:
ERROR:          // owner: @micahhausler
ERROR:          //
ERROR: @@ -94,6 +89,12 @@
ERROR:          //
ERROR:          // Enable ClusterTrustBundle Kubelet projected volumes.  Depends on ClusterTrustBundle.
ERROR:          ClusterTrustBundleProjection = value
ERROR: +
ERROR: +        // owner: @adrianreber
ERROR: +        // kep: https://kep.k8s.io/2008
ERROR: +        //
ERROR: +        // Enables container Checkpoint support in the kubelet
ERROR: +        ContainerCheckpoint = value
ERROR:
ERROR:          // owner: @sreeram-venkitesh
ERROR:          //
ERROR: @@ -397,12 +398,6 @@
ERROR:          // Enable POD resources API to return resources allocated by Dynamic Resource Allocation
ERROR:          KubeletPodResourcesDynamicResources = value
ERROR:
ERROR: -        // owner: @adrianreber
ERROR: -        // kep: https://kep.k8s.io/2008
ERROR: -        //
ERROR: -        // Enables container Checkpoint support in the kubelet
ERROR: -        ContainerCheckpoint = value
ERROR: -
ERROR:          // owner: @moshe010
ERROR:          //
ERROR:          // Enable POD resources API with Get method
ERROR: @@ -476,6 +471,11 @@
ERROR:          //
ERROR:          // Enable merging key-value labels into LabelSelector corresponding to MatchLabelKeys in PodTopologySpread.
ERROR:          MatchLabelKeysInPodTopologySpreadSelectorMerge = value
ERROR: +
ERROR: +        // owner: @krmayankk
ERROR: +        //
ERROR: +        // Enables maxUnavailable for StatefulSet
ERROR: +        MaxUnavailableStatefulSet = value
ERROR:
ERROR:          // owner: @cynepco3hahue(alukiano) @cezaryzukowski @k-wiatrzyk, @Tal-or (only for GA graduation)
ERROR:          //
ERROR: Run hack/update-sortfeatures.sh to fix (sortedfeatures)
ERROR: const (
ERROR: ^
ERROR: pkg/features/kube_features.go:984:1: map 'defaultVersionedKubernetesFeatureGates' keys not sorted alphabetically:
ERROR:          ClusterTrustBundle: ...,
ERROR:          ClusterTrustBundleProjection: ...,
ERROR:          ContainerCheckpoint: ...,
ERROR: -        NodeLogQuery: ...,
ERROR:          ContainerStopSignals: ...,
ERROR:          CronJobsScheduledAnnotation: ...,
ERROR:          CrossNamespaceVolumeDataSource: ...,
ERROR: @@ -53,6 +52,7 @@
ERROR:          KubeletCgroupDriverFromCRI: ...,
ERROR:          KubeletCrashLoopBackOffMax: ...,
ERROR:          KubeletEnsureSecretPulledImages: ...,
ERROR: +        KubeletFineGrainedAuthz: ...,
ERROR:          KubeletInUserNamespace: ...,
ERROR:          KubeletPSI: ...,
ERROR:          KubeletPodResourcesDynamicResources: ...,
ERROR: @@ -70,12 +70,12 @@
ERROR:          MatchLabelKeysInPodTopologySpreadSelectorMerge: ...,
ERROR:          MaxUnavailableStatefulSet: ...,
ERROR:          MemoryManager: ...,
ERROR: -        KubeletFineGrainedAuthz: ...,
ERROR:          MemoryQoS: ...,
ERROR:          MultiCIDRServiceAllocator: ...,
ERROR:          MutableCSINodeAllocatableCount: ...,
ERROR:          NFTablesProxyMode: ...,
ERROR:          NodeInclusionPolicyInPodTopologySpread: ...,
ERROR: +        NodeLogQuery: ...,
ERROR:          NodeSwap: ...,
ERROR:          OrderedNamespaceDeletion: ...,
ERROR:          PodAndContainerStatsFromCRI: ...,
ERROR: Run hack/update-sortfeatures.sh to fix (sortedfeatures)

dims · 2025-06-25T15:58:49Z

@pohly please see output above. I think it is good enough to land now so i have removed the WIP. thanks!

yongruilin · 2025-06-26T20:17:28Z

/triage accepted

dims · 2025-06-27T01:36:12Z

/retest

cmd/sortfeatures/README.md

cmd/sortfeatures/main.go

pkg/features/kube_features.go

test/e2e/environment/environment.go

Signed-off-by: Davanum Srinivas <[email protected]>

pohly

/lgtm

pohly · 2025-06-27T16:44:05Z

hack/tools/golangci-lint/sortedfeatures/README.md

+
+## How It Works
+
+The linter analyzes const and var blocks in specified files, extracts feature declarations, and checks if they are


TODO (later): document support for maps.

pohly · 2025-06-27T16:45:24Z

hack/tools/golangci-lint/sortedfeatures/README.md

@@ -0,0 +1,137 @@
+# SortedFeatures Linter


TODO (later): remove the "feature" part of the linter and turn it into a generic "sorted" linter:

rename to "sorted"

remove all references to "feature" from the doc and code

pohly · 2025-06-27T16:48:43Z

hack/tools/golangci-lint/sortedfeatures/pkg/sortedfeatures.go

+	}
+
+	// Report the issue with the diff
+	pass.Reportf(decl.Pos(), "not sorted alphabetically:\n%s\n", stripHeader(diffText, 3))


TODO (later): "not sorted alphabetically (-got, +want):"

Example:

ERROR: test/e2e/feature/feature.go:27:1: not sorted alphabetically: ERROR: var ( ERROR: + // TODO: document the feature (owning SIG, when to use this feature for a test) ERROR: + APIServerIdentity = value ERROR: + ERROR: // Owner: sig-lifecycle ERROR: // This label is used for tests which need the following controllers to be enabled: ERROR: // - bootstrap-signer-controller ERROR: @@ -6,62 +9,11 @@ ERROR: BootstrapTokens = value ERROR: ERROR: // TODO: document the feature (owning SIG, when to use this feature for a test) ERROR: - APIServerIdentity = value ERROR: - ERROR: - // TODO: document the feature (owning SIG, when to use this feature for a test) ERROR: BoundServiceAccountTokenVolume = value ERROR: ERROR: // Owner: sig-api-machinery ERROR: // Marks tests that exercise the CBOR data format for serving or storage. ERROR: CBOR = value

k8s-ci-robot · 2025-06-27T16:51:23Z

LGTM label has been added.

Git tree hash: ef7b67b9237f9df0bff5032cfdc409799174fbcb

k8s-ci-robot · 2025-06-27T16:51:29Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dims, pohly

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~cmd/kubeadm/OWNERS~~ [dims]
~~hack/OWNERS~~ [dims,pohly]
~~pkg/features/OWNERS~~ [dims]
~~staging/src/k8s.io/apiextensions-apiserver/pkg/features/OWNERS~~ [dims]
~~staging/src/k8s.io/apiserver/pkg/features/OWNERS~~ [dims]
~~staging/src/k8s.io/client-go/OWNERS~~ [dims]
~~staging/src/k8s.io/controller-manager/pkg/features/OWNERS~~ [dims]
~~test/OWNERS~~ [dims,pohly]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

dims · 2025-06-27T17:50:43Z

/retest

dims · 2025-06-27T18:42:22Z

/retest

k8s-ci-robot requested review from caesarxuchao and jpbetz June 21, 2025 03:16

dims force-pushed the golangci-plugin-for-sorting-feature-gates branch from b16f761 to 2c847d2 Compare June 21, 2025 11:45

k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. and removed do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels Jun 21, 2025

dims changed the title ~~[WIP] golangci plugin for sorting feature gates~~ golangci plugin for sorting feature gates + sort feature gates in various files Jun 21, 2025

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jun 21, 2025

k8s-ci-robot added the area/code-organization Issues or PRs related to kubernetes code organization label Jun 21, 2025

k8s-ci-robot assigned aojea and pohly Jun 21, 2025

k8s-ci-robot added priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. and removed needs-priority Indicates a PR lacks a `priority/foo` label and requires one. labels Jun 21, 2025

dims force-pushed the golangci-plugin-for-sorting-feature-gates branch 2 times, most recently from 1bd4fde to 6dfdc9d Compare June 25, 2025 12:21

dims changed the title ~~[WIP] golangci plugin for sorting feature gates~~ golangci plugin for sorting feature gates Jun 25, 2025

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jun 25, 2025

dims force-pushed the golangci-plugin-for-sorting-feature-gates branch from 6dfdc9d to dc1015e Compare June 25, 2025 14:16

dims mentioned this pull request Jun 26, 2025

verify-featuregates.sh: include instructions in failure message #132553

Open

k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Jun 26, 2025

dims force-pushed the golangci-plugin-for-sorting-feature-gates branch from dc1015e to fd9b598 Compare June 27, 2025 00:34

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jun 27, 2025

pohly reviewed Jun 27, 2025

View reviewed changes

Add linter to report on unsorted feature gates

f2d8b7e

Signed-off-by: Davanum Srinivas <[email protected]>

dims force-pushed the golangci-plugin-for-sorting-feature-gates branch from 7211621 to 4e47e2c Compare June 27, 2025 15:07

Ensure all the files have the updated sorting

d50e1a6

Signed-off-by: Davanum Srinivas <[email protected]>

dims force-pushed the golangci-plugin-for-sorting-feature-gates branch from 4e47e2c to d50e1a6 Compare June 27, 2025 15:14

pohly approved these changes Jun 27, 2025

View reviewed changes

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 27, 2025

k8s-ci-robot merged commit 2e02a00 into kubernetes:master Jun 27, 2025
16 checks passed

k8s-ci-robot added this to the v1.34 milestone Jun 27, 2025

dims mentioned this pull request Jun 28, 2025

add alphabetization linter #130779

Closed


		## How It Works

		The linter analyzes const and var blocks in specified files, extracts feature declarations, and checks if they are

golangci plugin for sorting feature gates #132438

golangci plugin for sorting feature gates #132438

Uh oh!

Conversation

dims commented Jun 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR is related to:

Special notes for your reviewer:

Does this PR introduce a user-facing change?

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

Uh oh!

dims commented Jun 21, 2025

Uh oh!

dims commented Jun 21, 2025

Uh oh!

dims commented Jun 21, 2025

Uh oh!

dims commented Jun 25, 2025

Uh oh!

dims commented Jun 25, 2025

Uh oh!

dims commented Jun 25, 2025

Uh oh!

yongruilin commented Jun 26, 2025

Uh oh!

dims commented Jun 27, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pohly left a comment

Choose a reason for hiding this comment

Uh oh!

pohly Jun 27, 2025

Choose a reason for hiding this comment

Uh oh!

pohly Jun 27, 2025

Choose a reason for hiding this comment

Uh oh!

pohly Jun 27, 2025

Choose a reason for hiding this comment

Uh oh!

k8s-ci-robot commented Jun 27, 2025

Uh oh!

k8s-ci-robot commented Jun 27, 2025

Uh oh!

dims commented Jun 27, 2025

Uh oh!

dims commented Jun 27, 2025

Uh oh!

Uh oh!

Uh oh!

dims commented Jun 21, 2025 •

edited

Loading