用途:从缓存的 PR JSON 文件生成 huggingface_hub 的发布说明,读取 PR 元数据、分类条目并产出格式化 Markdown 文档。输出目录由提示指定为 <output_dir>。
主要能力与流程:
- 读取 <output_dir>/tmp/pr_*.json 中的全部 PR 数据,字段包括 number、title、author、merged_at、body、labels、url 及 doc_diffs(docs/ 下 .md 文件的 unified diff,无文档改动时为空数组)。
- 识别 highlight:带 "highlight" 标签,或经判断足够重要(重大新功能、明显 UX 改进、显著破坏性变更)的 PR。每个 highlight 含 emoji 标题、2-5 句叙述性摘要、必要时附代码示例、以及每条 PR 的署名行(- PR title by @author in #1234)。
- 对非 highlight PR,依据 references/sections.md 的启发式规则,按标签、标题关键词、正文内容分类到各标准章节。
- 优先使用 doc_diffs 理解文档改动、提取代码示例;必要时抓取文档页确认,仅链接已实际抓取并验证的页面,禁止编造文档 URL。
- 输出到 <output_dir>/RELEASE_NOTES_<version>.md,标题使用基础版本号(如 [v1.8.0],即使为 v1.8.0.rc0)。
- 质量检查:<output_dir>/tmp/ 中每个 PR 恰好出现一次;不得包含 tmp/ 中无对应文件的 PR;无空章节;emoji 标题一致;每项以 by @author in #1234 结尾;文档链接指向真实已验证页面。
输入:版本字符串(如 "v1.3.8")与 <output_dir>/tmp/ 中的 PR JSON 文件。输出:<output_dir>/RELEASE_NOTES_<version>.md。
资源:references/release-notes-template.md(骨架结构)、references/sections.md(关键词章节映射)、文档站 https://huggingface.co/docs/huggingface_hub/main/en/index。
限制:仅处理 tmp/ 中已有 JSON 的 PR;文档链接须经抓取验证;内部/CI/测试类 PR 不加文档链接。