add Makefile for ease of use

This commit is contained in:
Marc R Kellerman 2023-04-13 23:06:58 -07:00
parent 5133476c78
commit c2c6ffb23f

112
Makefile Normal file
View file

@ -0,0 +1,112 @@
GOCMD=go
GOTEST=$(GOCMD) test
GOVET=$(GOCMD) vet
BINARY_NAME=llama-cli
VERSION?=0.0.0
SERVICE_PORT?=3000
DOCKER_REGISTRY?= #if set it should finished by /
EXPORT_RESULT?=false # for CI please set EXPORT_RESULT to true
GREEN := $(shell tput -Txterm setaf 2)
YELLOW := $(shell tput -Txterm setaf 3)
WHITE := $(shell tput -Txterm setaf 7)
CYAN := $(shell tput -Txterm setaf 6)
RESET := $(shell tput -Txterm sgr0)
.PHONY: all test build vendor
all: help
## Build:
build: llamacpp ## Build the project
$(GOCMD) build -o $(BINARY_NAME) ./
llamacpp: ## Build go-llama.cpp (pre-requisite)
if [ ! -d "go-llama.cpp" ]; then git clone --recurse-submodules https://github.com/go-skynet/go-llama.cpp go-llama.cpp; fi
-if [ ! -f "go-llama.cpp/libbinding.a" ]; then cd go-llama.cpp && make libbinding.a; fi
# cp go-llama.cpp/libbinding.a libbinding.a
# cp go-llama.cpp/binding.o binding.o
cd go-llama.cpp && $(GOCMD) mod download
$(GOCMD) mod edit -replace github.com/go-skynet/go-llama.cpp=$(shell pwd)/go-llama.cpp
clean: ## Remove build related file
rm -fr ./go-llama.cpp
rm -f $(BINARY_NAME)
# rm -f ./libbinding.a
# rm -f ./binding.o
rm -f ./junit-report.xml checkstyle-report.xml ./coverage.xml ./profile.cov yamllint-checkstyle.xml
vendor: ## Copy of all packages needed to support builds and tests in the vendor directory
$(GOCMD) mod vendor
## Run:
run: build ## Run the project
C_INCLUDE_PATH=$(shell pwd)/go-llama.cpp LIBRARY_PATH=$(shell pwd)/go-llama.cpp $(GOCMD) run ./ api
# watch: ## Run the code with cosmtrek/air to have automatic reload on changes
# $(eval PACKAGE_NAME=$(shell head -n 1 go.mod | cut -d ' ' -f2))
# docker run -it --rm -w /go/src/$(PACKAGE_NAME) -v $(shell pwd):/go/src/$(PACKAGE_NAME) -p $(SERVICE_PORT):$(SERVICE_PORT) cosmtrek/air
## Test:
test: ## Run the tests of the project
ifeq ($(EXPORT_RESULT), true)
GO111MODULE=off go get -u github.com/jstemmer/go-junit-report
$(eval OUTPUT_OPTIONS = | tee /dev/tty | go-junit-report -set-exit-code > junit-report.xml)
endif
$(GOTEST) -v -race ./... $(OUTPUT_OPTIONS)
coverage: ## Run the tests of the project and export the coverage
$(GOTEST) -cover -covermode=count -coverprofile=profile.cov ./...
$(GOCMD) tool cover -func profile.cov
ifeq ($(EXPORT_RESULT), true)
GO111MODULE=off go get -u github.com/AlekSi/gocov-xml
GO111MODULE=off go get -u github.com/axw/gocov/gocov
gocov convert profile.cov | gocov-xml > coverage.xml
endif
# ## Lint:
# lint: lint-go lint-dockerfile lint-yaml ## Run all available linters
# lint-dockerfile: ## Lint your Dockerfile
# # If dockerfile is present we lint it.
# ifeq ($(shell test -e ./Dockerfile && echo -n yes),yes)
# $(eval CONFIG_OPTION = $(shell [ -e $(shell pwd)/.hadolint.yaml ] && echo "-v $(shell pwd)/.hadolint.yaml:/root/.config/hadolint.yaml" || echo "" ))
# $(eval OUTPUT_OPTIONS = $(shell [ "${EXPORT_RESULT}" == "true" ] && echo "--format checkstyle" || echo "" ))
# $(eval OUTPUT_FILE = $(shell [ "${EXPORT_RESULT}" == "true" ] && echo "| tee /dev/tty > checkstyle-report.xml" || echo "" ))
# docker run --rm -i $(CONFIG_OPTION) hadolint/hadolint hadolint $(OUTPUT_OPTIONS) - < ./Dockerfile $(OUTPUT_FILE)
# endif
# lint-go: ## Use golintci-lint on your project
# $(eval OUTPUT_OPTIONS = $(shell [ "${EXPORT_RESULT}" == "true" ] && echo "--out-format checkstyle ./... | tee /dev/tty > checkstyle-report.xml" || echo "" ))
# docker run --rm -v $(shell pwd):/app -w /app golangci/golangci-lint:latest-alpine golangci-lint run --deadline=65s $(OUTPUT_OPTIONS)
# lint-yaml: ## Use yamllint on the yaml file of your projects
# ifeq ($(EXPORT_RESULT), true)
# GO111MODULE=off go get -u github.com/thomaspoignant/yamllint-checkstyle
# $(eval OUTPUT_OPTIONS = | tee /dev/tty | yamllint-checkstyle > yamllint-checkstyle.xml)
# endif
# docker run --rm -it -v $(shell pwd):/data cytopia/yamllint -f parsable $(shell git ls-files '*.yml' '*.yaml') $(OUTPUT_OPTIONS)
# ## Docker:
# docker-build: ## Use the dockerfile to build the container
# docker build --rm --tag $(BINARY_NAME) .
# docker-release: ## Release the container with tag latest and version
# docker tag $(BINARY_NAME) $(DOCKER_REGISTRY)$(BINARY_NAME):latest
# docker tag $(BINARY_NAME) $(DOCKER_REGISTRY)$(BINARY_NAME):$(VERSION)
# # Push the docker images
# docker push $(DOCKER_REGISTRY)$(BINARY_NAME):latest
# docker push $(DOCKER_REGISTRY)$(BINARY_NAME):$(VERSION)
## Help:
help: ## Show this help.
@echo ''
@echo 'Usage:'
@echo ' ${YELLOW}make${RESET} ${GREEN}<target>${RESET}'
@echo ''
@echo 'Targets:'
@awk 'BEGIN {FS = ":.*?## "} { \
if (/^[a-zA-Z_-]+:.*?##.*$$/) {printf " ${YELLOW}%-20s${GREEN}%s${RESET}\n", $$1, $$2} \
else if (/^## .*$$/) {printf " ${CYAN}%s${RESET}\n", substr($$1,4)} \
}' $(MAKEFILE_LIST)