Update build steps

- Use gox (github.com/mitchellh/gox) for static builds
- Use compile time variables for version/build hash
- Add shorthand flags

Author: kashav

.gitignore

@@ -33,7 +33,7 @@ _testmain.go
 fsql
 debug
 main
-build/
+dist/
 
 # Allow cmd/fsql
 !cmd/fsql

Makefile

@@ -1,101 +1,103 @@
+PREFIX ?= $(shell pwd)
+
 NAME = fsql
-MAIN = ./cmd/fsql
+PKG = github.com/kshvmdn/$(NAME)
+MAIN = $(PKG)/cmd/$(NAME)
+
+DIST_DIR := ${PREFIX}/dist
+DIST_DIRS := find . -type d | sed "s|^\./||" | grep -v \\. | tr '\n' '\0' | xargs -0 -I '{}'
+
 SRCS := $(shell find . -type f -name '*.go')
 PKGS := $(shell go list ./... | grep -v /vendor)
 
-build = GOOS=$(1) GOARCH=$(2) go build -o build/$(NAME)$(3) $(MAIN)
-tar = cd build && tar -cvzf $(1)_$(2).tar.gz $(NAME)$(3) && rm $(NAME)$(3)
-zip = cd build && zip $(1)_$(2).zip $(NAME)$(3) && rm $(NAME)$(3)
+VERSION := $(shell cat VERSION)
+GITCOMMIT := $(shell git rev-parse --short HEAD)
+ifneq ($(shell git status --porcelain --untracked-files=no),)
+	GITCOMMIT := $(GITCOMMIT)-dirty
+endif
 
-.PHONY: all coverage clean fmt fmt-save get-tools install lint test vet
-.DEFAULT: all
+LDFLAGS := ${LDFLAGS} \
+	-X $(PKG)/meta.GITCOMMIT=${GITCOMMIT} \
+	-X $(PKG)/meta.VERSION=${VERSION}
 
-all: fsql
+.PHONY: build
+build: $(SRCS) VERSION
+	@echo "+ $@"
+	@go build -ldflags "${LDFLAGS}" -o $(NAME) -v $(MAIN)
 
+.PHONY: install
 install:
 	@echo "+ $@"
 	@go install $(PKGS)
 
+.PHONY: get-tools
 get-tools:
 	@echo "+ $@"
 	@go get -u -v github.com/golang/lint/golint
 
+.PHONY: clean
 clean:
 	@echo "+ $@"
-	rm -rf build ./$(NAME)
-	mkdir -p build
-
-fsql: $(SRCS)
-	@echo "+ $@"
-	@go build -o ./$(NAME) -v $(MAIN)
+	$(RM) $(NAME)
+	$(RM) -r $(DIST_DIR)
 
+.PHONY: fmt
 fmt:
 	@echo "+ $@"
 	@test -z "$$(gofmt -s -l . 2>&1 | grep -v ^vendor/ | tee /dev/stderr)" || \
 		(echo >&2 "+ please format Go code with 'gofmt -s', or use 'make fmt-save'" && false)
 
+.PHONY: fmt-save
 fmt-save:
 	@echo "+ $@"
 	@gofmt -s -l . 2>&1 | grep -v ^vendor/ | xargs gofmt -s -l -w
 
+.PHONY: vet
 vet:
 	@echo "+ $@"
 	@go vet $(PKGS)
 
+.PHONY: lint
 lint:
 	@echo "+ $@"
