Implement CI to build release assets (#1)

This commit includes a number of fixes + enhancements all centered around making

`helm plugin install <repo>` functional and more robust.

Changes Included:
- Github actions for build + testing + compilation of release assets. Whenever a new release/tag is created, goreleaser will build the appropriate static libraries for all of the different architectures/operating systems.

- Tests the plugin install on all platforms using github actions

- Linting support for both golang and shell scripts to increase quality

- Enhancements to the local development makefile including a manual release process + dist packaging if actions based goreleaser is not desirable.

Signed-off-by: David Dobmeier <david.dobmeier@dcsg.com>

Author: daviddob

.github/workflows/ci.yaml

@@ -0,0 +1,98 @@
+---
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    name: "Build & Test"
+    if: "!contains(github.event.head_commit.message, '[ci skip]')"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version-file: 'go.mod'
+
+      - name: Install dependencies
+        run: make bootstrap
+
+      - name: Run unit tests
+        run: make test
+
+      - name: Verify installation
+        run: |
+          mkdir -p helmplugindir
+          make install HELM_3_PLUGINS=helmplugindir
+          helmplugindir/helm-set-status/bin/helm-set-status version
+
+  helm-install:
+    name: helm install
+    if: "!contains(github.event.head_commit.message, '[ci skip]')"
+    needs: [build]
+    runs-on: ${{ matrix.os }}
+    container: ${{ matrix.container }}
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        shell: [ default ]
+        experimental: [ false ]
+        helm-version: [ v3.17.2, v3.16.4 ]
+        include:
+          - os: windows-latest
+            shell: wsl
+            experimental: false
+            helm-version: v3.17.2
+          - os: windows-latest
+            shell: cygwin
+            experimental: false
+            helm-version: v3.17.2
+          - os: ubuntu-latest
+            container: alpine
+            shell: sh
+            experimental: false
+            helm-version: v3.17.2
+          - os: windows-latest
+            shell: wsl
+            experimental: false
+            helm-version: v3.16.4
+          - os: windows-latest
+            shell: cygwin
+            experimental: false
+            helm-version: v3.16.4
+          - os: ubuntu-latest
+            container: alpine
+            shell: sh
+            experimental: false
+            helm-version: v3.16.4
+
+    steps:
+      - name: Disable autocrlf
+        if: "contains(matrix.os, 'windows-latest')"
+        run: |-
+          git config --global core.autocrlf false
+          git config --global core.eol lf
+
+      - uses: actions/checkout@v4
+
+      - name: Setup Helm
+        uses: azure/setup-helm@v4
+        with:
+          version: ${{ matrix.helm-version }}
+
+      - name: Setup WSL
+        if: "contains(matrix.shell, 'wsl')"
+        uses: Vampire/setup-wsl@v5
+
+      - name: Setup Cygwin
+        if: "contains(matrix.shell, 'cygwin')"
+        uses: egor-tensin/setup-cygwin@v4
+
+      - name: helm plugin install
+        run: helm plugin install .

.github/workflows/lint-sh.yaml

@@ -0,0 +1,20 @@
+name: Lint sh
+
+on:
+  push:
+    branches: [main]
+    paths: ['scripts/install_plugin.sh']
+  pull_request:
+    branches: [main]
+    paths: ['scripts/install_plugin.sh']
+
+jobs:
+  lint-sh:
+    name: Lint scripts/install_plugin.sh
+    runs-on: ubuntu-latest
+    if: "!contains(github.event.head_commit.message, '[ci skip]')"
+    steps:
+      - uses: actions/checkout@v4
+      - uses: luizm/action-sh-checker@v0.9.0
+        with:
+          sh_checker_checkbashisms_enable: true

.github/workflows/lint.yaml

@@ -0,0 +1,24 @@
+---
+name: Lint
+
+on:
+  push:
+    branches: [ main ]
+    paths-ignore: [ '**.md' ]
+  pull_request:
+    branches: [ main ]
+    paths-ignore: [ '**.md' ]
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version-file: 'go.mod'
+      - uses: golangci/golangci-lint-action@v7
+        with:
+          version: v2.0.1 

.github/workflows/release.yaml

@@ -0,0 +1,36 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - '*'
+
+permissions:
+  contents: write
+
+jobs:
+  goreleaser:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        if: ${{ !startsWith(github.ref, 'refs/tags/v') }}
+        run: echo "flags=--snapshot" >> $GITHUB_ENV
+      -
+        name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      -
+        name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version-file: 'go.mod'
+      -
+        name: Run GoReleaser
+        uses: goreleaser/goreleaser-action@v6
+        with:
+          distribution: goreleaser
+          version: '~> v1'
+          args: release --clean ${{ env.flags }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -1,2 +1,6 @@
 /bin
 /dist
+/build
+/cover.out
+docker-run-release-cache/
+/release

.goreleaser.yml

@@ -0,0 +1,40 @@
+# To test this manually, run:
+#  go install github.com/goreleaser/goreleaser@latest
+#  goreleaser --snapshot --clean
+#  for f in dist/helm-set-status*.tgz; do echo Testing $f...; tar tzvf $f; done
+project_name: helm-set-status
+builds:
+  - id: default
+    main: ./cmd/helm-set-status
+    binary: bin/helm-set-status
+    env:
+      - CGO_ENABLED=0
+    flags:
+      - -trimpath
+    ldflags:
+      - -X main.version=${VERSION}
+    goos:
+      - freebsd
+      - darwin
+      - linux
+      - windows
+    goarch:
+      - amd64
+      - arm64
+
+archives:
+  - id: default
+    builds:
+    - default
+    format: tgz
+    name_template: '{{ .ProjectName }}-{{ if eq .Os "darwin" }}macos{{ else }}{{ .Os }}{{ end }}-{{ .Arch }}'
+    wrap_in_directory: helm-set-status
+    files:
+    - README.md
+    - plugin.yaml
+    - LICENSE
+changelog:
+  use: github-native
+
+release:
+  prerelease: auto

Makefile

@@ -1,35 +1,74 @@
+HELM_HOME ?= $(shell helm home)
 BINARY := helm-set-status
+VERSION := $(shell sed -n -e 's/version:[ "]*\([^"]*\).*/\1/p' plugin.yaml)
 
-HELM_PLUGIN := $(shell helm env | sed -n -e 's/HELM_PLUGINS=[ "]*\([^"]*\).*/\1/p')
-HELM_PLUGIN_PATH ?= $(HELM_PLUGIN)/$(BINARY)
+HELM_3_PLUGINS := $(shell helm env HELM_PLUGINS)
+LDFLAGS := -X main.version=${VERSION}
 
-VERSION := $(shell sed -n -e 's/version:[ "]*\([^"]*\).*/\1/p' plugin.yaml)
-LDFLAGS := "-X main.version=${VERSION} -extldflags -static -w -s"
-TAGS := "static_build netcgo osusergo"
-OS_PLATFORM := $(shell uname -sp | tr '[:upper:] ' '[:lower:]-' | sed 's/x86_64/amd64/')
+GO ?= go
 
-GO111MODULE = on
-CGO_ENABLED = 1
+.PHONY: format
+format:
+	test -z "$$(find . -type f -o -name '*.go' -exec gofmt -d {} + | tee /dev/stderr)" || \
+	test -z "$$(find . -type f -o -name '*.go' -exec gofmt -w {} + | tee /dev/stderr)"
 
 .PHONY: install
 install: build
-	[ -e $(HELM_PLUGIN_PATH) ] || mkdir -p $(HELM_PLUGIN_PATH)
-	cp bin/$(BINARY) $(HELM_PLUGIN_PATH)/
-	cp plugin.yaml $(HELM_PLUGIN_PATH)/
-
-.PHONY: package
-package: build
-	[ -e dist ] || mkdir -p dist
-	tar -czvf dist/$(BINARY)-$(OS_PLATFORM).tgz -C bin/ helm-set-status
-
-.PHONY: build
-build:
-	go build -o bin/$(BINARY) -tags $(TAGS) -ldflags $(LDFLAGS) ./cmd/helm-set-status
+	mkdir -p $(HELM_3_PLUGINS)/helm-set-status/bin
+	cp bin/$(BINARY) $(HELM_3_PLUGINS)/helm-set-status/bin
+	cp plugin.yaml $(HELM_3_PLUGINS)/helm-set-status/
 
 .PHONY: lint
 lint:
-	golangci-lint run -v ./pkg/... ./cmd/...
+	scripts/update-gofmt.sh
+	scripts/verify-gofmt.sh
+	scripts/verify-govet.sh
+	scripts/verify-staticcheck.sh
+
+.PHONY: build
+build: lint
+	mkdir -p bin/
+	go build -v -o bin/$(BINARY) -ldflags="$(LDFLAGS)" ./cmd/helm-set-status
 
 .PHONY: test
 test:
-	go test -v ./cmd/... ./pkg/...
+	go test -v ./... -coverprofile cover.out -race
+	go tool cover -func cover.out
+
+.PHONY: bootstrap
+bootstrap:
+	go mod download
+	command -v staticcheck || go install honnef.co/go/tools/cmd/staticcheck@latest
+
+.PHONY: dist
+dist: export COPYFILE_DISABLE=1 #teach OSX tar to not put ._* files in tar archive
+dist: export CGO_ENABLED=0
+dist:
+	rm -rf build/$(BINARY)/* release/*
+	mkdir -p build/$(BINARY)/bin release/
+	cp README.md LICENSE plugin.yaml build/$(BINARY)
+	GOOS=linux GOARCH=amd64 $(GO) build -o build/$(BINARY)/bin/$(BINARY) -trimpath -ldflags="$(LDFLAGS)" ./cmd/helm-set-status
+	tar -C build/ -zcvf $(CURDIR)/release/helm-set-status-linux-amd64.tgz $(BINARY)/
+	GOOS=linux GOARCH=arm64 $(GO) build -o build/$(BINARY)/bin/$(BINARY) -trimpath -ldflags="$(LDFLAGS)" ./cmd/helm-set-status
+	tar -C build/ -zcvf $(CURDIR)/release/helm-set-status-linux-arm64.tgz $(BINARY)/
+	GOOS=freebsd GOARCH=amd64 $(GO) build -o build/$(BINARY)/bin/$(BINARY) -trimpath -ldflags="$(LDFLAGS)" ./cmd/helm-set-status
+	tar -C build/ -zcvf $(CURDIR)/release/helm-set-status-freebsd-amd64.tgz $(BINARY)/
+	GOOS=darwin GOARCH=amd64 $(GO) build -o build/$(BINARY)/bin/$(BINARY) -trimpath -ldflags="$(LDFLAGS)" ./cmd/helm-set-status
+	tar -C build/ -zcvf $(CURDIR)/release/helm-set-status-macos-amd64.tgz $(BINARY)/
+	GOOS=darwin GOARCH=arm64 $(GO) build -o build/$(BINARY)/bin/$(BINARY) -trimpath -ldflags="$(LDFLAGS)" ./cmd/helm-set-status
+	tar -C build/ -zcvf $(CURDIR)/release/helm-set-status-macos-arm64.tgz $(BINARY)/
+	rm build/$(BINARY)/bin/$(BINARY)
+	GOOS=windows GOARCH=amd64 $(GO) build -o build/$(BINARY)/bin/$(BINARY).exe -trimpath -ldflags="$(LDFLAGS)" ./cmd/helm-set-status
+	tar -C build/ -zcvf $(CURDIR)/release/helm-set-status-windows-amd64.tgz $(BINARY)/
+	rm -rf build/
+
+# Manual release process - CI uses goreleaser to do multiarch compilation and release
+.PHONY: release
+release: lint dist
+	scripts/release.sh v$(VERSION)
+
+# Test for the plugin installation with `helm plugin install -v THIS_BRANCH` works
+# Useful for verifying modified `install-binary.sh` still works against various environments
+.PHONY: test-plugin-installation
+test-plugin-installation:
+	docker build -f testdata/Dockerfile.install .

cmd/helm-set-status/main.go

@@ -2,6 +2,7 @@ package main
 
 import (
 	"errors"
+	"fmt"
 	"io"
 	"os"
 
@@ -20,7 +21,10 @@ func NewRootCmd(out io.Writer, args []string) *cobra.Command {
 		SilenceUsage: true,
 		Args: func(cmd *cobra.Command, args []string) error {
 			if len(args) == 0 {
-				cmd.Help()
+				err := cmd.Help()
+				if err != nil {
+					fmt.Println("Unable to print help information")
+				}
 				os.Exit(1)
 			} else if len(args) != 2 {
 				return errors.New("release and status must be specified")
@@ -30,7 +34,10 @@ func NewRootCmd(out io.Writer, args []string) *cobra.Command {
 		RunE: runSetStatus,
 	}
 	flags := cmd.PersistentFlags()
-	flags.Parse(args)
+	err := flags.Parse(args)
+	if err != nil {
+		fmt.Println("Failed to parse arguments!")
+	}
 	settings = new(EnvSettings)
 	settings.AddFlags(flags)
 
@@ -68,6 +75,7 @@ func SetStatus(helmOptions common.HelmOptions, kubeConfig common.KubeConfig) err
 
 func main() {
 	setStatusCmd := NewRootCmd(os.Stdout, os.Args[1:])
+	setStatusCmd.AddCommand(newVersionCmd())
 
 	if err := setStatusCmd.Execute(); err != nil {
 		os.Exit(1)

cmd/helm-set-status/version.go

@@ -0,0 +1,20 @@
+package main
+
+import (
+	"fmt"
+
+	"github.com/spf13/cobra"
+)
+
+// Version identifier populated via the CI/CD process.
+var version = "HEAD"
+
+func newVersionCmd() *cobra.Command {
+	return &cobra.Command{
+		Use:   "version",
+		Short: "Show version of the helm diff plugin",
+		Run: func(*cobra.Command, []string) {
+			fmt.Println(version)
+		},
+	}
+}