Skip to content

工程化:建立 GitHub CI 与仓库展示基线 #1

Description

@ZZDR1023

背景

仓库已公开并完成 v0.1-alpha 本地纵向闭环,但 GitHub 端尚没有持续集成,README 无构建状态徽章,当前简版许可证文本被 GitHub 识别为 Other,Topics 也未配置。这会降低外部审阅、简历展示和后续发布的可信度。

目标

建立最小但可执行的 GitHub 工程化基线,让每次 PR/推送都能在目标运行时验证 TypeScript、Python、端到端 smoke 与 standalone 导出复现,并让仓库元数据准确展示。

范围

  • 新增 GitHub Actions CI,目标环境:Node.js 24、Python 3.11。
  • CI 使用 npm ci,执行 npm run checknpm run buildnpm run smoke
  • CI 从 smoke 结果定位 project.zip,解压到独立临时目录并运行包内 python3 reproduce.py;断言 9/9 tasks、40 artifacts、PDF 和无 warning。
  • 缓存 npm 依赖,但不缓存或上传 secrets、runs 数据库或用户数据。
  • LICENSE 替换为完整、标准的 Apache License 2.0 文本,使 GitHub 可识别 SPDX 许可证。
  • README 添加 CI badge,并保持 Alpha 能力边界和限制不被夸大。
  • 配置仓库 Topics:mathematical-modelingai-agentreproducible-researchevidence-graphtypescriptpythonmachine-learningoptimizationtime-series

TDD / 可执行验收

先增加一个不依赖 GitHub runner 的静态契约测试,读取 workflow、README 和 LICENSE,并在变更前因文件/规则缺失而失败。该测试至少断言:

  1. workflow 固定 Node 24 与 Python 3.11;
  2. 使用 npm ci,执行 check/build/smoke 与 standalone python3 reproduce.py
  3. workflow 权限最小化、无 secrets 输出;
  4. README badge 指向仓库 workflow;
  5. LICENSE 是完整 Apache-2.0 标准文本。

实现后执行:

npm run check
npm run build
npm run smoke

PR 创建后由主控独立等待 GitHub Actions checks,并复核仓库 License 识别、Topics 与分支保护可用性。

非目标

  • 不发布 Release。
  • 不做历史题 Benchmark。
  • 不修改建模算法、Schema、Orchestrator 或运行时功能。
  • 不在 CI 中做依赖外网研究、Docker Hub build 或真实 Pi 模型调用。

人工验收入口

打开仓库首页和 PR:确认 CI 徽章可点击、Actions 绿色、License 显示 Apache-2.0、Topics 正确;再从 Actions 日志确认 standalone reproduction 返回 status=success

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

P2小缺陷、工程化与体验打磨,按队列处理enhancementNew feature or request

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions