chore: update makefile to use new build scripts

coder · deansheather · Jun 18, 2022 · Jun 7, 2022 · Jun 8, 2022 · Jun 8, 2022
commit 4885076fc57b7df7576cff53ca388d3c436d1aec
diff --git a/Makefile b/Makefile
@@ -1,15 +1,53 @@
 .DEFAULT_GOAL := build
 
+# use a single bash shell for each job, and immediately exit on failure
+SHELL := bash
+.SHELLFLAGS = -ceu
+.ONESHELL:
+
+# This doesn't work on directories.
+# See https://stackoverflow.com/questions/25752543/make-delete-on-error-for-directory-targets
+.DELETE_ON_ERROR:
+
 INSTALL_DIR=$(shell go env GOPATH)/bin
 GOOS=$(shell go env GOOS)
 GOARCH=$(shell go env GOARCH)
+VERSION=$(shell ./scripts/version.sh)
 
 bin: $(shell find . -not -path './vendor/*' -type f -name '*.go') go.mod go.sum $(shell find ./examples/templates)
-	@echo "== This builds binaries for command-line usage."
+	@echo "== This builds slim binaries for command-line usage."
 	@echo "== Use \"make build\" to embed the site."
-	goreleaser build --snapshot --rm-dist --single-target
 
-build: dist/artifacts.json
+	rm -rf ./dist/coder-slim_*
+	./scripts/build_go_slim.sh \
+		--version "$(VERSION)" \
+		--output ./dist/ \
+		linux:amd64,armv7,arm64 \
+		windows:amd64,arm64 \
+		darwin:amd64,arm64
+.PHONY: bin
+
+build: site/out/index.html $(shell find . -not -path './vendor/*' -type f -name '*.go') go.mod go.sum $(shell find ./examples/templates)
+	rm -rf ./dist
+	mkdir -p ./dist
+
+	# build slim artifacts and copy them to the site output directory
+	./scripts/build_go_slim.sh \
+		--version "$(VERSION)" \
+		--output ./dist/ \
+		linux:amd64,armv7,arm64 \
+		windows:amd64,arm64 \
+		darwin:amd64,arm64
+
+	# build not-so-slim artifacts with the default name format
+	./scripts/build_go_matrix.sh \
+		--version "$(VERSION)" \
+		--output ./dist/ \
+		--archive \
+		--package-linux \
+		linux:amd64,armv7,arm64 \
+		windows:amd64,arm64 \
+		darwin:amd64,arm64
 .PHONY: build
 
 # Runs migrations to output a dump of the database.
@@ -24,9 +62,6 @@ dev:
 	./scripts/develop.sh
 .PHONY: dev
 
-dist/artifacts.json: site/out/index.html $(shell find . -not -path './vendor/*' -type f -name '*.go') go.mod go.sum $(shell find ./examples/templates)
-	goreleaser release --snapshot --rm-dist --skip-sign
-
 fmt/prettier:
 	@echo "--- prettier"
 # Avoid writing files in CI to reduce file write activity
@@ -49,20 +84,34 @@ ifdef CI
 else
 	shfmt -w $(shell shfmt -f .)
 endif
+.PHONY: fmt/shfmt
 
 fmt: fmt/prettier fmt/terraform fmt/shfmt
 .PHONY: fmt
 
 gen: coderd/database/querier.go peerbroker/proto/peerbroker.pb.go provisionersdk/proto/provisioner.pb.go provisionerd/proto/provisionerd.pb.go site/src/api/typesGenerated.ts
+.PHONY: gen
+
+install: site/out/index.html $(shell find . -not -path './vendor/*' -type f -name '*.go') go.mod go.sum $(shell find ./examples/templates)
+	@output_file="$(INSTALL_DIR)/coder"
 
