Merge pull request #52790 from sttts/sttts-conversion-gen-vendor-independent

Automatic merge from submit-queue (batch tested with PRs 52477, 52790, 52798). If you want to cherry-pick this change to another branch, please follow the instructions <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/cherry-picks.md">here</a>.. conversion-gen: make staging dirs independent of living in vendor/ The `+k8s:conversion-gen` tags included the package directory inside of kube's vendor dir. This makes them invalid when we publish staging repos. Without this PR our sample-apiserver example code-generation is broken once published.
2025-07-24 04:06:03 +00:00 · 2017-09-20 15:43:45 -07:00 · 2017-09-20 15:43:45 -07:00 · 74ff323f9e
commit 74ff323f9e
parent 654c522e4c f545112751
12 changed files with 27 additions and 16 deletions
--- a/build/root/Makefile.generated_files
+++ b/build/root/Makefile.generated_files
@ -685,7 +685,8 @@ $(foreach dir, $(CONVERSION_DIRS),  \
    $(META_DIR)/$(dir)/$(CONVERSIONS_META)):
 	TAGS=$$(grep --color=never -h '^// *+k8s:conversion-gen=' $</*.go   \
 	    | cut -f2- -d=                                                  \
-	    | sed 's|$(PRJ_SRC_PATH)/||');                                  \
+	    | sed 's|$(PRJ_SRC_PATH)/||'                                    \
+	    | sed 's|^k8s.io/|vendor/k8s.io/|');                            \
 	mkdir -p $(@D);                                                     \
 	echo "conversions__$< := $$(echo $${TAGS})" >$@.tmp;                \
 	if ! cmp -s $@.tmp $@; then                                         \
--- a/staging/src/k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1beta1/doc.go
+++ b/staging/src/k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1beta1/doc.go
@ -15,7 +15,7 @@ limitations under the License.
 */

 // +k8s:deepcopy-gen=package,register
-// +k8s:conversion-gen=k8s.io/kubernetes/vendor/k8s.io/apiextensions-apiserver/pkg/apis/apiextensions
+// +k8s:conversion-gen=k8s.io/apiextensions-apiserver/pkg/apis/apiextensions
 // +k8s:defaulter-gen=TypeMeta

 // Package v1beta1 is the v1beta1 version of the API.
--- a/staging/src/k8s.io/apimachinery/pkg/apis/testapigroup/v1/doc.go
+++ b/staging/src/k8s.io/apimachinery/pkg/apis/testapigroup/v1/doc.go
@ -15,7 +15,7 @@ limitations under the License.
 */

 // +k8s:deepcopy-gen=package,register
-// +k8s:conversion-gen=k8s.io/kubernetes/vendor/k8s.io/apimachinery/pkg/apis/testapigroup
+// +k8s:conversion-gen=k8s.io/apimachinery/pkg/apis/testapigroup
 // +k8s:openapi-gen=false
 // +k8s:defaulter-gen=TypeMeta

--- a/staging/src/k8s.io/apiserver/pkg/apis/apiserver/v1alpha1/doc.go
+++ b/staging/src/k8s.io/apiserver/pkg/apis/apiserver/v1alpha1/doc.go
@ -15,7 +15,7 @@ limitations under the License.
 */

 // +k8s:deepcopy-gen=package,register
-// +k8s:conversion-gen=k8s.io/kubernetes/vendor/k8s.io/apiserver/pkg/apis/apiserver
+// +k8s:conversion-gen=k8s.io/apiserver/pkg/apis/apiserver
 // +k8s:defaulter-gen=TypeMeta

 // Package v1alpha1 is the v1alpha1 version of the API.
--- a/staging/src/k8s.io/apiserver/pkg/apis/audit/v1alpha1/doc.go
+++ b/staging/src/k8s.io/apiserver/pkg/apis/audit/v1alpha1/doc.go
@ -15,7 +15,7 @@ limitations under the License.
 */

 // +k8s:deepcopy-gen=package,register
-// +k8s:conversion-gen=k8s.io/kubernetes/vendor/k8s.io/apiserver/pkg/apis/audit
+// +k8s:conversion-gen=k8s.io/apiserver/pkg/apis/audit
 // +k8s:openapi-gen=true
 // +k8s:defaulter-gen=TypeMeta

--- a/staging/src/k8s.io/apiserver/pkg/apis/audit/v1beta1/doc.go
+++ b/staging/src/k8s.io/apiserver/pkg/apis/audit/v1beta1/doc.go
@ -15,7 +15,7 @@ limitations under the License.
 */

 // +k8s:deepcopy-gen=package,register
-// +k8s:conversion-gen=k8s.io/kubernetes/vendor/k8s.io/apiserver/pkg/apis/audit
+// +k8s:conversion-gen=k8s.io/apiserver/pkg/apis/audit
 // +k8s:openapi-gen=true
 // +k8s:defaulter-gen=TypeMeta

--- a/staging/src/k8s.io/apiserver/pkg/apis/example/v1/doc.go
+++ b/staging/src/k8s.io/apiserver/pkg/apis/example/v1/doc.go
@ -15,7 +15,7 @@ limitations under the License.
 */

 // +k8s:deepcopy-gen=package,register
-// +k8s:conversion-gen=k8s.io/kubernetes/vendor/k8s.io/apiserver/pkg/apis/example
+// +k8s:conversion-gen=k8s.io/apiserver/pkg/apis/example
 // +k8s:openapi-gen=false
 // +k8s:defaulter-gen=TypeMeta

--- a/staging/src/k8s.io/code-generator/cmd/conversion-gen/generators/conversion.go
+++ b/staging/src/k8s.io/code-generator/cmd/conversion-gen/generators/conversion.go
@ -284,10 +284,6 @@ func Packages(context *generator.Context, arguments *args.GeneratorArgs) generat
 			}
 			return pkg
 		}
