Merge pull request #16 from itaysk/goreleaser

use goreleaser

Author: itaysk

.gitignore

@@ -1,4 +1,3 @@
 .vscode
 dist
-krew
 kubectl-neat_*

.goreleaser.yml

@@ -0,0 +1,20 @@
+builds:
+- main: ./main.go
+  env:
+  - CGO_ENABLED=0
+  goos:
+    - darwin
+    - linux
+  goarch:
+    - amd64
+archives:
+- name_template: "{{ .ProjectName }}_{{ .Os }}"
+checksum:
+  name_template: 'checksums.txt'
+snapshot:
+  name_template: "{{ .Tag }}-next"
+changelog:
+  filters:
+    exclude:
+    - '^docs:'
+    - '^test:'

Makefile

@@ -1,46 +1,51 @@
 
-.PHONY: test test-unit test-component test-kubectl test-install build dist clean
+.PHONY: test test-unit test-component test-kubectl test-install build release clean
+os ?= $(shell uname -s | tr '[:upper:]' '[:lower:]')
 
 test: test-unit test-component test-kubectl test-install
 
 test-unit:
 	go test ./...
 
-test-component: dist
+test-component: kubectl-neat_$(os)
 	bats ./test/component.bats
 
-test-kubectl: dist
+test-kubectl: kubectl-neat_$(os)
 	bats ./test/kubectl.bats
 
-test-install: dist
+test-install: dist/kubectl-neat_$(os).tar.gz dist/checksums.txt
 	bats ./test/install.bats
 
-os ?= $(shell uname -s | tr '[:upper:]' '[:lower:]')
-dist: dist/$(os)
-
-dist/%: kubectl-neat_%
-	mkdir -p dist/$*
-	cp kubectl-neat_$* dist/$*/kubectl-neat
-
 build: kubectl-neat_$(os)
 
 SRC = $(shell find . -type f -name '*.go' -not -path "./vendor/*")
 kubectl-neat_%: $(SRC)
 	GOOS=$* go build -o $(@F)
 
-clean:
-	rm -rf ./dist ./krew
-	rm kubectl-neat*
-
-krew: dist/darwin dist/linux
-	mkdir -p ./krew
-	./krew-package.sh 'darwin' 'neat' 'krew'
-	./krew-package.sh 'linux' 'neat' 'krew'
-
+# release by default will not publish. run with `publish=1` to publish
+goreleaserflags = --skip-publish --snapshot
+ifdef publish
+	goreleaserflags =
+endif
+# relase always re-builds (no dependencies on purpose)
+release:
+	goreleaser --rm-dist $(goreleaserflags) 
+
+dist/kubectl-neat_darwin.tar.gz dist/kubectl-neat_linux.tar.gz dist/checksums.txt: release
+	# no op recipe
+	@:
+
+krew: dist/kubectl-neat_darwin.tar.gz dist/kubectl-neat_linux.tar.gz dist/checksums.txt
+	./krew-package.sh 'darwin' 'neat' './dist'
+	./krew-package.sh 'linux' 'neat' './dist'
 	# merge
-	yq r --tojson "krew/kubectl-neat_darwin.yaml" > krew/darwin.json
-	yq r --tojson "krew/kubectl-neat_linux.yaml" > krew/linux.json
-	rm krew/kubectl-neat_darwin.yaml krew/kubectl-neat_linux.yaml
-	jq --slurp '.[0].spec.platforms += .[1].spec.platforms | .[0]' 'krew/darwin.json' 'krew/linux.json' > 'krew/kubectl-neat.json'
-	yq r krew/kubectl-neat.json > krew/kubectl-neat.yaml
-	rm krew/kubectl-neat.json krew/darwin.json krew/linux.json
+	yq r --tojson "dist/kubectl-neat_darwin.yaml" > dist/darwin.json
+	yq r --tojson "dist/kubectl-neat_linux.yaml" > dist/linux.json
+	rm dist/kubectl-neat_darwin.yaml dist/kubectl-neat_linux.yaml
+	jq --slurp '.[0].spec.platforms += .[1].spec.platforms | .[0]' 'dist/darwin.json' 'dist/linux.json' > 'dist/kubectl-neat.json'
+	yq r dist/kubectl-neat.json > dist/kubectl-neat.yaml
+	rm dist/kubectl-neat.json dist/darwin.json dist/linux.json
+
+clean:
+	rm -rf dist
+	rm kubectl-neat*

krew-package.sh

@@ -1,16 +1,16 @@
 #! /bin/bash
 # This script makes a platform specific krew package
+# it assumes goreleaser had already run and created the archives and the checksums
 # Arguments:
 #   1. target os (`linux`/`darwin`)
 #   2. plugin name (rename the plugin in tests to avoid conflicts with existing installation)
-#   3. directory where to create artifacts
+#   3. path to goreleaser dist directory
 
 os="$1"
 plugin="$2"
 dir="$3"
 
-tar -czf "$dir/kubectl-neat_$os.tar.gz" "dist/$os"
-sha256=$(sha256sum "$dir/kubectl-neat_$os.tar.gz" | awk '{print $1}')
+sha256=$(grep "$os" "$dir/checksums.txt" | cut -f1 -d ' ')
 tmp="$dir/kubectl-${plugin}_${os}.json"
 yq r --tojson krew-template.yaml >"$tmp"
 jq 'delpaths([path(.spec.platforms[] | select( .selector.matchLabels.os != $os ))])' --arg os "$os" "$tmp" | sponge "$tmp"

krew-template.yaml

@@ -21,7 +21,7 @@ spec:
       uri: https://github.com/itaysk/kubectl-neat/releases/download/v1.0.0/kubectl-neat_darwin.tar.gz
       sha256: ${sha256}
       files:
-        - from: "/dist/darwin/*"
+        - from: "/*"
           to: "."
       bin: "./kubectl-neat"
     - selector:
@@ -31,6 +31,6 @@ spec:
       uri: https://github.com/itaysk/kubectl-neat/releases/download/v1.0.0/kubectl-neat_linux.tar.gz
       sha256: ${sha256}
       files:
-        - from: "/dist/linux/*"
+        - from: "/*"
           to: "."
       bin: "./kubectl-neat"

test/component.bats

@@ -1,6 +1,6 @@
 #!/usr/bin/env bats
 runtime_os=$(uname -s | tr '[:upper:]' '[:lower:]') 
-exe="dist/$runtime_os/kubectl-neat"
+exe="./kubectl-neat_${runtime_os}"
 
 @test "pod - json" {
     KUBECTL_OUTPUT=json run "$exe" <./test/fixtures/pod-1-raw.json

test/install.bats

@@ -1,11 +1,11 @@
 #!/usr/bin/env bats
 
 @test "krew install" {
-    dir=$(mktemp -d)
+    dir="dist"
     plugin="neat2"
     runtime_os=$(uname -s | tr '[:upper:]' '[:lower:]')
     ./krew-package.sh "$runtime_os" "$plugin" "$dir"
-    kubectl krew install --manifest="$dir/kubectl-${plugin}_${runtime_os}.yaml" --archive="$dir/kubectl-neat_$runtime_os.tar.gz"
+    kubectl krew install --manifest="$dir/kubectl-${plugin}_${runtime_os}.yaml" --archive="$dir/kubectl-neat_${runtime_os}.tar.gz"
 
     run kubectl "$plugin" svc kubernetes -oyaml
 

test/kubectl.bats

@@ -6,7 +6,7 @@ function setup() {
     # rename the plugin to avoid conflicts with existing installation
     plugin_name="neat2"
     plugin="$tmpdir"/kubectl-"$plugin_name"
-    ln -s "$(pwd)/dist/$runtime_os/kubectl-neat" "$plugin"
+    ln -s "$(pwd)/kubectl-neat_${runtime_os}" "$plugin"
     # PATH modification here has no external affect since bats runs in a subshell
     PATH="$PATH":"$tmpdir"
     kubectl delete -f ./test/fixtures/pod-1-neat.json 2>/dev/null || true