-install: build
-	mkdir -p $(INSTALL_DIR)
-	@echo "--- Copying from bin to $(INSTALL_DIR)"
-	cp -r ./dist/coder-$(GOOS)_$(GOOS)_$(GOARCH)*/* $(INSTALL_DIR)
-	@echo "-- CLI available at $(shell ls $(INSTALL_DIR)/coder*)"
+	@if [[ "$(GOOS)" == "windows" ]]; then
+		@output_file="$${output_file}.exe"
+	@fi
+
+	@echo "-- Building CLI for $(GOOS) $(GOARCH) at $$output_file"
+
+	./scripts/build_go.sh \
+		--version "$(VERSION)" \
+		--output "$$output_file" \
+		--os "$(GOOS)" \
+		--arch "$(GOARCH)"
+
+	@echo
 .PHONY: install
 
 lint: lint/shellcheck lint/go
+.PHONY: lint
 
 lint/go:
 	golangci-lint run
@@ -72,6 +121,7 @@ lint/go:
 lint/shellcheck: $(shell shfmt -f .)
 	@echo "--- shellcheck"
 	shellcheck --external-sources $(shell shfmt -f .)
+.PHONY: lint/shellcheck
 
 peerbroker/proto/peerbroker.pb.go: peerbroker/proto/peerbroker.proto
 	protoc \
@@ -108,19 +158,17 @@ site/src/api/typesGenerated.ts: scripts/apitypings/main.go $(shell find codersdk
 	go run scripts/apitypings/main.go > site/src/api/typesGenerated.ts
 	cd site && yarn run format:types
 
-.PHONY: test
 test: test-clean
 	gotestsum -- -v -short ./...
+.PHONY: test
 
-.PHONY: test-postgres
 test-postgres: test-clean
 	DB=ci gotestsum --junitfile="gotests.xml" --packages="./..." -- \
           -covermode=atomic -coverprofile="gotests.coverage" -timeout=5m \
           -coverpkg=./...,github.com/coder/coder/codersdk \
           -count=1 -parallel=1 -race -failfast
+.PHONY: test-postgres
 
-
-.PHONY: test-postgres-docker
 test-postgres-docker:
 	docker run \
 		--env POSTGRES_PASSWORD=postgres \
@@ -134,7 +182,8 @@ test-postgres-docker:
 		postgres:11 \
 		-c shared_buffers=1GB \
 		-c max_connections=1000
+.PHONY: test-postgres-docker
 
-.PHONY: test-clean
 test-clean:
 	go clean -testcache
+.PHONY: test-clean
diff --git a/scripts/build_go.sh b/scripts/build_go.sh
@@ -8,6 +8,9 @@
 # GOARCH and CODER_SLIM_BUILD=1. If no version is specified, defaults to the
 # version from ./version.sh.
 #
+# GOARM can be controlled by suffixing any arm architecture (i.e. arm or arm64)
+# with "vX" (e.g. "v7", "v8").
+#
 # Unless overridden via --output, the built binary will be dropped in
 # "$repo_root/dist/coder_$version_$os_$arch" (with a ".exe" suffix for windows
 # builds) and the absolute path to the binary will be printed to stdout on
@@ -95,8 +98,18 @@ if [[ "$output_path" == "" ]]; then
 fi
 build_args+=(-o "$output_path")
 
-# TODO: GOARM
-CGO_ENABLED=0 GOOS="$os" GOARCH="$arch" go build \
+# Determine GOARM.
+arm_version=""
+if [[ "$arch" == "arm" ]]; then
+	arm_version="7"
+elif [[ "$arch" == "armv"* ]] || [[ "$arch" == "arm64v"* ]]; then
+	arm_version="${arch//*v/}"
+
+	# Remove the v* suffix.
+	arch="${arch//v*/}"
+fi
+
+CGO_ENABLED=0 GOOS="$os" GOARCH="$arch" GOARM="$arm_version" go build \
 	"${build_args[@]}" \
 	./cmd/coder 1>&2
 

diff --git a/scripts/build_go_matrix.sh b/scripts/build_go_matrix.sh
@@ -51,9 +51,7 @@ while true; do
 		shift 2
 		;;
 	--output)
-		# realpath fails if the dir doesn't exist.
-		mkdir -p "$(dirname "$2")"
-		output_path="$(realpath "$2")"
+		output_path="$2"
 		shift 2
 		;;
 	--slim)
@@ -93,14 +91,16 @@ if [[ "$output_path" == "" ]]; then
 	mkdir -p dist
 	output_path="$(realpath "dist/coder_{version}_{os}_{arch}")"
 elif [[ "$output_path" == */ ]]; then
