mcpField
A
allure-configure-agent-workflow

allure-configure-agent-workflow

github.com/allure-frameworkAgent 工作流1173 次安装18 周前更新
代码仓库

关于 allure-configure-agent-workflow

用于配置项目指引的技能,让编码 Agent 在测试工作和评审中使用 Allure agent mode。它建立项目指南并配置根目录指引文件路由,同时要求核实 CLI 能力,避免记录未经确认的命令或测试约定。

主要功能

  1. 01创建 Allure agent mode 指南
  2. 02将 Agent 入口文件指向指南
  3. 03检查本地 CLI 能力
  4. 04记录测试与证据规范
  5. 05以增量方式修改项目

适用场景

  1. 01为测试工作准备 Agent 指引
  2. 02报告配置变更后更新 Allure 说明
  3. 03记录本地测试命令与证据
  4. 04将多个 Agent 运行环境指向共用指南

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/allure-framework/skills --skill allure-configure-agent-workflow

安装后在 Claude Code 中输入/allure-configure-agent-workflow确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

CLAUDE.md
agents/
openai.yaml
references/
project-guide-template.md
root-agent-entry-snippet.md

详细介绍

配置 Allure Agent 工作流

当项目希望使用 Allure Agent 模式,为测试工作和测试评审配置 AI/编码 Agent 工作流指导时,请使用此技能。

如果主要目标是安装框架适配器、让测试生成 Allure 结果、添加报告脚本或配置 CI 报告发布,请改用 allure-configure-reporting。

此技能旨在让 Agent 因为 Allure 报告确实有用而主动使用它,而不是为了管束它们。所有路由说明和 docs/allure-agent-mode.md 都要以价值说明开篇;references/root-agent-entry-snippet.md 提供了标准措辞(测试运行是一种观测工具,不是供人抓取通过/失败结果的东西;通过 allure agent 运行,可以生成一份可供评审的运行情况记录,以及关于测试本身的自动化发现,并以 --goal 为锚点,方便你、上游 Agent 或人工进行验证)。

其中应包含这一价值说明和核心循环(带目标运行、以预期为证据、失败分流并仅重跑失败项、CI inspect、将测试用作调试工具),并阅读 Agent 输出,而不是抓取控制台内容。先说明 Agent 模式的价值;详细的阅读清单和命令细节应放在 docs/allure-agent-mode.md,不要放在路由说明中。控制台反模式(对运行结果使用 tail/grep/head/>/dev/null)应作为简短脚注,而不是标题。

路由说明还要包含一个编写门槛:在编写或实质性修改测试之前,Agent 必须调用 $allure-agent-mode 并阅读其 test-design.md 参考文档。路由说明是每次会话都会加载的唯一指导,因此它是捕捉任务中途编写测试的唯一位置(例如在“实现阶段 2”中),此时任何请求时的技能匹配早已结束。明确以命令语气说明此门槛;将其限定于编写测试和非小幅修改,而非每次接触测试文件。由于未安装的技能无法加载,请在 docs/allure-agent-mode.md 中内嵌一组精简的核心测试设计要求,作为最低标准。

目标

为项目提供以下内容:

  • 根目录 Agent 入口文件中的路由指导,将测试工作指向 docs/allure-agent-mode.md,并覆盖仓库中使用的每一种 Agent 运行环境。这些入口文件不可互换:Claude Code 会加载 CLAUDE.md,不会读取 AGENTS.md;而大多数其他 Agent 工具(Codex、Cursor 等)会读取跨工具通用的 AGENTS.md。有些工具会读取自己的文件。不要遗漏任何目标运行环境。
  • 一份项目级 docs/allure-agent-mode.md 指南,涵盖本地封装器、功能、Allure 集成、测试设计约定、运行配置、预期控制、本地/CI 现有结果或转储检查支持、人工报告模式策略、输出/状态策略、执行信号说明、元数据约定和证据约定
  • 足够的 Allure 引导说明,让 Agent 即使在项目尚未完全配置时也能继续工作

