Skip to content

Latest commit

 

History

History
43 lines (35 loc) · 2.67 KB

File metadata and controls

43 lines (35 loc) · 2.67 KB

发布前检查清单(Release & Security Review)

在提交 PR、发布版本或上线之前,请按照以下步骤逐一核对并记录。建议在团队内执行双人复核,确保功能正确、安全、可观测。

1. 代码审查(Code Review)

  • 需求匹配:确认改动与需求说明一致,没有遗漏或额外范围。
  • 边界条件:补充或更新单元测试/集成测试覆盖关键分支。
  • 错误处理:所有数据库/网络调用均具备错误捕获与日志记录。
  • 代码风格:遵循项目代码风格与命名约定,无多余调试输出。
  • 依赖管理:新增依赖已评估许可证、维护状态与安全性。

2. 安全审查(Security Review)

  • 凭据管理:确认 .env 或部署环境中未暴露默认账户与弱口令。
  • 密码策略:如使用明文密码,确保仅在本地环境;生产环境必须启用哈希存储。
  • Session 与 CookieSESSION_SECRET 已设置为高熵值,生产环境强制 securehttpOnly
  • 日志脱敏:审查日志/数据库中是否包含敏感信息,必要时添加裁剪或脱敏。
  • 外部接口:校验上游 API 的证书、鉴权方式与速率限制,防止滥用。

3. 数据库与迁移

  • 建表脚本:确认 initializeDatabasemigrateDatabase 覆盖当前需求。
  • 备份策略:上线前准备数据库备份或可回滚方案。
  • 兼容性验证:若调整字段,确认老数据与索引策略仍然有效。

4. 可观测性与运维

  • 监控指标:确认 api_statistics 与日志内容满足排障需求。
  • 健康检查/health 接口在目标环境返回 healthy 状态。
  • 资源限制:评估连接池、超时、重试策略,避免资源耗尽。
  • 警报配置:如有监控平台,更新阈值或报警联系人。

5. 手动测试(Manual QA)

  • 基础冒烟:至少验证一次登录、Chat Completions(流式/非流式)、日志查看、统计接口。
  • 异常场景:验证错误凭证、上游超时、数据库失联等场景的回退与提示。
  • 浏览器兼容:在常见浏览器(Chrome/Edge)访问面板无明显 UI 缺陷。

6. 上线记录

  • 版本说明:编写 CHANGELOG 或发布说明,包括功能点与已知风险。
  • 回滚方案:记录遇到问题时的回滚命令与负责人。
  • 责任人签字
    • 开发:__________
    • Reviewer:__________
    • 运维:__________

贴士:将本清单与 CI/CD 流程结合,可自动提醒未完成的步骤,持续提升交付质量。