-		fqPkgPath := pkg.Path
-		if strings.Contains(pkg.SourcePath, "/vendor/") {
-			fqPkgPath = filepath.Join("k8s.io", "kubernetes", "vendor", pkg.Path)
-		}
 		for i := range peerPkgs {
 			peerPkgs[i] = vendorless(peerPkgs[i])
 		}
@ -303,10 +299,24 @@ func Packages(context *generator.Context, arguments *args.GeneratorArgs) generat
 			unsafeEquality = noEquality{}
 		}

+		path := pkg.Path
+		// if the source path is within a /vendor/ directory (for example,
+		// k8s.io/kubernetes/vendor/k8s.io/apimachinery/pkg/apis/meta/v1), allow
+		// generation to output to the proper relative path (under vendor).
+		// Otherwise, the generator will create the file in the wrong location
+		// in the output directory.
+		// TODO: build a more fundamental concept in gengo for dealing with modifications
+		// to vendored packages.
+		if strings.HasPrefix(pkg.SourcePath, arguments.OutputBase) {
+			expandedPath := strings.TrimPrefix(pkg.SourcePath, arguments.OutputBase)
+			if strings.Contains(expandedPath, "/vendor/") {
+				path = expandedPath
+			}
+		}
 		packages = append(packages,
 			&generator.DefaultPackage{
 				PackageName: filepath.Base(pkg.Path),
-				PackagePath: fqPkgPath,
+				PackagePath: path,
 				HeaderText:  header,
 				GeneratorFunc: func(c *generator.Context) (generators []generator.Generator) {
 					return []generator.Generator{
--- a/staging/src/k8s.io/kube-aggregator/pkg/apis/apiregistration/v1beta1/doc.go
+++ b/staging/src/k8s.io/kube-aggregator/pkg/apis/apiregistration/v1beta1/doc.go
@ -15,7 +15,7 @@ limitations under the License.
 */

 // +k8s:deepcopy-gen=package,register
-// +k8s:conversion-gen=k8s.io/kubernetes/vendor/k8s.io/kube-aggregator/pkg/apis/apiregistration
+// +k8s:conversion-gen=k8s.io/kube-aggregator/pkg/apis/apiregistration
 // +k8s:openapi-gen=true

 // Package v1beta1 contains the API Registration API, which is responsible for
--- a/staging/src/k8s.io/metrics/pkg/apis/custom_metrics/v1beta1/doc.go
+++ b/staging/src/k8s.io/metrics/pkg/apis/custom_metrics/v1beta1/doc.go
@ -15,7 +15,7 @@ limitations under the License.
 */

 // +k8s:deepcopy-gen=package,register
-// +k8s:conversion-gen=k8s.io/kubernetes/vendor/k8s.io/metrics/pkg/apis/custom_metrics
+// +k8s:conversion-gen=k8s.io/metrics/pkg/apis/custom_metrics
 // +k8s:openapi-gen=true

 package v1beta1
--- a/staging/src/k8s.io/metrics/pkg/apis/metrics/v1alpha1/doc.go
+++ b/staging/src/k8s.io/metrics/pkg/apis/metrics/v1alpha1/doc.go
@ -15,7 +15,7 @@ limitations under the License.
 */

 // +k8s:deepcopy-gen=package,register
-// +k8s:conversion-gen=k8s.io/kubernetes/vendor/k8s.io/metrics/pkg/apis/metrics
+// +k8s:conversion-gen=k8s.io/metrics/pkg/apis/metrics
 // +k8s:openapi-gen=true

 package v1alpha1
--- a/staging/src/k8s.io/metrics/pkg/apis/metrics/v1beta1/doc.go
+++ b/staging/src/k8s.io/metrics/pkg/apis/metrics/v1beta1/doc.go
@ -15,7 +15,7 @@ limitations under the License.
 */

 // +k8s:deepcopy-gen=package,register
-// +k8s:conversion-gen=k8s.io/kubernetes/vendor/k8s.io/metrics/pkg/apis/metrics
+// +k8s:conversion-gen=k8s.io/metrics/pkg/apis/metrics
 // +k8s:openapi-gen=true

 package v1beta1