工作流

  1. 检查项目是否已生成 Allure 结果,或是否已有 Allure 配置。
  2. 如果缺少 Allure,且用户希望配置报告,则交由 allure-configure-reporting 处理。如果用户只需要 Agent 工作流指导,则将缺少的报告配置记录为未知或受阻。
  3. 在将受支持的命令或标志写入项目指南前,使用项目包装器、allure --version、allure agent --help 和 allure agent capabilities --json 检查当前本地 Allure CLI 功能。如果需要检查现有结果或转储,也要在包装器提供 allure agent inspect 时检查 allure agent inspect --help。如果检测到的 Allure CLI 版本低于 3.11.0,则告知用户,完整的 Agent 模式运行时证据工作流需要 [email protected] 或更高版本,并将 Agent 执行标记为不受支持或受限。如果需要检查现有结果,且检测到的 CLI 版本低于 3.12.0,或不具备 agent inspect,则将检查功能标记为不受支持或受限。仅使用版本检查确认支持情况并警告旧版 CLI;不要在项目文档中写入检测到的 Allure 确切版本。
  4. 发现或记录本地测试信息:测试框架、包装器、测试根目录、Allure 集成、Allure 结果路径、运行配置、受支持的选择器、预期控制、输出/状态/重跑行为、现有结果或转储检查支持情况、元数据约定、证据约定,以及可见的 CI/默认命令执行信号。区分 Agent 输出、框架 Allure 结果、转储工件和生成的报告。
  5. 只有在本地证据、已安装工具的帮助信息、Allure/测试运行器官方文档或软件包 README/源码确认后,才能将命令标志、配置键和环境变量视为受支持。如果无法确认,则写 unknown,不要猜测。
  6. 如果在 allure-configure-reporting 更改报告配置后使用此技能,则刷新 docs/allure-agent-mode.md 中任何过时的本地包装器、测试命令、Allure 结果路径、集成、CI 工件、运行配置和证据约定。
  7. 创建或更新根目录的 Agent 入口文件,使测试相关工作指向 docs/allure-agent-mode.md。每种 Agent 运行时都会读取自己的入口文件,二者不能互换:Claude Code 会加载 CLAUDE.md,不会读取 AGENTS.md;而大多数其他 Agent 工具(Codex、Cursor 等)会读取跨工具的 AGENTS.md。优先遵循现有项目约定。如果不存在入口文件,则同时创建 AGENTS.md 和 CLAUDE.md,确保 Claude Code 和基于 AGENTS.md 的工具都有路由文件;如果项目希望只有一个事实来源,可将 CLAUDE.md 设为指向 AGENTS.md 的符号链接,或在其中放入相同的简短片段。如果某种运行时已有入口文件,而另一个也适用于该仓库的运行时没有,则添加缺失的入口文件,不要假设已有文件可通用。确保该片段易于复制到其他特定模型的指令文件中。
  8. 根据随附模板创建 docs/allure-agent-mode.md,只调整必须针对项目定制的部分。
  9. 保持辅助命令说明简短实用。只有在本地环境确认后,才将准确命令和受支持的标志写入生成的项目指南。
  10. 尽量减少更改,并以增补为主。保留所修改入口文件中无关的项目指导内容。

要使用的文件

  • 项目指南模板:references/project-guide-template.md
  • Agent 入口文件路由片段:references/root-agent-entry-snippet.md

护栏

  • 保持 Agent 入口文件简短:只包含精简的价值框架和路由指引。它们承载框架和核心循环,但不得重复指南中的详细阅读清单、命令目录或各循环的具体步骤。
  • 保持辅助命令说明简短。优先使用单行描述,避免命令目录不断扩充。
  • 不要在生成的项目文件中存储确切的 Allure 版本。不要添加诸如 Detected Allure CLI: 3.8.2 或 Allure version: ... 之类的字段;应存储封装器、能力快照的时间戳或提交,以及刷新命令。
  • 除非仓库已有相关约定,否则不要臆造特定于项目的元数据约定。
  • 不要臆造 CI 门禁状态、运行配置、选择器支持、Allure 集成状态、元数据约定、证据约定或预期控制。未知项应明确标记为未知。
  • 不要在项目指南中创建持久化的 Agent 输出路径或预期路径。现代 allure agent 默认会创建并打印临时输出目录;在 [email protected] 及更高版本中,每次运行都会删除上一次由 CLI 提供的临时输出。仅当项目有明确约定时才记录显式的 --output 路径,并说明 Agent 只会清理其提供的 --output 路径。框架的 Allure 结果(例如 <parent>/allure-results)是独立的;无需在运行之间清除它们,因为 Agent 模式只会检测当前运行中新产生的结果,因此将此交由项目自行决定。
  • 不要在 Agent 命令中臆造框架结果目录环境变量,例如 ALLURE_RESULTS_DIR。只有在本地适配器、已安装工具的帮助信息、官方文档或软件包 README/源码确认这些变量后,才记录它们;如果 Allure 需要发现结果,则最终目录名应保持为 allure-results。
  • 除非 allure agent capabilities --json 或本地帮助信息确认了该命令以及确切的输入/输出语法,否则不要声称 allure agent inspect 支持已有结果或转储产物。仅有版本输出并不足以确认。
  • 生成 docs/allure-agent-mode.md 时,即使为精简篇幅,也必须保留其运行时信任底线:并发运行必须各自使用由调用方管理的 --output 目录(默认临时输出不适用于并发),不得共享输出或预期状态;预期运行必须针对目标范围使用全新的预期;未表示为逻辑测试的运行器可见故障必须通过检查全局 stderr 来审查,并附上部分审查说明。
  • 如果项目已有更完善的 Allure 说明,应谨慎合并,而不是直接覆盖。

评论

支持 Markdown