-	output_path="${output_path}coder_{version_{os}_{arch}"
-else
-	# Verify that it contains {os} and {arch} at least.
-	if [[ "$output_path" != *"{os}"* ]] || [[ "$output_path" != *"{arch}"* ]]; then
-		error "Templated output path '$output_path' must contain {os} and {arch}"
-	fi
+	output_path="${output_path}coder_{version}_{os}_{arch}"
+elif [[ "$output_path" != *"{os}"* ]] || [[ "$output_path" != *"{arch}"* ]]; then
+	# If the output path isn't a directory (ends with /) then it must have
+	# template variables.
+	error "Templated output path '$output_path' must contain {os} and {arch}"
 fi
 
+mkdir -p "$(dirname "$output_path")"
+output_path="$(realpath "$output_path")"
+
 # Remove the "v" prefix.
 version="${version#v}"
 if [[ "$version" == "" ]]; then

diff --git a/scripts/build_go_slim.sh b/scripts/build_go_slim.sh
@@ -0,0 +1,85 @@
+#!/usr/bin/env bash
+
+# This script builds multiple "slim" Go binaries for Coder with the given OS and
+# architecture combinations. This wraps ./build_go_matrix.sh.
+#
+# Usage: ./build_go_slim.sh [--version 1.2.3+devel.abcdef] [--output dist/] os1:arch1,arch2 os2:arch1 os1:arch3
+#
+# If no OS:arch combinations are provided, nothing will happen and no error will
+# be returned. If no version is specified, defaults to the version from
+# ./version.sh
+#
+# The --output parameter differs from ./build_go_matrix.sh, in that it does not
+# accept variables such as `{os}` and `{arch}` and only accepts a directory
+# ending with `/`.
+#
+# The built binaries are additionally copied to the site output directory so
+# they can be packaged into non-slim binaries correctly.
+
+set -euo pipefail
+# shellcheck source=scripts/lib.sh
+source "$(dirname "${BASH_SOURCE[0]}")/lib.sh"
+
+version=""
+output_path=""
+
+args="$(getopt -o "" -l version:,output: -- "$@")"
+eval set -- "$args"
+while true; do
+	case "$1" in
+	--version)
+		version="$2"
+		shift 2
+		;;
+	--output)
+		output_path="$2"
+		shift 2
+		;;
+	--)
+		shift
+		break
+		;;
+	*)
+		error "Unrecognized option: $1"
+		;;
+	esac
+done
+
+# Remove the "v" prefix.
+version="${version#v}"
+if [[ "$version" == "" ]]; then
+	version="$(execrelative ./version.sh)"
+fi
+
+# Verify the output path.
+if [[ "$output_path" == "" ]]; then
+	# Input paths are relative, so we don't cdroot at the top, but for this case
+	# we want it to be relative to the root.
+	cdroot
+	mkdir -p dist
+	output_path="$(realpath "dist/coder-slim_{version}_{os}_{arch}")"
+elif [[ "$output_path" != */ ]] || [[ "$output_path" == *"{"* ]]; then
+	error "The output path '$output_path' cannot contain variables and must end with a slash"
+else
+	mkdir -p "$output_path"
+	output_path="$(realpath "${output_path}coder-slim_{version}_{os}_{arch}")"
+fi
+
+./scripts/build_go_matrix.sh \
+	--version "$version" \
+	--output "$output_path" \
+	--slim \
+	"$@"
+
+cdroot
+dest_dir="./site/out/bin"
+mkdir -p "$dest_dir"
+dest_dir="$(realpath "$dest_dir")"
+
+# Copy the binaries to the site directory.
+cd "$(dirname "$output_path")"
+for f in ./coder-slim_*; do
+	f="${f#./}"
+	dest="$dest_dir/${f//-slim_$version/}"
+	cp "$f" "$dest"
+done
diff --git a/scripts/lib.sh b/scripts/lib.sh
@@ -1,6 +1,7 @@
 #!/usr/bin/env bash
 
 # This script is meant to be sourced by other scripts. To source this script:
+#     # shellcheck source=scripts/lib.sh
 #     source "$(dirname "${BASH_SOURCE[0]}")/lib.sh"
 
 set -euo pipefail