执行摘要
- 一句话:删除已废弃的文档部署工作流
- 推荐动作:无需精读。这是一个简单的清理 PR,可以快速批准。但对于关注 CI 成本优化和文档基础设施的团队,值得了解其背景。
功能与动机
docs.sglang.io 已切换到 Mintlify(DNS 指向 cname.mintlify-dns.com),旧的 Sphinx 工作流仍在每次 push 到 main 时触发,消耗 GPU runner(约 12-15 分钟),且产物不再用于生产。PR 描述中明确指出:"the workflow is now vestigial: it burns a GPU runner per merge to keep a site nothing canonical points to."
实现拆解
- 删除工作流文件:移除
.github/workflows/release-docs.yml,该文件包含 89 行定义,涉及文档构建、Jupyter notebook 执行、HTML 生成以及推送到 sgl-project.github.io 仓库的步骤。
- 文档迁移计划的一部分:此删除对应
docs_new/docs_migration_plan.md 中的 Phase 6, step 4("Remove or archive old resources"),前提条件(DNS 切到 Mintlify)已经满足。
- 未包含的清理项:
docs/README.md 中仍有引用该工作流的说明,但仓库的 check-no-docs-changes hook 禁止编辑遗留 docs/,该部分将在后续删除整个 docs/ 时处理。sgl-project/sgl-project.github.io 仓库的归档也是独立的可选步骤。
关键文件:
.github/workflows/release-docs.yml(模块 CI 工作流;类别 infra;类型 deletion): 唯一变更文件,被完整删除。定义了遗留的 Sphinx 文档构建与部署流程。
关键符号:未识别
评论区精华
无实质性讨论。只有 ispobock 批准了 PR,无 review 评论。
风险与影响
- 风险:低风险。完全删除一个已废弃的工作流,不涉及任何业务逻辑或运行时行为变更。需确认没有其他流程依赖该工作流的输出(例如,有文档团队是否还引用
sgl-project.github.io 仓库)。
- 影响:
- CI 资源:每次 push 到 main 节省约 12-15 分钟 GPU runner 时间。
- 文档站点:无影响,因为生产站点已使用 Mintlify。
- 团队:开发者不再需要关心旧文档构建。
- 回滚:如果出现问题,可以轻松恢复该文件。
- 风险标记:无实质风险
关联脉络
- PR #27767 Update docs migration plan for removal of legacy release-docs workflow: 可能关联的文档更新,但未在提供的上下文中明确。可以认为本 PR 是文档迁移计划的一部分。
参与讨论