mindspore-ai/docs/doc-release
Claude Code and agent skill by mindspore-ai/docs
- community
Checking that the SKILL.md file is still in the repository.
MindSpore 文档发布新分支时,链接更替与组件清洗技能,用于清理组件和替换链接。
Install
npx vskill@latest install mindspore-ai/docs/doc-releaseSKILL.md
The same SKILL.md was published earlier as mindspore-ai/docs/doc-release.
OpenCode Skill: 文档发布 Skill
技能元信息
| 属性 | 值 | |
|---|---|---|
| 技能名称 | 文档发布 Skill | |
| 适用项目 | MindSpore 文档仓库 | |
| 维护者 | MindSpore Docs Team |
技能描述
文档发布 Skill,用于 MindSpore 文档发布分支内容处理。发布新版本时,将文档从开发分支同步到发布分支,清理不发布的组件,并修正文档内部指向旧分支的链接。
本技能通过精确的正则表达式匹配,覆盖多种链接格式(OBS 资源链接、OBS Notebook 链接、atomgit 链接、官网链接、git clone 命令等),确保文档中的链接在新版本中正确指向目标分支。
核心特性:
source_branch参数可配置为任意分支名(master、r2.9.0、dev等)- 官网链接使用
target_html_branch,仓库链接使用tag(仅 MindSpore 系列有 tag) - 增加链接有效性检测功能
- 支持
.ipynb(Jupyter Notebook) 文件中的链接替换 - 组件清洗,仅保留需要的组件目录
- 支持
git clone命令(含带-b、不带-b两种形式)的分支替换 - 保留 `git clone URL -b {version}` 形式(
-b在 URL 后面,占位符形式,不替换) - 自动处理所有 RST 文件中的网格表格折行 URL,无需维护文件清单
触发条件
当用户需要执行以下操作时触发本技能:
- 发布新版本,需要将文档从开发分支迁移到发布分支
- 清理文档仓库中不发布的组件文件夹
- 批量修正文档中指向旧分支的链接
- 验证替换后的仓库链接是否有效
限制条件
- 组件清洗仅在仓库根目录的
docs/目录下执行 - 链接替换作用于以下三个目录:
docs/tutorials/install/- 文件类型处理:
.md/.txt/.html/.yml/.yaml/.ipynb:普通正则替换.rst:网格表格按"逐逻辑行还原折行 URL → 替换 → 重新折行"处理(列宽按显示宽度计算),非表格区域直接替换
⚠️ 运行前请确保当前工作目录为仓库根目录(即tutorials/、install/、docs/所在的那一层)。
输入参数
| 参数名 | 类型 | 必填 | 默认值 | 说明 | |
|---|---|---|---|---|---|
source_branch | string | 否 | master | 源旧分支名称(可以是任意分支名) | |
components_to_keep | list[string] | 是 | - | 需要保留的组件白名单(sample_code 目录始终保留) | |
component_branch_map | map[string]object | 是 | - | 组件到目标分支的映射配置 | |
enable_link_check | boolean | 否 | true | 是否启用替换后的链接有效性检测 |
component_branch_map 配置说明
每个组件配置包含以下字段:
| 字段 | 类型 | 必填 | 说明 | |
|---|---|---|---|---|
repo_name | string | 是 | atomgit 仓库名称 | |
has_git | boolean | 是 | 是否有独立的 atomgit 仓库(true/false) | |
target_html_branch | string | 是 | 官网 HTML 分支(如 r2.10.0、r2.0.0、r0.7、81RC1) | |
tag | string | 否 | 仓库 tag(如 v2.10.0),只有 MindSpore 有 tag | |
url_name | string | 是 | 官网链接 cn/ 后的路径名(如 tutorials、docs、lite、mindquantum) |
组件配置参考表
字段说明:
| 字段 | 说明 | |
|---|---|---|
repo_name | 仓库名 | |
has_git | 是否有独立仓库 | |
source_branch | 源分支(通常为 master) | |
target_html_branch | 目标 HTML 分支(用于官网链接和 OBS 链接) | |
tag | 仓库 tag(仅 MindSpore 有) | |
url_name | 官网链接 cn/ 后的路径名 |
官网链接格式说明
官网链接形如:
其中 url_name(如 tutorials、docs、lite)是 cn/ 后的路径名,master 是源分支。
替换后:
特殊组件说明
| 组件 | 特殊处理 | |
|---|---|---|
tutorials | 需额外处理教程专属链接:mindspore.cn/tutorials/... | |
mindspore | 需额外处理 docs 仓链接:atomgit.com/mindspore/docs/... 和 OBS 链接 |
.ipynb 文件处理说明
.ipynb 是 JSON 格式文件,其中的链接通常以未转义的普通形式存储,例如:
由于这些链接是普通字符串(非正则表达式),不需要额外的转义处理,直接将 .ipynb 加入文件后缀列表即可。
执行步骤
步骤 1:清理不发布的组件
在 docs/docs 目录下,删除不在白名单中的组件文件夹。sample_code 目录始终保留。
执行逻辑
- 构建保留列表:
["sample_code"] + components_to_keep - 遍历
docs/docs目录下的所有一级子目录 - 如果目录名不在保留列表中,执行删除
执行代码
步骤 2:替换分支链接并检测有效性(普通文件 + RST)
在 docs/、tutorials/、install/ 三个目录下,对所有支持的文件替换分支名:
.md/.txt/.html/.yml/.yaml/.ipynb:普通正则替换.rst:网格表格按"逐逻辑行还原折行 URL → 替换 → 重新折行"处理(列宽按显示宽度计算),非表格区域直接替换
替换规则说明
| 链接类型 | 使用的字段 | 示例(source_branch=master, target_html_branch=r2.11.0, tag=v2.11.0) | |
|---|---|---|---|
| OBS 资源链接 | target_html_branch | website-images/master/resource/... → website-images/r2.11.0/resource/... | |
| OBS Notebook 链接 | target_html_branch | notebook/master/tutorials/... → notebook/r2.11.0/tutorials/... | |
| 官网链接 | target_html_branch | mindspore.cn/docs/zh-CN/master/ → .../r2.11.0/ | |
| atomgit docs 仓链接 | target_html_branch | docs/blob/master/tutorials/... → docs/blob/r2.11.0/tutorials/... | |
| atomgit 仓库链接 | tag(无 tag 用 target_html_branch) | mindspore/blob/master/... → mindspore/blob/v2.11.0/... | |
git clone(-b 在前) | tag(无 tag 用 target_html_branch) | git clone -b master ... → git clone -b v2.11.0 ... | |
git clone(不带 -b) | tag(无 tag 用 target_html_branch) | git clone https://.../mindspore.git → git clone -b v2.11.0 https://.../mindspore.git | |
| git clone(`-b` 在 URL 后,占位符) | 不替换 | git clone ...git -b {version} → 保留原样 | |
| RST 网格表格折行 URL | 同上 | 由本步骤的 RST 分支自动处理 |
执行代码
This is the start of the file. Read the full SKILL.md on GitHub.
Security
- Security scanPassed, 90 of 100Pattern checks on the skill's files.
- Model reviewPassed
Quality evaluation
- Task evaluationNot runNo evaluation yet. Run one in Skill Studio.
Source
- SKILL.md in the repositoryCheckingskills/doc-release/SKILL.md
Popularity
- Repository stars
- 167
- Repository forks
- 33
- 7-day trend score
- 31
Stars and forks are for the whole GitHub repository, not this skill alone. Not refreshed yet.
Works with
Any agent vskill installs to: 56 targets in all. These 39 have a page on this site.
- Claude Code
- Cursor
- GitHub Copilot
- Windsurf
- Codex
- Gemini CLI
- Cline
- Amp
- Roo Code
- Goose
- Continue
- Kilo Code
- Junie
- Trae
- OpenHands
- Qwen Code
- AI Agent
- Tabnine Chat
- Sourcegraph Cody
- Amazon Q
- Firebase Genkit
- Sweep
- Devin
- Phind
- Mentat
- Claude Desktop
- Aider
- GPT Pilot
- Plandex
- bolt.new
- v0
- Replit Agent
- Anse
- TypingMind
- BetterChatGPT
- LibreChat
- Warp AI
- Pieces
- Fig AI
Embed badge
[](https://verified-skill.com/skills/mindspore-ai/docs/doc-release)