初始化

2026-09-17 14:42:44 +08:00
commit 7c106b69d2
54 changed files with 2521 additions and 0 deletions
--- a/hack/config.yaml
+++ b/hack/config.yaml
@@ -0,0 +1,27 @@
+
+# ============================================================
+# GoFrame CLI 工具配置（仅开发环境使用，gf 命令读取）
+# 文档：https://goframe.org/docs/cli
+# ============================================================
+
+gfcli:
+  gen:
+    dao:
+      # 生成 dao/entity/do 的数据库连接
+      # 用法：cd tool-api && gf gen dao
+      # 注意：与 manifest/config/config.yaml 的数据库保持同一套（当前：root/root@nl_toolbox）
+      - link: "mysql:root:root@tcp(127.0.0.1:3306)/nl_toolbox"
+        # 实体字段附带数据库字段描述注释
+        descriptionTag: true
+        # 只生成指定表（逗号分隔，留空 = 全部表），如 "users,tools"
+        # tables: ""
+        # 去除表名公共前缀，如表名 tb_users 生成 Users 时配 "tb_"
+        # removePrefix: ""
+
+  docker:
+    # docker 镜像构建参数：
+    # -a 架构(amd64/arm64)  -s 系统(linux)  -p 临时目录前缀  -ew 排除文件
+    build: "-a amd64 -s linux -p temp -ew"
+    # 镜像 tag 前缀（推送到私有仓库时改成自己的 registry）
+    tagPrefixes:
+      - my.image.pub/my-app
--- a/hack/hack-cli.mk
+++ b/hack/hack-cli.mk
@@ -0,0 +1,18 @@
+
+# Install/Update to the latest CLI tool.
+.PHONY: cli
+cli:
+	@set -e; \
+    echo "go install github.com/gogf/gf/cmd/gf/v2@latest"; \
+	go install github.com/gogf/gf/cmd/gf/v2@latest; \
+	echo "GoFame CLI installed successfully!"
+
+
+# Check and install CLI tool.
+.PHONY: cli.install
+cli.install:
+	@set -e; \
+	gf -v > /dev/null 2>&1 || if [[ "$?" -ne "0" ]]; then \
+  		echo "GoFame CLI is not installed, start proceeding auto installation..."; \
+		make cli; \
+	fi;
--- a/hack/hack.mk
+++ b/hack/hack.mk
@@ -0,0 +1,75 @@
+.DEFAULT_GOAL := build
+
+# Update GoFrame and its CLI to latest stable version.
+.PHONY: up
+up: cli.install
+	@gf up -a
+
+# Build binary using configuration from hack/config.yaml.
+.PHONY: build
+build: cli.install
+	@gf build -ew
+
+# Parse api and generate controller/sdk.
+.PHONY: ctrl
+ctrl: cli.install
+	@gf gen ctrl
+
+# Generate Go files for DAO/DO/Entity.
+.PHONY: dao
+dao: cli.install
+	@gf gen dao
+
+# Parse current project go files and generate enums go file.
+.PHONY: enums
+enums: cli.install
+	@gf gen enums
+
+# Generate Go files for Service.
+.PHONY: service
+service: cli.install
+	@gf gen service
+
+
+# Build docker image.
+.PHONY: image
+image: cli.install
+	$(eval _TAG  = $(shell git rev-parse --short HEAD))
+ifneq (, $(shell git status --porcelain 2>/dev/null))
+	$(eval _TAG  = $(_TAG).dirty)
+endif
+	$(eval _TAG  = $(if ${TAG},  ${TAG}, $(_TAG)))
+	$(eval _PUSH = $(if ${PUSH}, ${PUSH}, ))
+	@gf docker ${_PUSH} -tn $(DOCKER_NAME):${_TAG};
+
+
+# Build docker image and automatically push to docker repo.
+.PHONY: image.push
+image.push: cli.install
+	@make image PUSH=-p;
+
+
+# Deploy image and yaml to current kubectl environment.
+.PHONY: deploy
+deploy: cli.install
+	$(eval _TAG = $(if ${TAG},  ${TAG}, develop))
+
+	@set -e; \
+	mkdir -p $(ROOT_DIR)/temp/kustomize;\
+	cd $(ROOT_DIR)/manifest/deploy/kustomize/overlays/${_ENV};\
+	kustomize build > $(ROOT_DIR)/temp/kustomize.yaml;\
+	kubectl   apply -f $(ROOT_DIR)/temp/kustomize.yaml; \
+	if [ $(DEPLOY_NAME) != "" ]; then \
+		kubectl patch -n $(NAMESPACE) deployment/$(DEPLOY_NAME) -p "{\"spec\":{\"template\":{\"metadata\":{\"labels\":{\"date\":\"$(shell date +%s)\"}}}}}"; \
+	fi;
+
+
+# Parsing protobuf files and generating go files.
+.PHONY: pb
+pb: cli.install
+	@gf gen pb
+
+# Generate protobuf files for database tables.
+.PHONY: pbentity
+pbentity: cli.install
+	@gf gen pbentity