Merge pull request #12032 from sbueringer/pr-move-compat-version

🌱 Move contract version & GetCompatibleVersions to contract package

Author: k8s-ci-robot

cmd/clusterctl/client/client.go

@@ -27,6 +27,7 @@ import (
 	"sigs.k8s.io/cluster-api/cmd/clusterctl/client/config"
 	"sigs.k8s.io/cluster-api/cmd/clusterctl/client/repository"
 	"sigs.k8s.io/cluster-api/cmd/clusterctl/client/tree"
+	"sigs.k8s.io/cluster-api/internal/contract"
 )
 
 // Client is exposes the clusterctl high-level client library.
@@ -178,8 +179,8 @@ func New(ctx context.Context, path string, options ...Option) (Client, error) {
 
 func newClusterctlClient(ctx context.Context, path string, options ...Option) (*clusterctlClient, error) {
 	client := &clusterctlClient{
-		currentContractVersion:        cluster.CurrentContractVersion,
-		getCompatibleContractVersions: cluster.GetCompatibleContractVersions,
+		currentContractVersion:        contract.Version,
+		getCompatibleContractVersions: contract.GetCompatibleVersions,
 	}
 	for _, o := range options {
 		o(client)

cmd/clusterctl/client/cluster/client.go

@@ -24,31 +24,13 @@ import (
 	"k8s.io/apimachinery/pkg/util/sets"
 	"k8s.io/apimachinery/pkg/util/wait"
 
-	clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
 	"sigs.k8s.io/cluster-api/cmd/clusterctl/client/config"
 	"sigs.k8s.io/cluster-api/cmd/clusterctl/client/repository"
 	yaml "sigs.k8s.io/cluster-api/cmd/clusterctl/client/yamlprocessor"
 	logf "sigs.k8s.io/cluster-api/cmd/clusterctl/log"
+	"sigs.k8s.io/cluster-api/internal/contract"
 )
 
-var (
-	// CurrentContractVersion is the contract version supported by this Cluster API version.
-	// Note: Each Cluster API version supports one contract version, and by convention the contract version matches the current API version.
-	CurrentContractVersion = clusterv1.GroupVersion.Version
-)
-
-// GetCompatibleContractVersions return the list of contract version compatible with a given contract version.
-// NOTE: A contract version might be temporarily compatible with older contract versions e.g. to allow users time to transition to the new API.
-// NOTE: The return value must include also the contract version received in input.
-func GetCompatibleContractVersions(contract string) sets.Set[string] {
-	compatibleContracts := sets.New(contract)
-	// v1beta2 contract is temporarily be compatible with v1beta1 (until v1beta1 is EOL).
-	if contract == "v1beta2" {
-		compatibleContracts.Insert("v1beta1")
-	}
-	return compatibleContracts
-}
-
 // Kubeconfig is a type that specifies inputs related to the actual
 // kubeconfig.
 type Kubeconfig struct {
@@ -233,8 +215,8 @@ func newClusterClient(kubeconfig Kubeconfig, configClient config.Client, options
 		configClient:                  configClient,
 		kubeconfig:                    kubeconfig,
 		processor:                     yaml.NewSimpleProcessor(),
-		currentContractVersion:        CurrentContractVersion,
-		getCompatibleContractVersions: GetCompatibleContractVersions,
+		currentContractVersion:        contract.Version,
+		getCompatibleContractVersions: contract.GetCompatibleVersions,
 	}
 	for _, o := range options {
 		o(client)

internal/contract/version.go

@@ -0,0 +1,41 @@
+/*
+Copyright 2025 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+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 contract
+
+import (
+	"k8s.io/apimachinery/pkg/util/sets"
+
+	clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
+)
+
+var (
+	// Version is the contract version supported by this Cluster API version.
+	// Note: Each Cluster API version supports one contract version, and by convention the contract version matches the current API version.
+	Version = clusterv1.GroupVersion.Version
+)
+
+// GetCompatibleVersions return the list of contract version compatible with a given contract version.
+// NOTE: A contract version might be temporarily compatible with older contract versions e.g. to allow users time to transition to the new API.
+// NOTE: The return value must include also the contract version received in input.
+func GetCompatibleVersions(contract string) sets.Set[string] {
+	compatibleContracts := sets.New(contract)
+	// v1beta2 contract is temporarily be compatible with v1beta1 (until v1beta1 is EOL).
+	if contract == "v1beta2" {
+		compatibleContracts.Insert("v1beta1")
+	}
+	return compatibleContracts
+}