mirror of
https://github.com/davidallendj/magellan.git
synced 2025-12-19 19:17:02 -07:00
106 lines
2.6 KiB
Makefile
106 lines
2.6 KiB
Makefile
# import config.
|
|
# You can change the default config with `make cnf="config_special.env" build`
|
|
cnf ?= config.env
|
|
include $(cnf)
|
|
export $(shell sed 's/=.*//' $(cnf))
|
|
|
|
ifndef NAME
|
|
$(error NAME is not set. Please review and copy config.env.default to config.env and try again)
|
|
endif
|
|
|
|
ifndef VERSION
|
|
$(error VERSION is not set. Please review and copy config.env.default to config.env and try again)
|
|
endif
|
|
|
|
SHELL := /bin/bash
|
|
GOPATH ?= $(shell echo $${GOPATH:-~/go})
|
|
|
|
.DEFAULT_GOAL := all
|
|
.PHONY: all
|
|
all: ## build pipeline
|
|
all: mod inst build lint test
|
|
|
|
.PHONY: ci
|
|
ci: ## CI build pipeline
|
|
ci: all diff
|
|
|
|
.PHONY: help
|
|
help:
|
|
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
|
|
|
|
.PHONY: clean
|
|
clean: ## remove files created during build pipeline
|
|
$(call print-target)
|
|
rm -rf dist
|
|
rm -f coverage.*
|
|
rm -f '"$(shell go env GOCACHE)/../golangci-lint"'
|
|
go clean -i -cache -testcache -modcache -fuzzcache -x
|
|
|
|
.PHONY: mod
|
|
mod: ## go mod tidy
|
|
$(call print-target)
|
|
go mod tidy
|
|
|
|
.PHONY: inst
|
|
inst: ## go install tools
|
|
$(call print-target)
|
|
go install github.com/client9/misspell/cmd/misspell@v0.3.4
|
|
go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.52.2
|
|
go install github.com/goreleaser/goreleaser@v1.18.2
|
|
|
|
.PHONY: goreleaser
|
|
release: ## goreleaser build
|
|
$(call print-target)
|
|
$(GOPATH)/bin/goreleaser build --clean --single-target --snapshot
|
|
|
|
.PHONY: build
|
|
build: ## goreleaser build
|
|
go build --tags=all
|
|
|
|
.PHONY: docker
|
|
container: ## docker build
|
|
container:
|
|
$(call print-target)
|
|
docker build . --build-arg REGISTRY_HOST=${REGISTRY_HOST} --no-cache --pull --tag '${NAME}:${VERSION}'
|
|
|
|
.PHONY: spell
|
|
spell: ## misspell
|
|
$(call print-target)
|
|
$(GOPATH)/bin/misspell -error -locale=US -w **.md
|
|
|
|
.PHONY: lint
|
|
lint: ## golangci-lint
|
|
$(call print-target)
|
|
$(GOPATH)/bin/golangci-lint run --fix
|
|
|
|
.PHONY: test
|
|
test: ## go test
|
|
$(call print-target)
|
|
go test -race -covermode=atomic -coverprofile=coverage.out -coverpkg=./... ./...
|
|
go tool cover -html=coverage.out -o coverage.html
|
|
|
|
.PHONY: diff
|
|
diff: ## git diff
|
|
$(call print-target)
|
|
git diff --exit-code
|
|
RES=$$(git status --porcelain) ; if [ -n "$$RES" ]; then echo $$RES && exit 1 ; fi
|
|
|
|
.PHONY: docs
|
|
docs: ## go docs
|
|
$(call print-target)
|
|
go doc github.com/OpenCHAMI/magellan/cmd
|
|
go doc github.com/OpenCHAMI/magellan/internal
|
|
go doc github.com/OpenCHAMI/magellan/pkg/crawler
|
|
|
|
.PHONY: emulator
|
|
emulator:
|
|
$(call print-target)
|
|
./emulator/setup.sh
|
|
|
|
man:
|
|
$(call print-target)
|
|
go-md2man -in README.md -out magellan.1
|
|
|
|
define print-target
|
|
@printf "Executing target: \033[36m$@\033[0m\n"
|
|
endef
|