SuperAPI AI 工具集

docs-testing

测试与质量

查看项目

更新于 10-16 06:19

技能介绍

用途:为在 influxdata/docs-v2 仓库中工作的智能体提供测试决策指南,按改动的文件类型映射到应运行的具体测试命令,并说明哪些检查会自动执行、哪些需手动运行。

主要能力:提供决策表,覆盖 content//*.md、content/shared//.md、layouts/**/.html、assets/js/.ts、assets 样式文件、data/products.yml、api-docs/**/.yml、*.sh 及仓库文档等改动类型,分别列出 pre-commit 自动项、需本地运行的命令和 PR 上的 CI 检查。说明自动化覆盖范围:pre-commit(lefthook.yml)运行废弃 markdown 模式、支持链接、source 路径、render hook 空白、反馈链接、Vale、remark、TypeScript 构建、prettier、ESLint、shellcheck;pre-push 运行依赖审计与 Cypress shortcode 示例;CI 包含 Vale、链接检查、发布提醒、codeblock lint、render 检查、remark、反馈链接、lockfile 校验、预览部署等。

使用方式:按需运行具体测试,如 yarn lint-codeblocks、yarn test:codeblocks:<product>、link-checker map/check、.ci/vale/vale.sh、node cypress/support/run-e2e-specs.js、yarn build:md 与 yarn check:md-coherence。代码块执行测试需 Docker、构建 docs-pytest 镜像及 .env.test,且不在 PR 检查中,需手动或 workflow_dispatch 触发。

限制与缺口:SQL、InfluxQL 语法不被 lint-codeblocks 覆盖;仅 influxdb3_core 与 influxdb3_enterprise 在 CI 中对真实服务器执行代码块;v1、explorer 无 pytest 服务;assets/js 无单元测试框架;无自动化无障碍测试;共享内容改动不会自动检测消费产品,需用 grep 查找 stub;跨产品链接正确性未端到端验证。依赖更新由组织统一管理,不应新增并行机制。