-	$(if $(shell which golint || echo ''), , \
+	$(if $(shell which golint || echo ''),, \
 		$(error Please install golint: `make get-tools`))
 	@test -z "$$(golint ./... 2>&1 | grep -v ^vendor/ | grep -v mock/ | tee /dev/stderr)"
 
+.PHONY: test
 test:
 	@echo "+ $@"
-	@go test -race -v $(PKGS)
+	@go test -race $(PKGS)
 
+.PHONY: coverage
 coverage:
 	@echo "+ $@"
 	@for pkg in $(PKGS); do \
 		go test -test.short -race -coverprofile="../../../$$pkg/coverage.txt" $${pkg} || exit 1; \
 	done
 
-binaries: darwin linux windows
-
-##### DARWIN BUILDS #####
-
-darwin: build/darwin_amd64.tar.gz
-
-build/darwin_amd64.tar.gz: $(SRCS)
-	$(call build,darwin,amd64,)
-	$(call tar,darwin,amd64)
-
-##### LINUX BUILDS #####
-
-linux: build/linux_arm.tar.gz build/linux_arm64.tar.gz build/linux_386.tar.gz build/linux_amd64.tar.gz
-
-build/linux_386.tar.gz: $(SRCS)
-	$(call build,linux,386,)
-	$(call tar,linux,386)
-
-build/linux_amd64.tar.gz: $(SRCS)
-	$(call build,linux,amd64,)
-	$(call tar,linux,amd64)
-
-build/linux_arm.tar.gz: $(SRCS)
-	$(call build,linux,arm,)
-	$(call tar,linux,arm)
-
-build/linux_arm64.tar.gz: $(SRCS)
-	$(call build,linux,arm64,)
-	$(call tar,linux,arm64)
-
-##### WINDOWS BUILDS #####
-
-windows: build/windows_386.zip build/windows_amd64.zip
-
-build/windows_386.zip: $(SRCS)
-	$(call build,windows,386,.exe)
-	$(call zip,windows,386,.exe)
+.PHONY: bootstrap-dist
+bootstrap-dist:
+	@echo "+ $@"
+	@go get -u -v github.com/franciscocpg/gox
 
-build/windows_amd64.zip: $(SRCS)
-	$(call build,windows,amd64,.exe)
-	$(call zip,windows,amd64,.exe)
+.PHONY: build-all
+build-all: $(SRCS) VERSION
+	@echo "+ $@"
+	@gox -verbose \
+		-ldflags "${LDFLAGS}" \
+		-os="darwin freebsd netbsd openbsd linux windows" \
+		-arch="386 amd64 arm arm64" \
+		-osarch="!darwin/arm !darwin/arm64" \
+		-output="$(DIST_DIR)/{{.OS}}-{{.Arch}}/{{.Dir}}" $(MAIN)
+
+.PHONY: dist
+dist: build-all
+	@echo "+ $@"
+	@cd $(DIST_DIR) && \
+		$(DIST_DIRS) cp ../LICENSE {} && \
+		$(DIST_DIRS) cp ../README.md {} && \
+		$(DIST_DIRS) tar -zcf fsql-${VERSION}-{}.tar.gz {} && \
+		$(DIST_DIRS) zip -r -q fsql-${VERSION}-{}.zip {} && \
+		$(DIST_DIRS) rm -rf {} && \
+		cd ..

README.md

@@ -16,32 +16,34 @@
 
 [![fsql.gif](./media/fsql.gif)](https://asciinema.org/a/120534)
 
-## Setup / installation
+## Installation
 
-Assumes that Go is [installed](https://golang.org/doc/install) and [setup](https://golang.org/doc/install#testing).
+#### Binaries
 
-Install with `go get`:
+[View latest release](https://github.com/kshvmdn/fsql/releases/latest).
+
+#### Via Go
 
 ```sh
 $ go get -u -v github.com/kshvmdn/fsql/...
 $ which fsql
 $GOPATH/bin/fsql
 ```
 
-Install with [Homebrew](https://brew.sh/):
+#### Via Homebrew
 
-```console
+```sh
 $ brew install fsql
 $ which fsql
 /usr/local/bin/fsql
 ```
 
-Install directly via source:
+#### Build manually
 
 ```sh
 $ git clone https://github.com/kshvmdn/fsql.git $GOPATH/src/github.com/kshvmdn/fsql
 $ cd $_ # $GOPATH/src/github.com/kshvmdn/fsql
-$ make install fsql
+$ make
 $ ./fsql
 ```
 
@@ -56,8 +58,10 @@ View the usage dialogue with the `-help` flag.
 ```sh
 $ fsql -help
 usage: fsql [options] query
+  -i  run in interactive mode (shorthand)
   -interactive
       run in interactive mode (Ctrl+D to exit)
+  -v  print version and exit (shorthand)
   -version
       print version and exit
 ```
@@ -327,12 +331,14 @@ Before submitting code, please ensure that tests are passing and the linter is h
 
 ```sh
 $ make install \
-       get-tools \
-       fmt \
+       get-tools
+$ make fmt \
        vet \
-       lint \
-       test \
+       lint
+$ make test \
        coverage
+$ make bootstrap-dist \
+       dist
 ```
 
 ## License

VERSION

@@ -0,0 +1 @@
+0.2.1

cmd/fsql/main.go

@@ -8,6 +8,7 @@ import (
 	"strings"
 
 	"github.com/kshvmdn/fsql"
+	"github.com/kshvmdn/fsql/meta"
 )
 
 var options struct {
@@ -28,13 +29,17 @@ func main() {
 		fmt.Printf("usage: %s [options] query\n", os.Args[0])
 		flag.PrintDefaults()
 	}
+
 	flag.BoolVar(&options.interactive, "interactive", false,
 		"run in interactive mode (Ctrl+D to exit)")
+	flag.BoolVar(&options.interactive, "i", false, "run in interactive mode (shorthand)")
 	flag.BoolVar(&options.version, "version", false, "print version and exit")
+	flag.BoolVar(&options.version, "v", false,
+		"print version and exit (shorthand)")
 	flag.Parse()
 
 	if options.version {
-		fmt.Printf("fsql v%v\n", fsql.Version)
+		fmt.Printf("%s\n", meta.Version())
 		os.Exit(0)
 	}
 

fsql.go

@@ -9,9 +9,6 @@ import (
 	"github.com/kshvmdn/fsql/query"
 )
 
-// Version holds the current version number.
-const Version = "0.2.1"
-
 var q *query.Query
 var attrs = [...]string{"mode", "size", "time", "hash", "name"}
 

meta/meta.go

@@ -0,0 +1,20 @@
+package meta
+
+import "fmt"
+
+// GITCOMMIT indicates which git hash the binary was built off of.
+var GITCOMMIT string
+
+// VERSION indicates which version of the binary is running.
+var VERSION string
+
+const majorRelease = "0.2.x"
+
+// Version returns the version/commit string.
+func Version() string {
+	version, commit := VERSION, GITCOMMIT
+	if commit == "" && version == "" {
+		version, commit = majorRelease, "master"
+	}
+	return fmt.Sprintf("fsql version %v, built off %v", version, commit)
+}