| 文件 | 最后提交记录 | 最后更新时间 |
|---|---|---|
ci: add markdown validation gate Co-authored-by: LZH<liuzhihan2@h-partners.com> # message auto-generated for no-merge-commit merge: !227 merge master into master ci: add markdown validation gate Created-by: LZH_unofficial Commit-by: LZH Merged-by: cann-robot Description: ### 当前PR是否有AI参与 - [ ] 否 - [x] 是 1. AI Agent 平台:OpenAI Codex。 2. AI 模型:GPT-6。 3. Prompt 上下文:分析 cann/ops-transformer 的文档检查流水线,复用 CANN 公共 staticcheck Action,将 md_check 接入 cannbot-dsl 的 CodeCheck 阶段;验证正常 Markdown、失效链接和无 Markdown 变更三种场景,并迁移已验证的配置。 ### PR功能描述 / 为什么需要这个合入 当前流水线缺少独立的 Markdown 检查任务。本 PR 在 CodeCheck 阶段接入 CodeCheck_staticcheck_md_check,复用 cann/.gitcode/actions/staticcheck@master 的公共规则,使文档中的失效链接、缺失资源、标签及编码问题能够触发 CI 失败。 本次仅修改两份工作流,共新增 73 行: - .gitcode/workflows/cannbot-dsl_actions.yml:新增文档检查任务,传入 check_type: md_check,使用镜像任务输出的 staticcheck 镜像,并对已关闭或已合并的 PR 跳过该任务。 - .gitcode/workflows/staticcheck_action.yml:新增可复用工作流,检出 PR 合并结果,下载预处理阶段生成的变更清单和 gitdiff.txt,执行公共检查器,并在检查结束后上传 CSV/JSON 报告;检查失败时也执行报告上传。 ### 该PR关联的issue 无。 ### 希望检视人员了解 - 拦截项:链接有效性、资源存在性、HTML 标签闭合、芯片及位置标签规范、UTF-8 无 BOM 编码。 - Markdown 格式和英文拼写问题沿用公共规则,仅告警、不阻断。 - 检查范围为本次变更的 Markdown 文件,通常只保留变更行上的告警;编码检查覆盖整个变更文件。没有 Markdown 变更时,检查器正常跳过并返回成功。 - 规则由公共 Action 维护;本仓负责工作流接入,沿用现有镜像、预处理产物和 OBS 配置。 ## 改动类型 / Change Type - [ ] Bug 修复 / Bug Fix - [x] 新功能 / New Feature - [ ] 性能优化 / Performance - [ ] 代码重构 / Refactoring - [ ] 文档更新 / Documentation - [ ] 测试相关 / Test - [ ] 其它 / Other ## 测试信息 / Testing - git diff --check 通过;YAML 解析、工作流引用和必填参数检查通过。 - pre-commit run --files .gitcode/workflows/cannbot-dsl_actions.yml .gitcode/workflows/staticcheck_action.yml 通过,包括 YAML、拼写、敏感信息及 OAT 检查。 - 使用公共检查器,以 cannbot-dsl_1971 仓名完成以下本地行为验证: | 场景 | 预期及实际结果 | | --- | --- | | 正常 Markdown | 无告警,退出码 0 | | 指向不存在文件的 Markdown 链接 | StaticCheck_link_validity 标记为“拦截”,退出码 1 | | 仅修改 CI 配置,无 Markdown 变更 | 跳过文档扫描,退出码 0 | - 已在独立验证仓库的 PR 中确认正常文档检查通过、故意失效的链接被线上 CI 拦截。 - 本 PR 的[上游流水线](https://gitcode.com/CANN/cannbot-dsl/actions/runs/c2084cde90e3452fa6794f465e35e911)已触发,线上结果以该流水线为准。 本 PR 仅修改 CI 配置,不涉及算子实现;未新增或重跑算子 UT/ST。 ## 检查清单 / Checklist - [x] 代码符合规范 / Code follows style guide - [x] 已完成配置检查及正例、负例、无文档变更验证 - [x] 已说明检查范围、拦截策略和报告位置 - [x] 无硬编码敏感信息 / No secrets hardcoded - [x] 提交信息符合规范 / Commit message follows convention See merge request: cann/cannbot-dsl!227 | 3 天前 |