4.4 KB · updated 2026-07-06 · md

publishing-checklist.zh.md

docs/i18n/publishing-checklist.zh.md

发布检查清单

<!-- translations:start -->

English · 한국어 · 中文 · 日本語 · Русский · Español · Français · Deutsch

<!-- translations:end --> 在公开展示 Tesserae 之前使用此检查清单。

仓库卫生

  • [ ] README 说明项目是什么以及它解决什么问题。
  • [ ] 安装命令可在全新的 shell 中运行。
  • [ ] Quickstart 使用 tesserae,而不是 python3 -m
  • [ ] 架构文档解释原始证据 → 图谱 → 投影。
  • [ ] 功能图列出已实现的功能,不夸大未来工作。
  • [ ] 会话历史文档解释显式导入、隐私审查、生成的 routes 和 transcript typography。
  • [ ] Self-dogfood 演示已经运行并记录。
  • [ ] 生成的产物可复现,并且要么被忽略,要么有意发布。

验证

.venv/bin/pytest tests/ -x          # 任何失败都要中止 — 绝不发布红色构建
./scripts/install.sh --help
tesserae init --help
tesserae compile --help
tesserae context --help     # 按需上下文编译器

演示构建冒烟测试(与 build-demo CI 作业一致)

发布流程和 CI 都使用确定性提取器(无 LLM 调用,无需 API key)将 Tesserae 针对 其自身源码树编译,并构建站点:

.venv/bin/python -m tesserae init --yes --source .
.venv/bin/python -m tesserae compile
.venv/bin/python -m tesserae export site

发布流程

release 技能(.claude/skills/release/SKILL.md)驱动。最新标签为 v0.5.0

  • [ ] 在 main 上,工作树干净,执行 git pull --ff-only origin main
  • [ ] 测试 + 演示构建冒烟测试(上面)通过。
  • [ ] 提升 pyproject.tomlversion = "X.Y.Z"(若有 package.json 也同步),并以从 git log v<prev>..HEAD 生成的一段变更日志提交 release: vX.Y.Z
  • [ ] 用 git tag -a vX.Y.Z -m "vX.Y.Z" 打标签,先推送提交再推送标签。
  • [ ] 等待 CI 变绿(gh run watch <run-id>)—— 不要在红色构建上发布 GitHub release。
  • [ ] 发布 GitHub release。PyPI 发布为可选(准备就绪时)。

GitHub Pages

build-demo 工作流(推送到 main)始终将编译后的 dogfood 站点作为可检查的工作流 产物上传,并在启用 Pages 时额外部署到 GitHub Pages。Pages 步骤为 continue-on-error:默认的 GITHUB_TOKEN 无法*创建* Pages 站点,因此首次部署需要在 Settings → Pages → Source: GitHub Actions 处手动切换一次。在打开该开关之前,构建 仍保持绿色,产物也仍会生成。

Self-dogfood

集成选项(Understand Anything、RAG-Anything、cognee)现在是交互式向导提示, 而不是 CLI 标志。运行向导并回答它们:

tesserae init \
  --name tesserae_self \
  --source README.md \
  --source docs \
  --source tesserae \
  --source tests \
  --source scripts
# 当向导提示时:
#   - 启用 Understand Anything(平台:codex),安装:是
#   - 启用 RAG-Anything,安装:是,解析器:mineru,之后运行:是
#   - 启用 cognee,安装:是
tesserae compile
tesserae sessions list
tesserae export site
tesserae serve --port 8765

如需完全非交互式运行,请使用 tesserae init --yes(所有集成关闭),然后在 .tesserae/config.json 中启用每个集成——向导会将它们写入 memory_backends (cognee)和 external_tools(Understand Anything、RAG-Anything)键下——并在编译 前对每个集成运行 tesserae integrations refresh <name>。确切的配置键请参阅集成 文档。

演示要点

  • Tesserae 不是通用的名词短语图谱。它使用受控 ontology。
  • 研究和开发代码共享基础设施,但保持不同的 schema。
  • Markdown 和 HTML 是投影,而不是权威事实存储。
  • 默认路径是本地的,并且不需要 API key,易于使用。
  • 智能体 harness 和 MCP 让编码智能体可以使用该图谱。
  • 导入的 harness 会话页面把之前的 Claude Code/Codex 工作转化为可搜索的项目记忆,同时保持 transcript 发现为显式操作。