Skip to content

Comments

chore: 为 v0.4.0 发布准备文档和 CI 配置#36

Merged
ceyewan merged 9 commits intomainfrom
refactor/components-docs
Feb 13, 2026
Merged

chore: 为 v0.4.0 发布准备文档和 CI 配置#36
ceyewan merged 9 commits intomainfrom
refactor/components-docs

Conversation

@ceyewan
Copy link
Owner

@ceyewan ceyewan commented Feb 12, 2026

概述

为 v0.4.0 版本发布准备文档和 CI 配置。

主要改动

CI 配置

  • 启用 GitHub Actions CI(之前被注释)
  • 升级 Go 版本:1.21 → 1.25
  • 升级 action 版本:setup-go@v4 → @v5,golangci-lint@v3 → @v6

文档更新

  • README.md 版本状态更新为 v0.4.0
  • 补充 L0 层 trace 组件
  • 架构设计文档发布标准更新为 v0.4.0

包含提交

  • 7f8cbd9 fix(examples): 修复 config、idem 和 ratelimit 示例的运行错误
  • 03a487c chore: 修复代码 lint 问题并统一 Markdown 格式
  • 2aa7942 docs(blog): 重构组件博客文档为自然段主导风格
  • cd30871 refactor(cache): 重构缓存组件并完善文档
  • ffff864 feat(breaker): 完善 gRPC 拦截器测试并统一示例 proto
  • 914bf2b refactor(breaker): 重构熔断器组件并完善文档

测试计划

  • 本地 make test 通过
  • CI 检查通过

- 添加 Config.validate() 方法统一处理默认值,支持 nil cfg
- WithLogger 使用 WithNamespace() 替代手动添加字段
- nil logger 时使用 clog.Discard() 确保 logger 永远不为 nil
- 统一参数命名:serviceName → key
- 修复日志级别:熔断打开从 Warn 改为 Info(预期保护行为)
- 移除 impl.go 中重复的默认值设置逻辑
- 更新测试用例适配新行为
- 重构技术博客,统一格式规范,增加代码示例
- 新增 grpc_test.go:真实测试 gRPC 拦截器行为
  - 测试熔断器打开、半开状态恢复
  - 测试自定义 KeyFunc、Fallback 降级
  - 测试多服务独立熔断
- 统一示例 proto:创建 examples/proto/demo/v1/order.proto
  - 支持幂等键(idem 组件)、故障模拟(breaker 组件)
  - 支持服务信息字段(registry 组件)
- 更新 breaker example:使用统一 proto
  - 日志级别改为 warn,减少输出
  - 新增半开状态探测失败示例
  - 移除 fallback 中的 logger 调用
- 删除 breaker/example 独立 proto
- 重命名测试文件:cache_unit_test.go → cache_test.go,cache_integration_test.go → integration_test.go
- 完全重构示例代码:共享 Redis 连接,简化代码结构,增加更多示例
  * Key-Value 缓存示例
  * Hash 字段操作示例
  * Sorted Set 排行榜示例
  * List 定长队列示例
  * 批量操作示例
  * Memory 单机缓存示例
- 增强博客文档:新增数据结构原理章节
  * Hash:ziplist/hashtable 编码机制
  * Sorted Set:skiplist + dict 组合设计
  * List:quicklist 混合实现
  * 批量操作:Pipeline 减少网络往返
- docker-compose:新增 PostgreSQL 17-alpine 服务配置
全面重构技术博客文档,统一采用自然段主导的写作风格,减少代码片段
使用,增强原理性讲解。主要变更:

- registry/dlock/db/idgen 组件博客采用自然段优先的写作方式
- connector/config 组件博客优化结构,使用更清晰的章节划分
- 移除冗余代码示例,改用自然语言描述核心概念
- 新增 observability 组件博客,整合原 observability-guide.md 内容
- 更新 docs/README.md 文档索引

文档风格更加专业、深入,符合 Genesis 技术文档规范。
- 修复 connector、idgen 等组件中未检查错误的问题
- 清理测试代码中未使用的结构体与变量
- 使用 prettier 统一文档格式,解决发版前的静态检查阻塞项
- 修复 config 示例的配置文件搜索路径,支持从当前目录加载
- 修复 idem 和 ratelimit 示例中 Redis 连接未建立导致的 panic
- 优化 idem 和 ratelimit 的 HTTP 服务器端口分配,改用随机端口避免冲突
- 更新 Makefile 的 example-all 目标,改为失败即退出,确保发布前的质量校验有效
- 启用 GitHub Actions CI,升级 Go 版本至 1.25
- 更新 setup-go action 至 v5,golangci-lint action 至 v6
- 更新 README.md 版本状态为 v0.4.0,补充 trace 组件
- 更新架构设计文档发布标准至 v0.4.0
@ceyewan ceyewan merged commit 449b36d into main Feb 13, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant