发布检查
发布 AgentHub Home、文档或公开包装变更前使用这份清单。目标是让公开文档真正可用,同时避免把私有部署细节带进公开仓库。
WARNING
公开 release note 可以描述构建产物和用户可见行为。除标准公开域名外的 host、SSH alias、web-root、rollback command、私有日志和 secret 只属于私有 server workspace。
范围
发布前先给变更分类:
| 变更类型 | 最小证据 |
|---|---|
| 只改文案或文档 | zh/en parity、本地 build、公开入口文件同步 |
| 新增 docs route | Markdown 页面、导航、metadata、动态 sitemap/llms 覆盖、搜索索引 |
| 视觉改动 | 变更路由的桌面和移动截图 |
| OIDC/login 文案 | TokenDance ID 边界已复核 |
| 飞书/Lark 文档 | 只写协作入口,不写产品登录 |
| Runtime/API 文档 | 准确标注 preview、in development 或 stable |
文档门禁
- 每个新增英文 docs slug 都有同 slug 中文页面。
- Sidebar 配置包含导航标签和 TOC 标题。
- 搜索索引与 Markdown 页面描述同一套产品状态。
- README 和 AGENTS 在影响贡献者时同步新增路由或治理规则。
- Changelog 记录公开文档结构变化。
公开入口门禁
检查:
- 生成的
/robots.txt路由源; - 动态
src/pages/sitemap.xml.ts输出; - 生成的
/llms.txtdocs index 和路由源; - 页面 metadata、canonical URL、hreflang alternates;
- footer/docs 链接和路由标签。
公开路由保持无后缀,例如 /zh/docs/...。静态生成的 .html 只作为构建产物文件检查,不作为公开 URL 风格。
视觉 QA 门禁
文档变更至少截图:
/zh/docs桌面和移动端;/en/docs桌面端;- 每个被修改 docs 页面桌面端;
- 至少一个被修改 docs 页面移动端。
首页或产品 UI mock 变更还要截 /zh 和 /en 首屏。确认表格渲染为真正 table,代码块不横向溢出,docs sidebar 可用。
安全门禁
搜索变更文件,确认没有:
- 模型 API key 或 token-like 字符串;
- 私有 host path、SSH alias、backup path、rollback command;
- AgentHub 直接接入 GitHub/Google/Feishu 登录的表述;
- 把 TokenDance API key 写成浏览器登录凭据;
- Web 绕过 Hub 访问 Local Edge 或本地文件。
已知 dependency advisory 应和 release-blocking security finding 分开记录。不要为了消除 advisory 而执行强制降级修复。
部署门禁
声称已部署前:
- 确认本地 test、typecheck、build 通过。
- 确认合并后的 commit 在 CI build 通过。
- 确认部署工作流能访问部署凭据,或使用已批准的私有部署路径。
- 用 cache-busting query string 验证线上页面。
- 如果截图或 QA 报告包含本地路径,保存在公开 docs 之外。
如果部署步骤因为私有凭据缺失失败,只能说代码/文档已合并,不能说已部署。
WARNING
构建命令验证内容结构,但需要独立的 typecheck 命令或 CI job 才能确认类型安全。只有 typecheck 确实运行成功后,release note 才能写 typecheck 已通过。如果当前 package 没有 typecheck script,应记录为技术债,不要暗示已经通过。
推荐命令
站点仓库内:
corepack pnpm --filter @tokendance-site/hub exec astro check
corepack pnpm --filter @tokendance-site/hub test
corepack pnpm --filter @tokendance-site/hub lint
corepack pnpm check:release-ready
静态导出后至少检查:
# 构建产物检查;公开路由保持无后缀。
Test-Path .\apps\hub\out\zh\index.html
Test-Path .\apps\hub\out\zh\docs\index.html
Test-Path .\apps\hub\out\en\docs\index.html
Test-Path .\apps\hub\out\zh\docs\desktop\index.html
Test-Path .\apps\hub\out\en\docs\operations-runbook\index.html
Test-Path .\apps\hub\out\sitemap.xml
Test-Path .\apps\hub\out\llms.txt
旧的 TokenDance workspace 根目录 .\scripts\verify-*.ps1 治理门禁在当前
workspace 不存在。跨 workspace 文档或治理改动需要记录人工 rg 审计和相关
child repo 的 git diff --check 输出,不要引用不存在的脚本通过结果。
公开发布前不要从脏的主 worktree 打包。使用 root governance register 中记录的 clean release worktree,并在部署后用 cache-busting URL 冒烟检查。
在 GitHub 编辑此页