feat: adds goreleaser (#112)

Adds config and GHA for GoReleaser. It is configured to build kubectl retina for [linux,windows,darwin]x[arm64,amd64] on tag. When a tag is published, it will build the matrix of binaries and create a GitHub release with a changelog, and attach the binaries as release artifacts. See https://github.com/rbtr/retina/releases/tag/v0.0.2 for sample release. Fixes #100 Signed-off-by: GitHub <[email protected]>
microsoft · Mar 21, 2024 · ae4bcde · ae4bcde
1 parent 0b8a44c
commit ae4bcde
Show file tree

Hide file tree

Showing 13 changed files with 115 additions and 133 deletions.
diff --git a/.github/workflows/golangci-lint.yaml b/.github/workflows/golangci-lint.yaml
@@ -2,29 +2,29 @@ name: golangci-lint
 on:
   workflow_dispatch:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
-    branches: [ main ]
+    branches: [main]
 jobs:
   golangci:
     strategy:
       fail-fast: false
       matrix:
-        go-version: ['1.21.x']
+        go-version: ["1.21.x"]
         os: [ubuntu-latest, windows-latest]
     name: Lint
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/setup-go@v5
-      with:
-        go-version: ${{ matrix.go-version }}
-    - uses: actions/checkout@v4
-      with:
-        fetch-depth: 0
-    - name: golangci-lint
-      uses: golangci/golangci-lint-action@v4
-      with:
-        version: v1.55
-        args: --concurrency 4 --verbose --config=.golangci.yaml --timeout=25m 
-        only-new-issues: true
-        skip-cache: true
+      - uses: actions/setup-go@v5
+        with:
+          go-version: ${{ matrix.go-version }}
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v4
+        with:
+          version: v1.55
+          args: --concurrency 4 --verbose --config=.golangci.yaml --timeout=25m
+          only-new-issues: true
+          skip-cache: true
diff --git a/.github/workflows/goreleaser.yaml b/.github/workflows/goreleaser.yaml
@@ -0,0 +1,50 @@
+name: goreleaser
+on:
+  pull_request:
+    branches: [main]
+  push:
+    tags: ["v*"]
+permissions:
+  contents: write
+  packages: write
+jobs:
+  build:
+    name: Build kubectl-retina
+    if: github.ref_type == 'branch'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Set up Go
+        uses: actions/setup-go@v4
+        with:
+          go-version: ">=1.21.0"
+      - name: Run GoReleaser build
+        uses: goreleaser/goreleaser-action@v5
+        with:
+          distribution: goreleaser
+          version: latest
+          args: build --snapshot --clean
+  release:
+    name: Release kubectl-retina
+    runs-on: ubuntu-latest
+    if: github.ref_type == 'tag'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Set up Go
+        uses: actions/setup-go@v4
+        with:
+          go-version: ">=1.21.0"
+      - name: Run GoReleaser release
+        uses: goreleaser/goreleaser-action@v5
+        with:
+          distribution: goreleaser
+          version: latest
+          args: release --clean
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/images.yaml b/.github/workflows/images.yaml
@@ -2,7 +2,7 @@ name: Build Retina Container Images
 
 on:
   pull_request:
-    branches: [ main ]
+    branches: [main]
 
 permissions:
   contents: read
@@ -58,7 +58,7 @@ jobs:
 
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3
-        
+
       - name: Build Images
         shell: bash
         run: |
@@ -88,42 +88,12 @@ jobs:
 
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3
-
-      - name: Build Images
-        shell: bash
-        run: |
-          set -euo pipefail
-          echo "TAG=$(make version)" >> $GITHUB_ENV
-          make retina-operator-image \
-            IMAGE_NAMESPACE=${{ github.repository }} \
-            PLATFORM=${{ matrix.platform }}/${{ matrix.arch }}
-
-  kubectl-retina-images:
-    name: Build kubectl-retina Images
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        platform: ["linux"]
-        arch: ["amd64", "arm64"]
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-
-      - uses: actions/setup-go@v4
-        with:
-          go-version: ">=1.21.0"
-      - run: go version
 
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v3
-
       - name: Build Images
         shell: bash
         run: |
           set -euo pipefail
           echo "TAG=$(make version)" >> $GITHUB_ENV
-          make kubectl-retina-image \
+          make retina-operator-image \
             IMAGE_NAMESPACE=${{ github.repository }} \
             PLATFORM=${{ matrix.platform }}/${{ matrix.arch }}
diff --git a/.github/workflows/release-images.yaml b/.github/workflows/release-images.yaml
@@ -112,40 +112,6 @@ jobs:
             PLATFORM=${{ matrix.platform }}/${{ matrix.arch }} \
             BUILDX_ACTION=--push
 
-  kubectl-retina-images:
-    name: Build kubectl-retina Images
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        platform: ["linux"]
-        arch: ["amd64", "arm64"]
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-
-      - uses: actions/setup-go@v4
-        with:
-          go-version: ">=1.21.0"
-      - run: go version
-
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v3
-
-      - name: Log in to registry
-        run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u $ --password-stdin
-
-      - name: Build/Push Images
-        shell: bash
-        run: |
-          set -euo pipefail
-          echo "TAG=$(make version)" >> $GITHUB_ENV
-          make kubectl-retina-image \
-            IMAGE_NAMESPACE=${{ github.repository }} \
-            PLATFORM=${{ matrix.platform }}/${{ matrix.arch }} \
-            BUILDX_ACTION=--push
-
   manifests:
     name: Generate Manifests
     runs-on: ubuntu-latest

diff --git a/.gitignore b/.gitignore
@@ -29,3 +29,5 @@ hack/tools/bin
 
 #vscode 
 .vscode/
+
+dist/
diff --git a/.goreleaser.yaml b/.goreleaser.yaml
@@ -0,0 +1,38 @@
+# yaml-language-server: $schema=https://goreleaser.com/static/schema.json
+# vim: set ts=2 sw=2 tw=0 fo=cnqoj
+
+version: 1
+
+before:
+  hooks:
+    # You may remove this if you don't use go modules.
+    - go mod tidy
+
+builds:
+  - binary: kubectl-retina-{{ .Os }}-{{ .Arch }}
+    env:
+      - CGO_ENABLED=0
+    goarch:
+      - amd64
+      - arm64
+    gcflags:
+      - -dwarflocationlists=true
+    goos:
+      - linux
+      - windows
+      - darwin
+    ldflags:
+      - -X cli/cmd.Version={{.Version}}
+    main: cli/main.go
+
+archives:
+  - format: binary
+    name_template: "{{ .Binary }}_{{ .Version }}"
+    wrap_in_directory: false
+
+changelog:
+  sort: asc
+  filters:
+    exclude:
+      - "^docs:"
+      - "^test:"
diff --git a/Makefile b/Makefile
@@ -148,16 +148,6 @@ retina-binary: ## build the Retina binary
 	export CGO_ENABLED=0
 	go build -v -o $(RETINA_BUILD_DIR)/retina$(EXE_EXT) -gcflags="-dwarflocationlists=true" -ldflags "-X main.version=$(TAG) -X main.applicationInsightsID=$(APP_INSIGHTS_ID)" $(RETINA_DIR)/main.go
 
-all-kubectl-retina: $(addprefix kubectl-retina-linux-,${ALL_ARCH.linux})  $(addprefix kubectl-retina-windows-,${ALL_ARCH.windows}) ## build kubectl plugin for all platforms
-
-kubectl-retina: # build kubectl plugin for current platform
-	if [ "$(BUILD_LOCALLY)" = "true" ]; then \
-		$(MAKE) kubectl-retina-binary-$(GOOS)-$(GOARCH); \
-	else \
-		$(MAKE) kubectl-retina-$(GOOS)-$(GOARCH); \
-	fi
-	cp $(KUBECTL_RETINA_BUILD_DIR)/kubectl-retina-$(GOOS)-$(GOARCH) $(KUBECTL_RETINA_BUILD_DIR)/kubectl-gadget
-
 kubectl-retina-binary-%: ## build kubectl plugin locally.
 	export CGO_ENABLED=0 && \
 	export GOOS=$(shell echo $* |cut -f1 -d-) GOARCH=$(shell echo $* |cut -f2 -d-) && \
@@ -167,21 +157,6 @@ kubectl-retina-binary-%: ## build kubectl plugin locally.
 		-ldflags "-X github.com/microsoft/retina/cli/cmd.Version=$(TAG)" \
 		github.com/microsoft/retina/cli
 
-kubectl-retina-%: ## build kubectl plugin
-	CONTAINER_BUILDER=docker $(MAKE) kubectl-retina-image
-#	copy the binary from the container image.
-	mkdir -p output/kubectl-retina
-	docker run --rm --platform=linux/amd64 \
-		--user $(shell id -u):$(shell id -g) \
-		-v $(PWD):/app \
-		$(IMAGE_REGISTRY)/$(KUBECTL_RETINA_IMAGE):$(RETINA_PLATFORM_TAG) \
-		sh -c "cp /bin/kubectl-retina /app/output/kubectl-retina/kubectl-gadget && cp /bin/kubectl-retina /app/output/kubectl-retina/kubectl-retina-$(GOOS)-$(GOARCH)"
-
-install-kubectl-retina: kubectl-retina ## install kubectl plugin
-	chmod +x $(KUBECTL_RETINA_BUILD_DIR)/kubectl-gadget
-	sudo cp $(KUBECTL_RETINA_BUILD_DIR)/kubectl-gadget /usr/local/bin/kubectl-retina
-	kubectl retina --help
-
 retina-capture-workload: ## build the Retina capture workload
 	cd $(CAPTURE_WORKLOAD_DIR) && CGO_ENABLED=0 go build -v -o $(RETINA_BUILD_DIR)/captureworkload$(EXE_EXT) -gcflags="-dwarflocationlists=true"  -ldflags "-X main.version=$(TAG)"
 
@@ -194,7 +169,6 @@ RETINA_BUILDER_IMAGE			= $(IMAGE_NAMESPACE)/retina-builder
 RETINA_TOOLS_IMAGE				= $(IMAGE_NAMESPACE)/retina-tools
 RETINA_IMAGE 					= $(IMAGE_NAMESPACE)/retina-agent
 RETINA_INIT_IMAGE				= $(IMAGE_NAMESPACE)/retina-init
-KUBECTL_RETINA_IMAGE			= $(IMAGE_NAMESPACE)/kubectl-retina
 RETINA_OPERATOR_IMAGE			= $(IMAGE_NAMESPACE)/retina-operator
 RETINA_INTEGRATION_TEST_IMAGE	= $(IMAGE_NAMESPACE)/retina-integration-test
 RETINA_PROTO_IMAGE				= $(IMAGE_NAMESPACE)/retina-proto-gen

diff --git a/cli/Dockerfile.kubectl-retina b/cli/Dockerfile.kubectl-retina
diff --git a/hack/tools/tools.go b/hack/tools/tools.go
@@ -15,6 +15,7 @@ package tools
 import (
 	_ "github.com/golang/mock/mockgen"
 	_ "github.com/golangci/golangci-lint/cmd/golangci-lint"
+	_ "github.com/goreleaser/goreleaser"
 	_ "github.com/onsi/ginkgo"
 	_ "mvdan.cc/gofumpt"
 	_ "sigs.k8s.io/controller-runtime/tools/setup-envtest"

diff --git a/...capture/provider/network_capture_linux.go → pkg/capture/provider/network_capture_unix.go b/...capture/provider/network_capture_linux.go → pkg/capture/provider/network_capture_unix.go
@@ -1,5 +1,4 @@
-//go:build linux
-// +build linux
+//go:build unix
 
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
@@ -111,7 +110,6 @@ func (ncp *NetworkCaptureProvider) CaptureNetworkPacket(filter string, duration,
 	}()
 
 	err = captureStartCmd.Start()
-
 	if err != nil {
 		ncp.l.Error("Failed to start tcpdump", zap.Error(err))
 		return err

diff --git a/pkg/capture/provider/network_capture_win.go b/pkg/capture/provider/network_capture_win.go
@@ -1,5 +1,4 @@
 //go:build windows
-// +build windows
 
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.

diff --git a/pkg/telemetry/heartbeat_linux.go → pkg/telemetry/heartbeat_unix.go b/pkg/telemetry/heartbeat_linux.go → pkg/telemetry/heartbeat_unix.go
@@ -1,3 +1,5 @@
+//go:build unix
+
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 

diff --git a/pkg/telemetry/heartbeat_linux_test.go → pkg/telemetry/heartbeat_unix_test.go b/pkg/telemetry/heartbeat_linux_test.go → pkg/telemetry/heartbeat_unix_test.go
@@ -1,3 +1,5 @@
+//go:build unix
+
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -29,3 +29,5 @@ hack/tools/bin

		#vscode
		.vscode/

		dist/