Golang Makefile

Makefile

# SPDX-License-Identifier: BSD-3-Clause
#
# Authors: Alexander Jung <alex@nderjung.net>
#
# Copyright (c) 2020, Alexander Jung.  All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#
# 1. Redistributions of source code must retain the above copyright
#    notice, this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
#    notice, this list of conditions and the following disclaimer in the
#    documentation and/or other materials provided with the distribution.
# 3. Neither the name of the copyright holder nor the names of its
#    contributors may be used to endorse or promote products derived from
#    this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.

# Directories
WORKDIR    ?= $(CURDIR)
TESTDIR    ?= $(WORKDIR)/tests
DISTDIR    ?= $(WORKDIR)/dist

# Arguments
REGISTRY   ?= ghcr.io
ORG        ?= nderjung
BIN        ?= app-name
IMAGE_TAG  ?= latest
IMAGE      ?= $(REGISTRY)/$(ORG)/$(BIN):$(IMAGE_TAG)

# Tools
DOCKER     ?= docker
DOCKER_RUN ?= $(DOCKER) run --rm $(1) \
              -w /go/src/github.com/$(ORG)/$(BIN) \
              -v $(WORKDIR):/go/src/github.com/$(ORG)/$(BIN) \
              $(REGISTRY)/$(ORG)/$(BIN):$(IMAGE_TAG) \
                $(2)
GO         ?= go

# Misc
Q          ?= @

# If run with DOCKER= or within a container, unset DOCKER_RUN so all commands
# are not proxied via docker container.
ifeq ($(DOCKER),)
DOCKER_RUN  :=
else ifneq ($(wildcard /.dockerenv),)
DOCKER_RUN  :=
endif
.PROXY      :=
ifneq ($(DOCKER_RUN),)
.PROXY      := docker-proxy-
$(MAKECMDGOALS):
	$(info Running target via Docker ($(IMAGE)...))
	$(Q)$(call DOCKER_RUN,,$(MAKE) $@)
endif

# Targets
.PHONY: all
$(.PROXY)all: build

.PHONY: build
$(.PROXY)build:
	$(GO) build -o $(DISTDIR)/$(BIN)

# Create an environment where we can build
.PHONY: container
container: ALPINE_VERSION     ?= 3.12
container: GO_VERSION         ?= 1.14
container: DOCKER_BUILD_EXTRA ?=
container:
	$(DOCKER) build \
		--build-arg ORG=$(ORG) \
		--build-arg BIN=$(BIN) \
		--build-arg ALPINE_VERSION=$(ALPINE_VERSION) \
		--build-arg GO_VERSION=$(GO_VERSION) \
		--tag $(IMAGE) \
		$(DOCKER_BUILD_EXTRA) $(WORKDIR)

# Run an environment where we can build
.PHONY: devenv
devenv: DOCKER_RUN_EXTRA ?= -it
devenv:
	$(Q)$(call DOCKER_RUN,$(DOCKER_RUN_EXTRA),sh)