k2safe/go-omni
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: make README the complete project integration entry point

Browse Source
This commit is contained in:
k2safe
2026-09-23 21:10:43 +08:00
parent 35bd724326
commit 7b8eca1a61
5 changed files with 330 additions and 259 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
RELEASE.md
View File

@@ -6,16 +6,21 @@
## 安装与升级
首次接入请从 [README 接入指南](README.md) 开始，按新项目或已有项目选择步骤。下面是已接入项目的版本升级命令：
```sh
GOPRIVATE=git.yuntuo.hk go install git.yuntuo.hk/k2safe/go-omni/cmd/go-omni@v0.8.0-preview
# 已有业务项目中执行：
# 在业务项目 go.mod 所在目录执行：
GOPRIVATE=git.yuntuo.hk go get git.yuntuo.hk/k2safe/go-omni@v0.8.0-preview
# 仅在已经由 .api 生成、具有 .goOmni/apiManifest.json 的项目中执行：
go-omni api generate
go test ./...
```
新项目可以直接 `go-omni api new --module example.com/demo ./demo`，或用 `go-omni new --api service.api --module example.com/demo ./demo`。远程安装的 CLI 会固定生成项目的框架版本，无需本地 replace。需要仓库权限时使用自己的 Git 凭据管理器，不把凭据写入 module path 或 go.mod。
手写接口项目跳过 `api generate`，仍需执行业务测试。生成器不会自动接管其他框架创建的已有项目。
新项目可以直接 `go-omni api new --module example.com/demo ./demo`，或用 `go-omni new --api service.api --module example.com/demo ./demo`。在框架源码目录之外运行，远程安装的 CLI 会固定生成项目的框架版本，无需本地 replace；也可显式传 `--framework-version v0.8.0-preview` 固定远程依赖。需要仓库权限时使用自己的 Git 凭据管理器，不把凭据写入 module path 或 go.mod。
## 本版功能