Makefile

GOPATH ?= $(HOME)/go
GOBIN ?= $(HOME)/bin

VERSION = $(shell git describe --tags --always --dirty)
BRANCH = $(shell git rev-parse --abbrev-ref HEAD)

DOCKER_IMAGE = sshexecutor

all: help

help:
	@echo
	@echo "VERSION: $(VERSION)"
	@echo "BRANCH: $(BRANCH)"
	@echo
	@echo "usage: make <command>"
	@echo
	@echo "commands:"
	@echo "    mod       	- populate vendor/ without updating it first"
	@echo "    build     	- build apps and installs them in $(GOBIN)"
	@echo "    test      	- run unit tests"
	@echo "    coverage  	- run unit tests and show coaverage on browser"
	@echo "    clean     	- remove generated files and directories"
	@echo "    run       	- start the service locally, NOT AS A DOCKER CONAINER"
	@echo "    docker-build - build the docker image"
	@echo "    docker-run 	- use docker-compose to run the service docker image"
	@echo
	@echo "GOPATH: $(GOPATH)"
	@echo "GOBIN: $(GOBIN)"
	@echo

mod:
	@echo ">>> Populating vendor folder..."
	@go mod vendor

build:
	@echo ">>> Building app..."
	go install -v ./...
	@echo

test:
	@echo ">>> Running tests..."
	go test -count=1 -v ./...
	@echo

coverage:
	go test ./... -v -coverprofile=coverage.out && go tool cover -html=coverage.out

clean:
	@echo ">>> Cleaning..."
	go clean -i -r -cache -testcache
	@echo

run:
	@echo ">>> Running ..."
	go run ./pkg/cmd/main.go
	@echo

docker-build:
	@echo ">>> Docker image building ..."
	docker build --network=host -t $(DOCKER_IMAGE) .
	@echo

docker-run:
	@echo ">>> Running Docker image ..."
	docker-compose up $(DOCKER_IMAGE)
	@echo