Skip to content

verification-entrypoints.md

Latest commit

 

History

History
88 lines (61 loc) · 3.53 KB

verification-entrypoints.md

File metadata and controls

88 lines (61 loc) · 3.53 KB

验证入口分层说明

目标：把“平时改代码该跑什么、发版前该跑什么、哪些检查依赖私有环境”说清楚。

三层验证入口

入口 命令 默认环境 用途
Fast npm run verify:fast 本地 / CI 日常改动、热点重构、PR 前快速守卫
Full npm run verify:full 本地 / CI 完整功能回归、示例回归、memory-server 矩阵
Release npm run verify:release 本地私有发布前 在 full 基础上追加 opt-in 真实环境检查

补充入口

命令 说明
npm test 默认统一门禁：smoke + compatibility + unit + integration；不再隐式跑 legacy compat runner 或迁移专用 runner
npm run test:coverage 覆盖率门禁：通过 c8 运行默认测试，lines / statements / functions / branches 均要求 95% 以上
npm run test:refactor-guard 热点重构三联回归：exports + runtime/model + sync
npm run test:server-matrix memory-server 默认矩阵（Node / Driver / MongoDB server）
npm run test:real-env:private 私有真实环境检查；默认不进入常规 verify / CI
npm run release:preflight 公开发布前门禁：检查 lockfile 发布态、changelog / 支持矩阵 / 依赖治理文档，并串联 verify:fast + npm test + npm pack --dry-run

运行策略

1. 日常开发 / 小范围重构

npm run verify:fast

说明：当前 verify:fast 不再串联迁移专用 runner；它覆盖 lint、type-check、size strict、runtime smoke、compatibility、runtime/model/sync refactor guard 与 cache refactor guard。完整 unit / integration 默认门禁由 npm test 覆盖，发布预检会在 verify:fast 后继续执行 npm test。

适合：

  • 热点文件拆分
  • 内部 helper 重构
  • 类型和导出面调整

2. 完整交付 / 大范围改动

npm run verify:full

适合：

  • 文档和示例联动更新
  • 行为变更或跨模块重构
  • 发版前的完整仓库回归

3. 私有真实环境验证

npm run test:real-env:private

说明：

  • 仅在具备私有 Mongo / SSH 等条件时执行
  • 不作为默认 CI 阶段
  • 主要用于验证 memory-server 无法覆盖的真实部署路径

需要的环境变量：

  • MONSQLIZE_REAL_SSH_HOST
  • MONSQLIZE_REAL_SSH_PORT
  • MONSQLIZE_REAL_SSH_USERNAME
  • MONSQLIZE_REAL_SSH_PASSWORD
  • MONSQLIZE_REAL_MONGO_URI

默认边界

  • 默认闭环：npm test / verify:fast / verify:full / test:server-matrix
  • 覆盖率闭环：npm run test:coverage，并由 verify:full 串联
  • 显式 opt-in：test:real-env:private
  • 公开发布前门禁：release:preflight
  • 本地私有发布前补充：verify:release

为什么 CI 不直接跑 verify:release

  • verify:release 依赖私有 SSH / Mongo 环境变量，适合操作者在本地或私有 runner 明确触发。
  • 公开 CI 与仓库默认验证链只承诺 memory-server + 仓库内可复现资产。
  • 因此 GitHub Actions 的 Release Preflight workflow 故意只运行 release:preflight，不假设私有环境存在。

仓库同时提供 GitHub Actions Release Preflight workflow，支持手动触发和 v* tag 推送时复用同一套发布前门禁。

说明：test:server-matrix 只保留跨 Driver / Server 组合下稳定可重复的兼容面。像 sync target fan-out 统计这类更依赖 change-stream 时序的深度断言，继续由常规 integration、test:refactor-guard 和 release:preflight 覆盖。