ci: Update GoReleaser to cross compile with CGO (kptdev#3503)

This commit updates the release process to use the prebuilt container image from GoReleaser that contains the required C binaries/libraries for the targeted OS & ARCH that we want to release for.
droot · Aug 26, 2022 · 14562be · 14562be
1 parent 171d36b
commit 14562be
Show file tree

Hide file tree

Showing 3 changed files with 98 additions and 16 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -48,14 +48,16 @@ jobs:
       - name: Check Licenses
         run: |
           ./scripts/create-licenses.sh
-      - name: Run GoReleaser
-        uses: goreleaser/goreleaser-action@v2
-        id: run-goreleaser
-        with:
-          version: latest
-          args: release --skip-validate -f release/tag/goreleaser.yaml
+      - name: Setup release environment
+        id: setup-release-env
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |-
+          echo 'GITHUB_TOKEN=${{secrets.GORELEASER_ACCESS_TOKEN}}' > .release-env
+      - name: Run GoReleaser within Docker
+        id: run-goreleaser
+        run: |
+          make release
       - name: Generate SLSA subjects for provenance
         id: hash
         env:

diff --git a/Makefile b/Makefile
@@ -12,6 +12,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+GOLANG_VERSION         := 1.18.3
+GORELEASER_CONFIG      = release/tag/goreleaser.yaml
+GORELEASER_IMAGE       := ghcr.io/goreleaser/goreleaser-cross:v$(GOLANG_VERSION)
+
 .PHONY: docs license fix vet fmt lint test build tidy
 
 GOBIN := $(shell go env GOPATH)/bin
@@ -146,3 +150,30 @@ site-check:
 
 site-verify-examples: install-mdrip install-kind
 	./scripts/verifyExamples.sh
+
+release-dry-run:
+	@docker run \
+		--rm \
+		--privileged \
+		-v /var/run/docker.sock:/var/run/docker.sock \
+		-v `pwd`:/go/src/github.com/GoogleContainerTools/kpt \
+		-w /go/src/github.com/GoogleContainerTools/kpt \
+		$(GORELEASER_IMAGE) \
+		-f "$(GORELEASER_CONFIG)" \
+		--skip-validate --skip-publish
+
+release:
+	@if [ ! -f ".release-env" ]; then \
+		echo "\033[91m.release-env is required for release\033[0m";\
+		exit 1;\
+	fi
+	docker run \
+		--rm \
+		--privileged \
+		--env-file .release-env \
+		-v /var/run/docker.sock:/var/run/docker.sock \
+		-v `pwd`:/go/src/github.com/GoogleContainerTools/kpt \
+		-w /go/src/github.com/GoogleContainerTools/kpt \
+		$(GORELEASER_IMAGE) \
+		-f "$(GORELEASER_CONFIG)" release \
+		--skip-validate
diff --git a/release/tag/goreleaser.yaml b/release/tag/goreleaser.yaml
@@ -15,44 +15,93 @@
 # This defines the build for goreleaser (https://goreleaser.com/). It is
 # executed through a Github Action that is triggered by new tags being created
 # in the kpt repo.
+# As kpt needs to be compiled with CGO, we cannot simply just provide a simple
+# matrix of GOOS and GOARCH combinations, but instead, we'd need to define separate
+# steps for each targetted OS and ARCH. This is because we need to specify the
+# platform specific C std library (libc) and cross-compiler to be used.
+env:
+  - CGO_ENABLED=1
+  - GO111MODULE=on
 builds:
-  - env:
-      - CGO_ENABLED=0
-      - GO111MODULE=on
+  - id: darwin-amd64
     goos:
       - darwin
-      - linux
     goarch:
       - amd64
+    env:
+      - CC=o64-clang
+      - CXX=o64-clang++
+    ldflags: -s -w -X github.com/GoogleContainerTools/kpt/run.version={{.Version}}
+
+  - id: darwin-arm64
+    goos:
+      - darwin
+    goarch:
       - arm64
+    env:
+      - CC=oa64-clang
+      - CXX=oa64-clang++
     ldflags: -s -w -X github.com/GoogleContainerTools/kpt/run.version={{.Version}}
+
+  - id: linux-amd64
+    goos:
+      - linux
+    goarch:
+      - amd64
+    env:
+      - CC=x86_64-linux-gnu-gcc
+      - CXX=x86_64-linux-gnu-g++
+    ldflags: -s -w -X github.com/GoogleContainerTools/kpt/run.version={{.Version}}
+
+  - id: linux-arm64
+    goos:
+      - linux
+    goarch:
+      - arm64
+    env:
+      - CC=aarch64-linux-gnu-gcc
+      - CXX=aarch64-linux-gnu-g++
 dockers:
-  - image_templates:
+  - ids:
+      - linux-amd64
+    image_templates:
       - "gcr.io/kpt-dev/kpt:{{ .Tag }}"
     dockerfile: "release/images/Dockerfile"
-  - image_templates:
+  - ids:
+      - linux-amd64
+    image_templates:
       - "gcr.io/kpt-dev/kpt-gcloud:{{ .Tag }}"
     dockerfile: "release/images/Dockerfile-gcloud"
 archives:
   - id: archived
+    builds:
+      - darwin-amd64
+      - darwin-arm64
+      - linux-amd64
+      - linux-arm64
     files:
       - LICENSES*
       - lib.zip*
     name_template: "{{ .ProjectName }}_{{ .Os }}_{{ .Arch }}-{{ .Version }}"
   - id: bin-only
     format: binary
+    builds:
+      - darwin-amd64
+      - darwin-arm64
+      - linux-amd64
+      - linux-arm64
     name_template: "{{ .ProjectName }}_{{ .Os }}_{{ .Arch }}"
 checksum:
-  name_template: 'checksums.txt'
+  name_template: "checksums.txt"
 snapshot:
   name_template: "master"
 changelog:
   sort: asc
   filters:
     exclude:
-      - '(?i)^docs:'
-      - '(?i)^test:'
-      - '(?i)^regenerate docs'
+      - "(?i)^docs:"
+      - "(?i)^test:"
+      - "(?i)^regenerate docs"
       - Merge pull request
       - Merge branch
 release: