Merge pull request containerd#10151 from dmcgowan/move-proto-to-api

Add api Go module and move all protos under api

Author: fuweid

Makefile

@@ -109,7 +109,6 @@ SHIM_GO_LDFLAGS=-ldflags '-X $(PKG)/version.Version=$(VERSION) -X $(PKG)/version
 # Project packages.
 PACKAGES=$(shell $(GO) list ${GO_TAGS} ./... | grep -v /vendor/ | grep -v /integration)
 API_PACKAGES=$(shell (cd api && $(GO) list ${GO_TAGS} ./... | grep -v /vendor/ | grep -v /integration))
-NON_API_PACKAGES=$(shell $(GO) list ${GO_TAGS} ./... | grep -v /vendor/ | grep -v /integration | grep -v "containerd/api")
 TEST_REQUIRES_ROOT_PACKAGES=$(filter \
     ${PACKAGES}, \
     $(shell \
@@ -178,12 +177,10 @@ protos: bin/protoc-gen-go-fieldpath
 	$(eval TMPDIR := $(shell mktemp -d))
 	@mv ${ROOTDIR}/vendor ${TMPDIR}
 	@(cd ${ROOTDIR}/api && PATH="${ROOTDIR}/bin:${PATH}" protobuild --quiet ${API_PACKAGES})
-	@(PATH="${ROOTDIR}/bin:${PATH}" protobuild --quiet ${NON_API_PACKAGES})
-	find v2 -name '*.pb.go' -exec sh -c 'f={}; mkdir -p $$(dirname "$${f#v2/}"); echo mv $$f $${f#v2/}; mv $$f $${f#v2/}' \;
 	@mv ${TMPDIR}/vendor ${ROOTDIR}
 	@rm -rf ${TMPDIR} v2
-	go-fix-acronym -w -a '^Os' $(shell find api/ core/runtime/ -name '*.pb.go')
-	go-fix-acronym -w -a '(Id|Io|Uuid|Os)$$' $(shell find api/ core/runtime/ -name '*.pb.go')
+	go-fix-acronym -w -a '^Os' $(shell find api/ -name '*.pb.go')
+	go-fix-acronym -w -a '(Id|Io|Uuid|Os)$$' $(shell find api/ -name '*.pb.go')
 
 check-protos: protos ## check if protobufs needs to be generated again
 	@echo "$(WHALE) $@"
@@ -474,17 +471,18 @@ vendor: ## ensure all the go.mod/go.sum files are up-to-date including vendor/ d
 	@$(GO) mod tidy
 	@$(GO) mod vendor
 	@$(GO) mod verify
-	#@(cd ${ROOTDIR}/integration/client && ${GO} mod tidy)
+	@(cd ${ROOTDIR}/api && ${GO} mod tidy)
 
 verify-vendor: ## verify if all the go.mod/go.sum files are up-to-date
 	@echo "$(WHALE) $@"
 	$(eval TMPDIR := $(shell mktemp -d))
 	@cp -R ${ROOTDIR} ${TMPDIR}
 	@(cd ${TMPDIR}/containerd && ${GO} mod tidy)
-	@(cd ${TMPDIR}/containerd/integration/client && ${GO} mod tidy)
+	@(cd ${TMPDIR}/containerd && ${GO} mod vendor)
+	@(cd ${TMPDIR}/containerd && ${GO} mod verify)
+	@(cd ${TMPDIR}/containerd/api && ${GO} mod tidy)
 	@diff -r -u -q ${ROOTDIR} ${TMPDIR}/containerd
 	@rm -rf ${TMPDIR}
-	#@${ROOTDIR}/script/verify-go-modules.sh integration/client
 
 
 help: ## this help

Protobuild.toml

@@ -278,6 +278,36 @@ and new fields on messages may be added if they are optional.
 to the API by having a diff that the CI can run. These files are not intended to be
 consumed or used by clients.
 
+As of containerd 2.0, the API version diverges from the main containerd version.
+While containerd 2.0 is a _major_ version jump for containerd, the API will remain
+on 1.x to remain backwards compatible with prior releases and existing clients.
+The 2.0 release adds the API to a separate Go module which can remain as the
+`github.com/containerd/containerd/api` Go package and imported separately from the
+rest of containerd.
+
+The API minor version will continue to be incremented for each major and minor
+version release of containerd. However, the API is tagged directly out of the
+main branch with the minor version incrementing earlier in the next release cycle
+rather than at the end. This means that after the containerd 2.0 release, the next
+API change is tagged as `api/v1.9.0` prior to any containerd 2.1 release. The
+latest API version should be backported to all supported versions and patch
+releases for prior API versions should be avoided if possible.
+
+
+| Containerd Version | API Version at Release |
+|--------------------|------------------------|
+| v1.0               | 1.0                    |
+| v1.1               | 1.1                    |
+| v1.2               | 1.2                    |
+| v1.3               | 1.3                    |
+| v1.4               | 1.4                    |
+| v1.5               | 1.5                    |
+| v1.6               | 1.6                    |
+| v1.7               | 1.7                    |
+| v2.0               | 1.8                    |
+| next               | 1.9                    |
+
+
 ### Metrics API
 
 The metrics API that outputs prometheus style metrics will be versioned independently,

RELEASES.md

@@ -21,7 +21,7 @@ package containerd.events;
 import "google/protobuf/any.proto";
 import "github.com/containerd/containerd/api/types/fieldpath.proto";
 
-option go_package = "github.com/containerd/containerd/v2/api/events;events";
+option go_package = "github.com/containerd/containerd/api/events;events";
 option (containerd.types.fieldpath_all) = true;
 
 message ContainerCreate {

api/events/container.pb.go

@@ -20,7 +20,7 @@ package containerd.events;
 
 import "github.com/containerd/containerd/api/types/fieldpath.proto";
 
-option go_package = "github.com/containerd/containerd/v2/api/events;events";
+option go_package = "github.com/containerd/containerd/api/events;events";
 option (containerd.types.fieldpath_all) = true;
 
 message ContentDelete {

api/events/container.proto

@@ -20,7 +20,7 @@ package containerd.services.images.v1;
 
 import "github.com/containerd/containerd/api/types/fieldpath.proto";
 
-option go_package = "github.com/containerd/containerd/v2/api/events;events";
+option go_package = "github.com/containerd/containerd/api/events;events";
 option (containerd.types.fieldpath_all) = true;
 
 message ImageCreate {