Skip to content

语言与镜像(changelog / changelogDoc) ​

多语言 CHANGELOG 的语言表,以及文档站更新页镜像的路径与页头。

changelog:语言表 ​

字段类型默认说明
languagesobject无追加或覆盖语言;内置 zh/en,配置同名 key 覆盖内置,新 key 追加(同名 key 为整体覆盖,非字段级深合并:配了某语言,其未写的段也不会落到内置)

每个语言为四段结构:

json
{
  "changelog": {
    "languages": {
      "en": {
        "groups": [
          { "slot": "breaking", "title": "### 🚨 Breaking Changes" },
          { "slot": "added", "title": "### ✨ New Features" },
          { "slot": "fixed", "title": "### 🐛 Bug Fixes" },
          { "slot": "other", "title": "### 📦 Other" }
        ],
        "replacements": { "### Major Changes": "### 🚨 Breaking Changes" },
        "deps": "- Updated dependencies",
        "released": "released"
      }
    }
  }
}
字段说明
groups语义分组表(可选、有序,组序即输出顺序):每项 { slot, title, prefixes? }——slot 取全局语义槽位(breaking/added/changed/improved/fixed/docs/removed/deps/other),title 为本语言组标题,prefixes 为本语言自有类型前缀(可选,识别时与全局前缀表取并集);缺省时不改分组结构,只剥离可识别前缀并应用 replacements
replacements兜底替换映射(源标题 → 目标标题)
deps依赖更新条目文案
released发布日期后缀(同时用于识别既有日期行)

changelogDoc:文档站更新页镜像 ​

字段类型默认说明
sourcestringCHANGELOG.md根 CHANGELOG 路径;--lang 非默认语言时追加语言后缀
targetstringdocs/changelog.md镜像页路径
titlestring更新日志镜像页 H1
outlinestring[2, 2]VitePress frontmatter outline
frontmatterbooleantrue是否写 frontmatter;--no-frontmatter 可本次关闭
notestring内置来源说明页头来源说明文案
splitstringmajor是否按主版本分页:major 主页只保留最新主版本、其余主版本归档为 <目标目录>/<major>.x.md;none 退回整篇镜像;非法值告警后按 major 处理

split 为 major 时,归档目录取镜像目标去扩展名的同名目录: docs/changelog.md → docs/changelog/、docs/changelog.en.md → docs/changelog.en/,中英归档互不覆盖。 只有单一主版本时不生成归档页、不加历史版本入口,输出与原整篇镜像逐字一致;多主版本时主页紧随页头追加一行「历史版本」入口。 归档页带生成标记,同步只清理带标记且本次不再生成的页;无标记的多余页保留,并由 --check 报错提示人工处理。

toolkit release mirror 与 release bump 发版后的自动同步共用本段;CLI 显式参数优先。非法值告警后按默认处理。

相关页面 ​

MIT 开源协议