chore: write build_go.sh script and dependencies

coder · deansheather · Jun 18, 2022 · Jun 7, 2022 · Jun 8, 2022 · Jun 8, 2022
commit bc06a6f902b03b0d21e51f290257da8994661de4
diff --git a/scripts/build_go.sh b/scripts/build_go.sh
@@ -0,0 +1,91 @@
+#!/usr/bin/env bash
+
+# This script builds a single Go binary of Coder with the given parameters.
+#
+# Usage: ./build_go.sh [--version v1.2.3+devel.abcdef] [--os linux] [--arch amd64] [--output path/to/output] [--slim]
+#
+# Defaults to linux:amd64 with slim disabled, but can be controlled with GOOS,
+# GOARCH and CODER_SLIM_BUILD=1. If no version is specified, defaults to the
+# version from ./version.sh.
+#
+# Unless overridden via --output, the built binary will be dropped in
+# "$repo_root/dist/coder(-slim)?_$version_$os_$arch" (with a ".exe" suffix for
+# windows builds) and the absolute path to the binary will be printed to stdout
+# on completion.
+
+set -euo pipefail
+# shellcheck source=lib.sh
+source "$(dirname "${BASH_SOURCE[0]}")/lib.sh"
+
+version=""
+os="${GOOS:-linux}"
+arch="${GOARCH:-amd64}"
+slim="${CODER_SLIM_BUILD:-0}"
+output_path=""
+
+args="$(getopt -o "" -l version:,os:,arch:,output:,slim -- "$@")"
+eval set -- "$args"
+while true; do
+    case "$1" in
+    --version)
+        version="$2"
+        shift 2
+        ;;
+    --os)
+        os="$2"
+        shift 2
+        ;;
+    --arch)
+        arch="$2"
+        shift 2
+        ;;
+    --output)
+        output_path="$(realpath "$2")"
+        shift 2
+        ;;
+    --slim)
+        slim=1
+        shift
+        ;;
+    --)
+        shift
+        break
+        ;;
+    *)
+        error "Unrecognized option: $1"
+        ;;
+    esac
+done
+
+if [[ "$version" == "" ]]; then
+    cdself
+    version="$(./version.sh)"
+fi
+
+build_args=(
+    -ldflags "-s -w -X 'github.com/coder/coder/buildinfo.tag=$version'"
+)
+if [[ "$slim" == 0 ]]; then
+    build_args+=(-tags embed)
+fi
+
+# cd to the root of the repo.
+cdroot
+
+# Compute default output path.
+if [[ "$output_path" == "" ]]; then
+    dist_dir="dist"
+    mkdir -p "$dist_dir"
+    output_path="${dist_dir}/coder_${version}_${os}_${arch}"
+    if [[ "$os" == "windows" ]]; then
+        output_path+=".exe"
+    fi
+    output_path="$(realpath "$output_path")"
+fi
+build_args+=(-o "$output_path")
+
+CGO_ENABLED=0 GOOS="$os" GOARCH="$arch" go build \
+    "${build_args[@]}" \
+    ./cmd/coder 1>&2
+
+echo -n "$output_path"
diff --git a/scripts/lib.sh b/scripts/lib.sh
@@ -0,0 +1,33 @@
+#!/usr/bin/env bash
+
+# This script is meant to be sourced by other scripts. To source this script:
+#     source "$(dirname "${BASH_SOURCE[0]}")/lib.sh"
+
+set -euo pipefail
+
+SCRIPT_DIR=$(dirname "${BASH_SOURCE[0]}")
+PROJECT_ROOT=$(cd "$SCRIPT_DIR" && git rev-parse --show-toplevel)
+
+cdself() {
+    cd "$SCRIPT_DIR" || error "Could not change directory to '$SCRIPT_DIR'"
+}
+
+cdroot() {
+    cd "$PROJECT_ROOT" || error "Could not change directory to '$PROJECT_ROOT'"
+}
+
+# Taken from https://stackoverflow.com/a/3915420 (CC-BY-SA 4.0)
+# Fails if the directory doesn't exist.
+realpath() {
+    dir="$(dirname "$1")"
+    base="$(basename "$1")"
+    echo "$(
+        cd "$dir" || error "Could not change directory to '$dir'"
+        pwd -P
+    )"/"$base"
+}
+
+error() {
+    echo "ERROR: $*" 1>&2
+    exit 1
+}
diff --git a/scripts/version.sh b/scripts/version.sh
@@ -0,0 +1,31 @@
+#!/usr/bin/env bash
+
+# This script generates the version string used by Coder, including for dev
+# versions. Note: the version returned by this script will NOT include the "v"
+# prefix that is included in the Git tag.
+
+set -euo pipefail
+# shellcheck source=lib.sh
+source "$(dirname "${BASH_SOURCE[0]}")/lib.sh"
+cdroot
+
+# $current will equal $last_tag if we're currently checked out on the tag's
+# commit.
+last_tag="$(git describe --tags --abbrev=0)"
+current="$(git describe --always)"
+
+version="$last_tag"
+
+# If the HEAD has extra commits since the last tag then we are in a dev version.
+#
+# Dev versions are denoted by the "+dev." suffix with a trailing commit short
+# SHA.
+if [[ "$last_tag" != "$current" ]]; then
+    if [[ "${CODER_NO_DEV_VERSION:-}" != "" ]]; then
+        error "version.sh attemped to generate a dev version string when CODER_NO_DEV_VERSION was set"
+    fi
+    version+="+dev.$(git rev-parse --short HEAD)"
+fi
+
+# Remove the "v" prefix.
+echo -n "${version#v}"