Sync main and api go module vendoring to fix go workspaces

Adds a target to the Makefile to do a 'go work sync' and ensure that the main and api modules are synced whenever we update dependencies. This makes it possible to work with go workspaces locally on developer machines. The target will be executed whenever a 'make update' is run.
openshift · Nov 19, 2024 · 9909930 · 9909930
1 parent 02a5fea
commit 9909930
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 1 deletion.
diff --git a/Makefile b/Makefile
@@ -21,6 +21,7 @@ PROMTOOL=$(abspath $(TOOLS_BIN_DIR)/promtool)
 
 GO_GCFLAGS ?= -gcflags=all='-N -l'
 GO=GO111MODULE=on GOWORK=off GOFLAGS=-mod=vendor go
+GOWS=GO111MODULE=on GOWORK=$(shell pwd)/hack/workspace/go.work GOFLAGS=-mod=vendor go
 GO_BUILD_RECIPE=CGO_ENABLED=1 $(GO) build $(GO_GCFLAGS)
 GO_CLI_RECIPE=CGO_ENABLED=0 $(GO) build $(GO_GCFLAGS) -ldflags '-extldflags "-static"'
 GO_E2E_RECIPE=CGO_ENABLED=1 $(GO) test $(GO_GCFLAGS) -tags e2e -c
@@ -50,7 +51,7 @@ pre-commit: all verify test
 build: hypershift-operator control-plane-operator control-plane-pki-operator hypershift product-cli
 
 .PHONY: update
-update: api-deps api api-docs deps clients
+update: workspace-sync api-deps api api-docs deps clients
 
 .PHONY: verify
 verify: update staticcheck fmt vet
@@ -240,6 +241,10 @@ api-deps:
 	  $(GO) mod verify && \
 	  $(GO) list -m -mod=readonly -json all > /dev/null
 
+.PHONY: workspace-sync
+workspace-sync:
+	cd hack/workspace && \
+	  $(GOWS) work sync
 
 # Run staticcheck
 # How to ignore failures https://staticcheck.io/docs/configuration#line-based-linter-directives

diff --git a/hack/workspace/.gitignore b/hack/workspace/.gitignore
@@ -0,0 +1,2 @@
+vendor
+go.work.sum
diff --git a/hack/workspace/go.work b/hack/workspace/go.work
@@ -0,0 +1,6 @@
+go 1.22.0
+
+use (
+	./hypershift
+	./hypershift/api
+)
diff --git a/hack/workspace/hypershift b/hack/workspace/hypershift
@@ -0,0 +1 @@
+../../.