Makefile: rework based on neofs-http-gate

Non-Docker builds by default, no vendoring, more useful targets.
This commit is contained in:
Roman Khimov 2021-05-13 22:06:02 +03:00
parent 859b4d5814
commit 8af01b89a1

127
Makefile
View file

@ -1,43 +1,106 @@
-include .env #!/usr/bin/make -f
-include help.mk
HUB_IMAGE=nspccdev/neofs
REPO ?= $(shell go list -m)
VERSION ?= "$(shell git describe --tags 2>/dev/null || git rev-parse --short HEAD | sed 's/^v//')" VERSION ?= "$(shell git describe --tags 2>/dev/null || git rev-parse --short HEAD | sed 's/^v//')"
BUILD_VERSION ?= "$(shell git describe --abbrev=0 --tags | sed 's/^v//')"
.PHONY: format deps image publish BIN_NAME=neofs-s3-gw
HUB_IMAGE="nspccdev/$(BIN_NAME)"
HUB_TAG ?= "$(shell echo ${VERSION} | sed 's/^v//')"
BINDIR = bin
BIN = "$(BINDIR)/$(BIN_NAME)"
# Show current version .PHONY: help all dep clean format test cover lint docker/lint image-push image dirty-image
version:
@echo $(BUILD_VERSION) # Make all binaries
all: $(BIN)
$(BIN): $(BINDIR) dep
@echo "⇒ Build $@"
CGO_ENABLED=0 \
go build -v -trimpath \
-ldflags "-X main.Version=$(VERSION)" \
-o $@ ./cmd/gate
$(BINDIR):
@echo "⇒ Ensure dir: $@"
@mkdir -p $@
# Pull go dependencies
dep:
@printf "⇒ Download requirements: "
@CGO_ENABLED=0 \
go mod download && echo OK
@printf "⇒ Tidy requirements: "
@CGO_ENABLED=0 \
go mod tidy -v && echo OK
# Run tests
test:
@go test ./... -cover
# Run tests with race detection and produce coverage output
cover:
@go test -v -race ./... -coverprofile=coverage.txt -covermode=atomic
@go tool cover -html=coverage.txt -o coverage.html
# Reformat code # Reformat code
format: format:
@[ ! -z `which goimports` ] || (echo "install goimports" && exit 2) @echo "⇒ Processing gofmt check"
@for f in `find . -type f -name '*.go' -not -path './vendor/*' -not -name '*.pb.go' -prune`; do \ @gofmt -s -w ./
echo "⇒ Processing $$f"; \ @echo "⇒ Processing goimports check"
goimports -w $$f; \ @goimports -w ./
done
# Check and ensure dependencies # Build clean Docker image
deps: image:
@printf "⇒ Ensure vendor: " @echo "⇒ Build NeoFS S3 Gateway docker image "
@go mod tidy -v && echo OK || (echo fail && exit 2)
@printf "⇒ Download requirements: "
@go mod download && echo OK || (echo fail && exit 2)
@printf "⇒ Store vendor localy: "
@go mod vendor && echo OK || (echo fail && exit 2)
# Build current docker image
image: deps
@echo "⇒ Build docker-image"
@docker build \ @docker build \
--build-arg VERSION=$(BUILD_VERSION) \ --build-arg REPO=$(REPO) \
--build-arg VERSION=$(VERSION) \
--rm \
-f Dockerfile \ -f Dockerfile \
-t $(HUB_IMAGE)-s3-gate:$(BUILD_VERSION) . -t $(HUB_IMAGE):$(HUB_TAG) .
# Publish docker image # Push Docker image to the hub
publish: image-push:
@echo "${B}${G}⇒ publish docker image ${R}" @echo "⇒ Publish image"
@docker push $(HUB_IMAGE)-s3-gate:$(VERSION) @docker push $(HUB_IMAGE):$(HUB_TAG)
# Build dirty Docker image
dirty-image:
@echo "⇒ Build NeoFS S3 Gateway dirty docker image "
@docker build \
--build-arg REPO=$(REPO) \
--build-arg VERSION=$(VERSION) \
--rm \
-f Dockerfile.dirty \
-t $(HUB_IMAGE)-dirty:$(HUB_TAG) .
# Run linters
lint:
@golangci-lint --timeout=5m run
# Run linters in Docker
docker/lint:
docker run --rm -it \
-v `pwd`:/src \
-u `stat -c "%u:%g" .` \
--env HOME=/src \
golangci/golangci-lint:v1.40 bash -c 'cd /src/ && make lint'
# Show current version
version:
@echo $(VERSION)
# Show this help prompt
help:
@echo ' Usage:'
@echo ''
@echo ' make <target>'
@echo ''
@echo ' Targets:'
@echo ''
@awk '/^#/{ comment = substr($$0,3) } comment && /^[a-zA-Z][a-zA-Z0-9_-]+ ?:/{ print " ", $$1, comment }' $(MAKEFILE_LIST) | column -t -s ':' | grep -v 'IGNORE' | sort -u
# Clean up
clean:
rm -rf $(BINDIR)