allure-configure-agent-workflow について
コーディングエージェントがテスト作業やレビューで Allure agent mode を使うためのプロジェクト指針を整えるスキルです。プロジェクトガイドとルート指示ファイルのルーティングを設定し、未確認のコマンドやテスト規約を記載しないよう促します。
主な機能
- 01Allure agent mode のガイド作成
- 02エージェント入口ファイルからの案内
- 03ローカル CLI 機能の確認
- 04テストと証拠の慣例の記録
- 05既存プロジェクトへの追加的な変更
活用シーン
- 01テスト作業向けエージェント指針の準備
- 02レポート設定変更後の Allure 案内更新
- 03ローカルテストコマンドと証拠の記録
- 04複数のエージェント環境を共通ガイドへ誘導
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ allure-framework/ skills --skill allure-configure-agent-workflowインストール後、Claude Code で/allure-configure-agent-workflowを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
CLAUDE.mdagents/openai.yamlreferences/project-guide-template.mdroot-agent-entry-snippet.md詳細
Allure Agent Workflow の設定
プロジェクトで Allure agent mode を使った、テスト作業やテストレビュー向けの AI/コーディングエージェントのワークフローガイダンスを設定したい場合に、このスキルを使用します。
主な目的が、フレームワークアダプターのインストール、Allure の結果を出力するテストの追加、レポートスクリプトの追加、または CI のレポート公開設定である場合は、代わりに allure-configure-reporting を使用してください。
このスキルは、エージェントが Allure のレポートを役立つものとして活用するよう促すものであり、行動を取り締まるものではありません。すべてのルーターと docs/allure-agent-mode.md の冒頭では、この価値を伝えてください。正式な文言は references/root-agent-entry-snippet.md に記載されています(テスト実行は、合否を拾い上げるためのものではなく、状況を把握するための手段です。allure agent を使って実行すると、何が起きたかを確認できる記録と、テスト自体に関する自動検出結果が得られます。これらは --goal を基準にしており、ユーザー、上流のエージェント、または人間が検証できます)。
この価値を伝える内容に、主要なループ(目標を指定した実行、エビデンスとしての期待値、失敗のトリアージと失敗したテストだけの再実行、CI での inspect、デバッグ手段としてのテスト)を加え、コンソールの内容を拾い上げるのではなく、エージェントの出力を読み取ってください。まずエージェントモードのメリットを伝え、詳細な参考資料やコマンドの説明はルーターではなく docs/allure-agent-mode.md に記載してください。コンソールを使ったアンチパターン(実行結果に対する tail/grep/head/>/dev/null)は、見出しではなく短い脚注として扱ってください。
ルーターには作成時の必須手順も記載します。テストを新規作成または実質的に変更する前に、エージェントは $allure-agent-mode を呼び出し、その test-design.md リファレンスを読む必要があります。ルーターは毎回のセッションで読み込まれる唯一のガイダンスであるため、リクエスト時のスキル照合からかなり時間が経った後のタスク中(たとえば「フェーズ 2 の実装」中)に行われるテスト作成も、ルーターで検知する必要があります。この必須手順は命令形で記載し、作成や重要な変更に限定してください。テストファイルに触れるたびに適用するものではありません。スキルがインストールされていない場合は読み込めないため、テスト設計に関する主要な必須事項を簡潔にまとめ、docs/allure-agent-mode.md に最低限の指針として記載してください。
目標
プロジェクトに次の内容を整備します。
- テスト作業を
docs/allure-agent-mode.mdに誘導する、ルートのエージェント用エントリーファイルのルーターガイダンス。このガイダンスは、リポジトリで使用するすべてのエージェントランタイムに用意してください。これらのエントリーファイルは相互に置き換えられるものではありません。Claude Code はCLAUDE.mdを読み込み、AGENTS.mdは読みません。一方、ほとんどの他のエージェントツール(Codex、Cursor など)は、ツール間で共通のAGENTS.mdを読み込みます。ツールによっては、独自のファイルを読み込むものもあります。対象のランタイムにルーターを設定し忘れないでください。 - ローカルラッパー、機能、Allure の統合、テスト設計の規約、実行プロファイル、期待値の制御、ローカル/CI での既存結果またはダンプの検査対応、人間向けレポートモードのポリシー、出力/状態のポリシー、実行シグナルに関する注記、メタデータの規約、エビデンスの規約を記載した、プロジェクトの
docs/allure-agent-mode.mdガイド - プロジェクトの設定がまだ完全でなくてもエージェントが作業を続けられるだけの、Allure の初期設定ガイダンス
ワークフロー
- プロジェクトがすでに Allure の結果を出力しているか、Allure の設定がすでにあるかを確認します。
- Allure がなく、ユーザーがレポートの設定を希望している場合は、
allure-configure-reportingに引き継ぎます。ユーザーがエージェントのワークフローに関するガイダンスのみを希望している場合は、レポート設定がないことを不明またはブロック中として記載します。 - プロジェクトのラッパー、
allure --version、allure agent --help、allure agent capabilities --jsonを使って、現在のローカル Allure CLI の機能を確認してから、サポートされているコマンドやフラグをプロジェクトのガイダンスに記載します。既存の結果やダンプの確認が対象となる場合は、ラッパーで利用できるならallure agent inspect --helpも確認します。検出された Allure CLI のバージョンが3.11.0未満の場合は、完全なエージェントモードのランタイムエビデンスワークフローには[email protected]以降が必要であることをユーザーに警告し、エージェントの実行を未サポートまたは制限付きとして記載します。既存の結果の確認が対象で、検出された CLI が3.12.0未満、またはagent inspectがない場合は、inspect を未サポートまたは制限付きとして記載します。バージョン確認はサポート状況の確認と古い CLI に対する警告のみに使用し、検出された正確な Allure バージョンをプロジェクトのドキュメントに記載しないでください。 - ローカルのテストに関する情報を調べるか、記載します。対象は、テストフレームワーク、ラッパー、テストルート、Allure インテグレーション、Allure 結果のパス、実行プロファイル、サポートされているセレクター、期待値の制御、出力/状態/再実行の動作、既存の結果やダンプの確認サポート、メタデータの規約、エビデンスの規約、および確認できる場合は CI/デフォルトコマンドの実行シグナルです。エージェントの出力、フレームワークの Allure 結果、ダンプ成果物、生成されたレポートは区別してください。
- コマンドフラグ、設定キー、環境変数をサポート対象として扱うのは、ローカルのエビデンス、インストール済みのヘルプ、Allure/テストランナーの公式ドキュメント、またはパッケージの README/ソースで確認できた場合に限ります。確認できない場合は推測せず、
unknownと記載します。 - このスキルを
allure-configure-reportingによるレポート設定の変更後に使用する場合は、docs/allure-agent-mode.md内の古くなったローカルラッパー、テストコマンド、Allure 結果のパス、インテグレーション、CI 成果物、実行プロファイル、エビデンスの規約を更新します。 - テスト関連の作業が
docs/allure-agent-mode.mdを参照するように、ルートのエージェントエントリーファイルを作成または更新します。各エージェントランタイムはそれぞれ固有のエントリーファイルを読み込むため、相互に置き換えられません。Claude Code はCLAUDE.mdを読み込み、AGENTS.mdは読み込みません。一方、その他のほとんどのエージェントツール(Codex、Cursor など)は、ツール間で共通のAGENTS.mdを読み込みます。まず既存のプロジェクト規約に従ってください。エントリーファイルがない場合は、Claude Code もAGENTS.mdベースのツールも参照先を失わないよう、AGENTS.mdとCLAUDE.mdの両方を作成します。プロジェクトが単一の信頼できる情報源を望む場合は、CLAUDE.mdをAGENTS.mdへのシンボリックリンクにするか、同じ短いスニペットを記載します。あるランタイム向けのエントリーファイルはあるものの、リポジトリで動作する別のランタイム向けのファイルがない場合は、既存のファイルが共通だと決めつけず、不足しているファイルを追加します。スニペットは、ほかのモデル固有の指示ファイルにも簡単にコピーできるようにします。 - 同梱テンプレートから
docs/allure-agent-mode.mdを作成し、プロジェクト固有にする必要がある箇所のみを調整します。 - ヘルパーコマンドの説明は短く、実用的なものにします。正確なコマンドとサポート対象のフラグは、ローカル環境で確認してから生成するプロジェクトガイドに記載します。
- 変更は最小限にとどめ、追加的なものにします。編集するすべてのエントリーファイルで、無関係なプロジェクトガイダンスを保持します。
使用するファイル
- プロジェクトガイドのテンプレート:
references/project-guide-template.md - エージェントのルートエントリールーター用スニペット:
references/root-agent-entry-snippet.md
ガードレール
- エージェントのエントリーファイルは短く保ちます。簡潔な価値の枠組みとルーティングの案内だけにします。これらのファイルには枠組みと主要なループを記載しますが、ガイドの詳細な参照資料一覧、コマンドカタログ、ループごとの手順を重複して記載してはいけません。
- ヘルパーコマンドの説明は短く保ちます。コマンドカタログを増やすのではなく、1行の説明を優先します。
- 生成されるプロジェクトファイルに Allure の正確なバージョンを保存してはいけません。
Detected Allure CLI: 3.8.2やAllure version: ...のようなフィールドは追加せず、ラッパー、機能のスナップショット日時またはコミット、および更新コマンドを保存します。 - リポジトリですでに使用されていない限り、プロジェクト固有のメタデータ規約を作り出してはいけません。
- CI のゲート状況、実行プロファイル、セレクターのサポート、Allure の統合状況、メタデータ規約、証拠の規約、期待値の制御を作り出してはいけません。不明な点は明示します。
- プロジェクトガイドに永続的なエージェント出力パスや期待値パスを作成してはいけません。最新の
allure agentはデフォルトで一時出力ディレクトリを作成して表示し、[email protected]以降では実行のたびに、前回の実行で CLI が指定した一時出力が削除されます。プロジェクトに具体的な規約がある場合に限り、明示的な--outputパスを記載し、エージェントがクリーンアップするのは指定した--outputパスのみであることを明記します。フレームワークの Allure 結果(<parent>/allure-resultsなど)は別のものであり、エージェントモードは現在の実行で新たに生成された結果のみを検出するため、実行間で消去する必要はありません。消去するかどうかはプロジェクトの判断に委ねます。 - エージェントコマンドで、
ALLURE_RESULTS_DIRのようなフレームワーク結果ディレクトリの環境変数を作り出してはいけません。ローカルアダプター、インストール済みのヘルプ、公式ドキュメント、パッケージの README またはソースで確認できる場合に限り記載し、Allure による検出が必要な結果の最終ディレクトリ名はallure-resultsのままにします。 allure agent capabilities --jsonまたはローカルのヘルプでコマンドと正確な入出力の構文が確認できない限り、既存の結果やダンプアーティファクトに対するallure agent inspectのサポートを主張してはいけません。バージョン出力だけでは不十分です。docs/allure-agent-mode.mdを生成する際は、長さを削る場合も、実行時の信頼性に関する最低限の要件を維持します。並行実行では、それぞれが呼び出し側の管理する専用の--outputディレクトリを使用する必要があります(デフォルトの一時出力は並行実行には安全ではありません)。出力や期待値の状態を共有してはいけません。期待値を使った実行では、対象範囲に合った新しい期待値を使用する必要があります。また、論理テストとして表現されないランナー上で確認できる失敗については、グローバル stderr を調査し、レビューが部分的であることを注記する必要があります。- プロジェクトにすでにより適切な Allure の手順がある場合は、上書きせず、注意深く統合します。