allure-configure-agent-workflow
About allure-configure-agent-workflow
A skill for configuring project guidance so coding agents use Allure agent mode for test work and reviews. It establishes a project-specific guide and root instruction-file routing, with checks to avoid documenting unsupported commands or test conventions.
Key features
- 01Create Allure agent-mode guidance
- 02Route agent entry files to the guide
- 03Check local CLI capabilities
- 04Document test and evidence practices
- 05Keep project changes additive
Use cases
- 01Preparing agent guidance for test work
- 02Updating Allure instructions after reporting changes
- 03Documenting local test commands and evidence
- 04Routing multiple agent runtimes to shared guidance
Install
Copy the command and run it in a terminal.
npx skills add https:/ / github.com/ allure-framework/ skills --skill allure-configure-agent-workflowAfter installing, type/allure-configure-agent-workflowin Claude Code to confirm it loaded.
Bundled files
References and scripts installed along with SKILL.md.
CLAUDE.mdagents/openai.yamlreferences/project-guide-template.mdroot-agent-entry-snippet.mdDetails
From the project READMEConfigure Allure Agent Workflow
Use this skill when a project wants to configure AI/coding-agent workflow guidance for test work and test reviews with Allure agent mode.
If the primary goal is to install framework adapters, make tests emit Allure results, add report scripts, or configure CI report publishing, use allure-configure-reporting instead.
This skill makes agents reach for Allure's reporting because it is useful — not to police them. Lead every router and docs/allure-agent-mode.md with the value frame; references/root-agent-entry-snippet.md carries the canonical wording (a test run is an instrument, not a pass/fail to scrape; running through allure agent yields a reviewable account of what happened plus automated findings about the tests themselves, anchored by a --goal so you, an upstream agent, or a human can validate it).
Carry that frame plus the core loops (run-with-goal, expectations-as-evidence, failure-triage and rerun-just-the-failed, CI inspect, tests-as-debug-instrument), and read the agent output rather than scraping the console. Lead with why agent mode helps; keep detailed reading lists and command specifics in docs/allure-agent-mode.md, not the router. The console anti-pattern (tail/grep/head/>/dev/null of a run) belongs as a short footnote, not the headline.
The router also carries an authoring gate: before writing or materially changing a test, the agent must invoke $allure-agent-mode and read its test-design.md reference. The router is the only guidance loaded every session, so it is the one place that catches test authoring mid-task (e.g. inside "implement phase 2"), long after any request-time skill match. State the gate imperatively; scope it to authoring and non-trivial changes, not every test-file touch. Because the gate cannot load a skill that is not installed, keep a compact set of core test-design non-negotiables inline in docs/allure-agent-mode.md as the floor.
Goal
Leave the project with:
- root agent entry-file router guidance that points test work to
docs/allure-agent-mode.md, present for every agent runtime used in the repo. These entry files are not interchangeable: Claude Code loadsCLAUDE.mdand does not readAGENTS.md, while most other agent tools (Codex, Cursor, and others) read the cross-toolAGENTS.md. Some tools read their own files. Do not leave any targeted runtime without a router. - a project
docs/allure-agent-mode.mdguide with local wrappers, capabilities, Allure integrations, test-design conventions, run profiles, expectation controls, local/CI existing-result or dump inspection support, human-report mode policy, output/state policy, execution-signal notes, metadata conventions, and evidence conventions - enough Allure bootstrap guidance for the agent to continue, even if the project is not fully configured yet
Workflow
- Check whether the project already emits Allure results or already has Allure configuration.
- If Allure is missing and the user wants reporting configured, hand off to
allure-configure-reporting. If the user only wants agent workflow guidance, document the missing reporting setup as unknown or blocked. - Inspect the current local Allure CLI capabilities with the project wrapper,
allure --version,allure agent --help, andallure agent capabilities --jsonbefore writing supported commands or flags into project guidance. If existing-result or dump review is in scope, also checkallure agent inspect --helpwhen the wrapper exposes it. If the detected Allure CLI version is lower than3.11.0, warn the user that the full agent-mode runtime-evidence workflow requires[email protected]or newer and mark agent execution as unsupported or limited. If existing-result inspection is in scope and the detected CLI is lower than3.12.0or lacksagent inspect, mark inspect as unsupported or limited. Use version checks only to confirm support and warn on old CLIs; do not write the exact detected Allure version into project docs. - Discover or document local test facts: test frameworks, wrappers, test roots, Allure integrations, Allure results paths, run profiles, supported selectors, expectation controls, output/state/rerun behavior, existing-result or dump inspection support, metadata conventions, evidence conventions, and CI/default-command execution signal when visible. Keep agent output, framework Allure results, dump artifacts, and generated reports distinct.
- Treat command flags, config keys, and environment variables as supported only after local evidence, installed help, official Allure/test-runner docs, or package README/source confirms them. If they cannot be confirmed, write
unknowninstead of guessing. - If this skill is being used after
allure-configure-reportingchanged reporting configuration, refresh any stale local wrappers, test commands, Allure results paths, integrations, CI artifacts, run profiles, and evidence conventions indocs/allure-agent-mode.md. - Create or update root agent entry files so test-related work points to
docs/allure-agent-mode.md. Each agent runtime reads its own entry file and they are not interchangeable: Claude Code loadsCLAUDE.mdand does not readAGENTS.md, while most other agent tools (Codex, Cursor, and others) read the cross-toolAGENTS.md. Honor existing project conventions first. When no entry file exists, create bothAGENTS.mdandCLAUDE.mdso neither Claude Code nor theAGENTS.md-based tools are left without the router; if the project wants a single source of truth, makeCLAUDE.mda symlink toAGENTS.mdor have it carry the same short snippet. When an entry file exists for one runtime but not another that works in the repo, add the missing one rather than assuming the existing file is shared. Keep the snippet easy to copy into other model-specific instruction files. - Create
docs/allure-agent-mode.mdfrom the bundled template and adapt only the parts that must be project-specific. - Keep helper-command descriptions short and practical. Put exact commands and supported flags in the generated project guide only after confirming them in the local environment.
- Keep changes minimal and additive. Preserve unrelated project guidance in every entry file you touch.
Files To Use
- Project guide template:
references/project-guide-template.md - Agent entry-file router snippet:
references/root-agent-entry-snippet.md
Guardrails
- Keep agent entry files short: the compact value frame plus routing pointers. They carry the frame and the core loops, but must not duplicate the guide's detailed reading lists, command catalog, or per-loop steps.
- Keep helper-command notes short. Prefer one-line descriptions over a growing command catalog.
- Do not store exact Allure versions in generated project files. Do not add fields such as
Detected Allure CLI: 3.8.2orAllure version: ...; store the wrapper, a capability snapshot timestamp or commit, and refresh commands instead. - Do not invent project-specific metadata conventions unless the repo already uses them.
- Do not invent CI gating status, run profiles, selector support, Allure integration status, metadata conventions, evidence conventions, or expectation controls. Mark unknowns explicitly.
- Do not create persistent agent output or expectation paths in the project guide. Modern
allure agentcreates and prints a temp output directory by default, and in[email protected]and newer each run removes the previous run's CLI-provided temp output. Document explicit--outputpaths only when the project has a concrete convention, and state that the agent cleans only the--outputpath it provides. The framework's Allure results (such as<parent>/allure-results) are separate; clearing them between runs is unnecessary because agent mode detects only the current run's new results, so leave that to project preference. - Do not synthesize framework result-directory environment variables such as
ALLURE_RESULTS_DIRin agent commands. Document them only when the local adapter, installed help, official docs, or package README/source confirms them, and keep the final directory nameallure-resultswhen the results must be discovered by Allure. - Do not claim
allure agent inspectsupport for existing results or dump artifacts unlessallure agent capabilities --jsonor local help confirms the command and the exact input/output syntax. Version output alone is not enough. - When generating
docs/allure-agent-mode.md, keep its runtime-trust floors even when trimming for length: concurrent runs must each use their own caller-managed--outputdirectory (the default temp output is unsafe for concurrency) and never share output or expectation state, expectation runs must use fresh expectations for the intended scope, and runner-visible failures not represented as logical tests require global-stderr inspection plus a partial-review note. - If the project already has better Allure instructions, merge carefully instead of overwriting them.