mirror of
https://github.com/gowvp/gb28181.git
synced 2025-09-27 03:45:57 +08:00
208 lines
7.1 KiB
Makefile
208 lines
7.1 KiB
Makefile
# Makefile 使用文档
|
||
# https://www.gnu.org/software/make/manual/html_node/index.html
|
||
|
||
# include .envrc
|
||
SHELL = /bin/bash
|
||
|
||
# ==================================================================================== #
|
||
# HELPERS
|
||
# ==================================================================================== #
|
||
|
||
## help: print this help message
|
||
help:
|
||
@echo 'Usage:'
|
||
@sed -n 's/^##//p' ${MAKEFILE_LIST} | column -t -s ':' | sed -e 's/^/ /'
|
||
|
||
.PHONY: confirm
|
||
confirm:
|
||
@echo -n 'Are you sure? [y/n] ' && read ans && [ $${ans:-N} = y ]
|
||
|
||
.PHONY: title
|
||
title:
|
||
@echo -e "\033[34m$(content)\033[0m"
|
||
|
||
# ==================================================================================== #
|
||
# DEVELOPMENT
|
||
# ==================================================================================== #
|
||
|
||
## init: 安装开发环境
|
||
init:
|
||
go install github.com/google/wire/cmd/wire@latest
|
||
go install github.com/divan/expvarmon@latest
|
||
go install github.com/rakyll/hey@latest
|
||
go install mvdan.cc/gofumpt@latest
|
||
|
||
## wire: 生成依赖注入代码
|
||
wire:
|
||
go mod tidy
|
||
go get github.com/google/wire/cmd/wire@latest
|
||
go generate ./...
|
||
go mod tidy
|
||
|
||
## expva/http: 监听网络请求指标
|
||
expva/http:
|
||
expvarmon --ports=":9999" -i 1s -vars="version,request,requests,responses,goroutines,errors,panics,mem:memstats.Alloc"
|
||
|
||
## expva/db: 监听数据库连接指标
|
||
expva/db:
|
||
expvarmon --ports=":9999" -i 5s -vars="databse.MaxOpenConnections,databse.OpenConnections,database.InUse,databse.Idle"
|
||
|
||
# 发起 100 次请求，每次并发 50
|
||
# hey -n 100 -c 50 http://localhost:9999/healthcheck
|
||
|
||
|
||
# ==================================================================================== #
|
||
# QUALITY CONTROL
|
||
# ==================================================================================== #
|
||
|
||
## audit: 检查代码依赖/格式化/测试
|
||
.PHONY: audit
|
||
audit:
|
||
@make title content='Formatting code...'
|
||
gofumpt -l -w .
|
||
@make title content='Vetting code...'
|
||
go vet ./...
|
||
@make title content='Running tests...'
|
||
go test -race -vet=off ./...
|
||
|
||
## vendor: 整理并下载依赖
|
||
.PHONY: vendor
|
||
vendor:
|
||
@make title content='Tidying and verifying module dependencies...'
|
||
go mod tidy && go mod verify
|
||
@make title content='Vendoring dependencies...'
|
||
go mod vendor
|
||
|
||
# ==================================================================================== #
|
||
# VERSION
|
||
# ==================================================================================== #
|
||
|
||
# 版本号规则说明
|
||
# 1. 版本号使用 Git tag，格式为 v1.0.0。
|
||
# 2. 如果当前提交没有 tag，找到最近的 tag，计算从该 tag 到当前提交的提交次数。例如，最近的 tag 为 v1.0.1，当前提交距离它有 10 次提交，则版本号为 v1.0.11（v1.0.1 + 10 次提交）。
|
||
# 3. 如果没有任何 tag，则默认版本号为 v0.0.0，后续提交次数作为版本号的次版本号。
|
||
|
||
# Get the current module name
|
||
MODULE_NAME := $(shell pwd | awk -F "/" '{print $$NF}')
|
||
# Get the latest commit hash and date
|
||
HASH_AND_DATE := $(shell git log -n1 --pretty=format:"%h-%cd" --date=format:%y%m%d | awk '{print $1}')
|
||
BRANCH := $(shell git rev-parse --abbrev-ref HEAD)
|
||
|
||
# 如果想仅支持注释标签，可以去掉 --tags，否则会包含轻量标签
|
||
RECENT_TAG := $(shell git describe --tags --abbrev=0 2>&1 | grep -v "fatal" || echo "v0.0.0")
|
||
|
||
ifeq ($(RECENT_TAG),v0.0.0)
|
||
COMMITS := $(shell git rev-list --count HEAD)
|
||
else
|
||
COMMITS := $(shell git log --first-parent --format='%ae' $(RECENT_TAG)..$(BRANCH) | wc -l)
|
||
COMMITS := $(shell echo $(COMMITS) | sed 's/ //g')
|
||
endif
|
||
|
||
# 从版本字符串中提取主版本号、次版本号和修订号
|
||
GIT_VERSION_MAJOR := $(shell echo $(RECENT_TAG) | cut -d. -f1 | sed 's/v//')
|
||
GIT_VERSION_MINOR := $(shell echo $(RECENT_TAG) | cut -d. -f2)
|
||
GIT_VERSION_PATCH := $(shell echo $(RECENT_TAG) | cut -d. -f3)
|
||
|
||
# windows 系统 git bash 没有 bc
|
||
# FINAL_PATCH := $(shell echo $(GIT_VERSION_PATCH) + $(COMMITS) | bc)
|
||
FINAL_PATCH := $(shell echo '$(GIT_VERSION_PATCH) $(COMMITS)' | awk '{print $$1 + $$2}')
|
||
VERSION := v$(GIT_VERSION_MAJOR).$(GIT_VERSION_MINOR).$(FINAL_PATCH)
|
||
|
||
# test:
|
||
# @echo ">>>${RECENT_TAG}"
|
||
|
||
## info: 查看构建版本相关信息
|
||
.PHONY: info
|
||
info:
|
||
@echo "dir: $(MODULE_NAME)"
|
||
@echo "version: $(VERSION)"
|
||
@echo "branch $(BRANCH)"
|
||
@echo "hash: $(HASH_AND_DATE)"
|
||
@echo "support $$(go tool dist list | grep amd64 | grep linux)"
|
||
|
||
|
||
# ==================================================================================== #
|
||
# BUILD
|
||
# ==================================================================================== #
|
||
|
||
BUILD_DIR_ROOT := ./build
|
||
GOOS = $(shell go env GOOS)
|
||
GOARCH = $(shell go env GOARCH)
|
||
IMAGE_NAME := gospace/gowvp:latest
|
||
|
||
## build/clean: 清理构建缓存目录
|
||
.PHONY: build/clean
|
||
build/clean:
|
||
@rm -rf $(BUILD_DIR_ROOT)/*
|
||
|
||
## build/local: 构建本地应用
|
||
.PHONY: build/local
|
||
build/local:
|
||
$(eval dir := $(BUILD_DIR_ROOT)/$(GOOS)_$(GOARCH))
|
||
@echo 'Building $(VERSION) $(dir)...'
|
||
@rm -rf $(dir)
|
||
@GOOS=$(GOOS) GOARCH=$(GOARCH) go build \
|
||
-trimpath \
|
||
-ldflags="-s -w \
|
||
-X main.buildVersion=$(VERSION) \
|
||
-X main.gitBranch=$(BRANCH_NAME) \
|
||
-X main.gitHash=$(HASH_AND_DATE) \
|
||
-X main.buildTimeAt=$(shell date +%s) \
|
||
-X main.release=true \
|
||
" -o=$(dir)/bin ./cmd/server
|
||
@echo '>>> OK'
|
||
|
||
## build/linux: 构建 linux 应用
|
||
.PHONY: build/linux
|
||
BUILD_LINUX_AMD64_DIR := ./build/linux_amd64
|
||
build/linux:
|
||
$(eval GOARCH := amd64)
|
||
$(eval GOOS := linux)
|
||
$(eval dir := $(BUILD_DIR_ROOT)/$(GOOS)_$(GOARCH))
|
||
@make build/local GOOS=$(GOOS) GOARCH=$(GOARCH)
|
||
|
||
$(eval GOARCH := arm64)
|
||
$(eval GOOS := linux)
|
||
$(eval dir := $(BUILD_DIR_ROOT)/$(GOOS)_$(GOARCH))
|
||
@make build/local GOOS=$(GOOS) GOARCH=$(GOARCH)
|
||
|
||
## build/windows: 构建 windows 应用
|
||
.PHONY: build/windows
|
||
BUILD_WINDOWS_AMD64_DIR := ./build/windows_amd64
|
||
build/windows:
|
||
$(eval GOARCH := amd64)
|
||
$(eval GOOS := windows)
|
||
@make build/local GOOS=$(GOOS) GOARCH=$(GOARCH)
|
||
|
||
docker/build:
|
||
@docker build --force-rm=true --push --platform linux/amd64 -t registry.cn-shanghai.aliyuncs.com/ixugo/gowvp:latest -f Dockerfile .
|
||
|
||
docker/save:
|
||
@docker save -o $(MODULE_NAME).tar $(IMAGE_NAME)
|
||
|
||
docker/push:
|
||
@docker push $(IMAGE_NAME)
|
||
|
||
docker/build/test: build/clean build/linux
|
||
@docker build --force-rm=true -t $(IMAGE_NAME) -f Dockerfile_full .
|
||
|
||
docker/build/full: build/clean build/linux
|
||
@docker build --force-rm=true --push --platform linux/amd64,linux/arm64 -t $(IMAGE_NAME) -f Dockerfile_full .
|
||
# @docker build --force-rm=true --push --platform linux/amd64,linux/arm64 -t registry.cn-shanghai.aliyuncs.com/ixugo/homenvr:latest -f Dockerfile_full .
|
||
|
||
docker/build/gowvp: build/clean build/linux
|
||
@docker build --force-rm=true --push --platform linux/amd64,linux/arm64 -t registry.cn-shanghai.aliyuncs.com/ixugo/gowvp:latest -f Dockerfile .
|
||
|
||
|
||
# ==================================================================================== #
|
||
# PRODUCTION
|
||
# ==================================================================================== #
|
||
|
||
PRODUCTION_HOST = remoteHost
|
||
|
||
## release/push: 发布产品到服务器，仅上传文件
|
||
# 中小项目可以引入 CI/CD，也可以通过命令快速发布到测试服务器上。
|
||
release/push:
|
||
@scp build/linux_amd64/bin $(PRODUCTION_HOST):/home/app/$(MODULE_NAME)
|
||
@echo "push Successed"
|