Makefile tooling (#15)

Author: joshdk

.github/workflows/main.yml

@@ -15,14 +15,14 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - name: Checkout code
-        uses: actions/checkout@v1
-
       - name: Setup go
         uses: actions/setup-go@v1
         with:
           go-version: 1.13
 
+      - name: Checkout code
+        uses: actions/checkout@v1
+
       - name: Build binary
         run: go build -o dist/retry -ldflags="-s -w -X main.version=$(git describe --tags)" .
 
@@ -34,22 +34,29 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
+      - name: Setup go
+        uses: actions/setup-go@v1
+        with:
+          go-version: 1.13
+
       - name: Checkout code
         uses: actions/checkout@v1
 
       - name: Run tests
-        run: go test -v -race -cover ./...
+        run: make test
 
-  golang-ci-lint:
+  lint:
     name: Lint
     runs-on: ubuntu-latest
 
     steps:
+      - name: Setup go
+        uses: actions/setup-go@v1
+        with:
+          go-version: 1.13
+
       - name: Checkout code
         uses: actions/checkout@v1
 
-      - name: Run GolangCI-Lint
-        uses: docker://golangci/golangci-lint:v1.21.0-alpine
-        with:
-          entrypoint: /usr/bin/golangci-lint
-          args: run -v
+      - name: Lint code
+        run: make lint

.github/workflows/release.yml

@@ -20,25 +20,7 @@ jobs:
         with:
           go-version: 1.13
 
-      - name: Install UPX 3.94
-        run: |
-          wget -q https://github.com/upx/upx/releases/download/v3.94/upx-3.94-amd64_linux.tar.xz
-          tar -xvf upx-3.94-amd64_linux.tar.xz
-          mkdir -p /opt/hostedtoolcache/upx-3.94/bin
-          install upx-3.94-amd64_linux/upx /opt/hostedtoolcache/upx-3.94/bin/upx
-          rm -rf upx-3.94-amd64_linux*
-          echo ::set-env name=PATH::/opt/hostedtoolcache/upx-3.94/bin:$PATH
-
-      - name: Install GoReleaser 0.123.3
-        run: |
-          wget -q https://github.com/goreleaser/goreleaser/releases/download/v0.123.3/goreleaser_Linux_x86_64.tar.gz
-          tar -xvf goreleaser_Linux_x86_64.tar.gz goreleaser
-          mkdir -p /opt/hostedtoolcache/goreleaser-0.123.3/bin
-          install goreleaser /opt/hostedtoolcache/goreleaser-0.123.3/bin/goreleaser
-          rm -rf goreleaser*
-          echo ::set-env name=PATH::/opt/hostedtoolcache/goreleaser-0.123.3/bin:$PATH
-
       - name: Run GoReleaser
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: goreleaser release
+        run: make release

.goreleaser.yml

@@ -22,7 +22,7 @@ builds:
 
     hooks:
       pre: go mod tidy
-      post: ./upx.sh
+      post: make compress
 
 archives:
   - id: retry

Makefile

@@ -0,0 +1,80 @@
+#### Environment ####
+
+# Enforce usage of the Go modules system.
+export GO111MODULE := on
+
+# Determine where `go get` will install binaries to.
+GOBIN := $(HOME)/go/bin
+ifdef GOPATH
+	GOBIN := $(GOPATH)/bin
+endif
+
+# Current operating system name.
+PLATFORM := $(shell uname -s)
+
+# All target for when make is run on its own.
+.PHONY: all
+all: test lint
+
+#### Binary Dependencies ####
+
+# Install binary for goimports.
+goimports := $(GOBIN)/goimports
+$(goimports):
+	@cd /tmp && go get -u golang.org/x/tools/cmd/goimports
+
+# Install binary for golangci-lint.
+golangci-lint := $(GOBIN)/golangci-lint
+$(golangci-lint):
+	@./scripts/install-golangci-lint $(golangci-lint)
+
+# Install binary for goreleaser.
+goreleaser := $(GOBIN)/goreleaser
+$(goreleaser):
+	@./scripts/install-goreleaser $(goreleaser)
+
+# Install binary for upx.
+ifeq "$(PLATFORM)" "Linux"
+upx := $(GOBIN)/upx
+else
+upx := /usr/local/bin/upx
+endif
+$(upx):
+	@./scripts/install-upx $(upx)
+
+#### Linting ####
+
+# Run code linters.
+.PHONY: lint
+lint: $(golangci-lint) style
+	$(golangci-lint) run
+
+# Run code formatters. Unformatted code will fail in CircleCI.
+.PHONY: style
+style: $(goimports)
+ifdef GITHUB_ACTIONS
+	$(goimports) -l .
+else
+	$(goimports) -l -w .
+endif
+
+#### Testing ####
+
+# Run Go tests and generate a JUnit XML style test report for ingestion by CircleCI.
+.PHONY: test
+test: $(go-junit-report)
+	@go test -v -race -cover ./...
+
+#### Release ####
+
+.PHONY: compress
+compress: $(upx)
+	$(upx) --best --ultra-brute dist/retry_*/retry*
+
+.PHONY: release
+release: $(goreleaser)
+ifdef GITHUB_ACTIONS
+	$(goreleaser) release
+else
+	$(goreleaser) --rm-dist --skip-publish --skip-validate --snapshot
+endif

scripts/install-golangci-lint

@@ -0,0 +1,16 @@
+#!/bin/sh
+set -eu
+
+platform="$(uname -s)"
+if [ "$platform" = Linux ]; then
+    prefix=golangci-lint-1.21.0-linux-amd64
+elif [ "$platform" = Darwin ]; then
+    prefix=golangci-lint-1.21.0-darwin-amd64
+fi
+
+cd "$(mktemp -d)" || exit 1
+wget -q "https://github.com/golangci/golangci-lint/releases/download/v1.21.0/${prefix}.tar.gz"
+tar -xf "${prefix}.tar.gz"
+mkdir -p "$(dirname "$1")"
+install "${prefix}/golangci-lint" "$1"
+rm -rf "$PWD"

scripts/install-goreleaser

@@ -0,0 +1,16 @@
+#!/bin/sh
+set -eu
+
+platform="$(uname -s)"
+if [ "$platform" = Linux ]; then
+    prefix=goreleaser_Linux_x86_64
+elif [ "$platform" = Darwin ]; then
+    prefix=goreleaser_Darwin_x86_64
+fi
+
+cd "$(mktemp -d)" || exit 1
+wget -q "https://github.com/goreleaser/goreleaser/releases/download/v0.123.3/${prefix}.tar.gz"
+tar -xf "${prefix}.tar.gz"
+mkdir -p "$(dirname "$1")"
+install goreleaser "$1"
+rm -rf "$PWD"

scripts/install-upx

@@ -0,0 +1,15 @@
+#!/bin/sh
+set -eu
+
+platform="$(uname -s)"
+if [ "$platform" = Darwin ]; then
+    HOMEBREW_NO_AUTO_UPDATE=1 HOMEBREW_NO_INSTALL_CLEANUP=1 exec brew install upx
+fi
+prefix=upx-3.94-amd64_linux
+
+cd "$(mktemp -d)" || exit 1
+wget -q "https://github.com/upx/upx/releases/download/v3.94/${prefix}.tar.xz"
+tar -xf "${prefix}.tar.xz"
+mkdir -p "$(dirname "$1")"
+install "${prefix}/upx" "$1"
+rm -rf "$PWD"