Skip to content

docs: AGENTS.md の E2E 記述を実態(Playwright)に修正 - #6859

Merged
dotani1111 merged 4 commits into
4.4from
docs/agents-e2e-playwright
Jul 1, 2026
Merged

docs: AGENTS.md の E2E 記述を実態(Playwright)に修正#6859
dotani1111 merged 4 commits into
4.4from
docs/agents-e2e-playwright

Conversation

@ttokoro20240902

@ttokoro20240902 ttokoro20240902 commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

概要

AGENTS.md(AI コーディングエージェント向けの正典)が、E2E テストフレームワークを 「Codeception 5(E2E)」 と記載していましたが、実態とズレていたため修正します。

実態

  • E2E は e2e/ 配下の Playwright で実装されており、CI(.github/workflows/e2e-test.yml)もこちらをマトリクス実行している(1 spec ファイル = 1 シャード)。
  • codeception/ はリポジトリに残置されているものの、coverage.yml の Codeception ジョブは if: false(Disabled until remote coverage collection is fixed) で無効化されており、CI では動作していない

正典が誤った情報を指していると、エージェントが Playwright E2E の存在に気づけず(または Codeception を前提に動いてしまう)ため修正します。

変更内容

  • 技術スタックの「テスト」行を Playwright(E2E)へ修正し、Codeception が残置レガシー/CI 無効である旨を注記
  • ディレクトリ構成に e2e/(spec / Page Object / fixtures)を追記
  • 開発コマンドに E2E(Playwright)の実行例を追記

ドキュメントのみの変更で、コード・CI 設定への影響はありません。

🤖 Generated with Claude Code

Summary by CodeRabbit

  • ドキュメント
    • 技術スタックのテスト記載を、Codeception(レガシー残置・CI無効)から PHPUnit(Symfony PHPUnit Bridge 経由)+ Playwright E2E へ更新。
    • Playwright E2E の構成(e2e配下)と、CIでの分割実行方針(1ファイル=1シャード)を追記。
    • Playwright E2E の実行手順、spec/命名規約、POM・fixture運用、待機方針などの規約を整理。
    • Twig テンプレートのよくある間違い(JSON-LD等への動的埋め込み時の XSS/JSON破壊対策)を追記。

AGENTS.md がテストフレームワークを「Codeception 5(E2E)」と記載していたが,
実際の E2E は e2e/ 配下の Playwright で, CI(e2e-test.yml)もこちらを実行している。
Codeception は codeception/ に残置されているもののジョブは無効化(if: false)され,
CI では動作していない。技術スタック・ディレクトリ構成・テストコマンドを実態へ更新。

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jun 26, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 6d30d733-b0fb-4fdf-b22c-8706a06e0419

📥 Commits

Reviewing files that changed from the base of the PR and between f43e380 and 08abaa5.

📒 Files selected for processing (1)
  • .claude/skills/twig-template/SKILL.md
✅ Files skipped from review due to trivial changes (1)
  • .claude/skills/twig-template/SKILL.md

📝 Walkthrough

Walkthrough

AGENTS.md のテスト案内を Playwright E2E 向けに更新し、e2e/ 構成と実行手順を追加しています。あわせて、E2E 用の Skill 規約ドキュメントを新規追加し、Twig テンプレート規約にも JSON-LD 埋め込み時の注意を追記しています。

Changes

E2E テスト案内と規約の更新

Layer / File(s) Summary
Playwright E2E の案内と規約
AGENTS.md, .claude/skills/e2e/SKILL.md
テスト技術スタック、e2e/ ディレクトリ構成、Playwright の実行手順、Skill 参照を更新し、E2E 用の規約ドキュメントを新規追加している。

Twig テンプレート規約の更新

Layer / File(s) Summary
JSON-LD のエスケープ注意
.claude/skills/twig-template/SKILL.md
<script> と JSON-LD に動的値を埋める際の json_encode(..., JSON_HEX_* ...) 利用を「よくある間違い」に追記している。

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • EC-CUBE/ec-cube#6853: 同じ twig-template Skill に対する追記で、JSON-LD を安全に埋める注意の追加が直接対応している。

Suggested reviewers

  • nanasess
  • zeniya0000

Poem

ぴょんぴょん、うさぎが案内を更新
Playwright の道しるべを e2e/ にぺたり
JSON-LD にはおまじないをひとつ
きらりと光る HEX の魔法で守る
ふわり、今日もテストの森は整う 🥕

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed AGENTS.md の E2E 記述を Playwright 実態に合わせる内容で、変更の主旨を適切に要約しています。
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/agents-e2e-playwright

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@AGENTS.md`:
- Line 100: Add the missing plugin-tests project to the documented list of
available test projects in AGENTS.md so it matches the projects defined in
e2e/playwright.config.ts. Update the section that currently lists front-tests
and admin-tests to include plugin-tests, keeping the spec-file-based filtering
guidance consistent with the rest of the instruction.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 98283215-d06c-45aa-8f85-bce44f5ba1ce

📥 Commits

Reviewing files that changed from the base of the PR and between 0067e77 and 7a29187.

📒 Files selected for processing (1)
  • AGENTS.md

Comment thread AGENTS.md Outdated
ttokoro20240902 and others added 2 commits June 26, 2026 18:54
playwright.config.ts は setup/plugin-tests/admin-tests/front-tests を定義しており,
plugin-tests が記載漏れだったため追記。

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
e2e/ 配下の Playwright E2E を扱う規約が正典に無かったため新設。
接頭辞=プロジェクト=認証状態の対応, POM(pages/models/helpers)と
fixture の使い方, flaky 対策(固定待ち回避・セレクタ一意化・retry時cleanup),
CI 構造(e2e-test.yml + plugin/throttling/deny 専用ワークフロー)を集約。
AGENTS.md のレイヤ別 Skill 一覧表に e2e 行を追加。

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@codecov

codecov Bot commented Jun 26, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 74.92%. Comparing base (0067e77) to head (08abaa5).

Additional details and impacted files
@@            Coverage Diff             @@
##              4.4    #6859      +/-   ##
==========================================
+ Coverage   74.82%   74.92%   +0.09%     
==========================================
  Files         463      463              
  Lines       24029    24029              
==========================================
+ Hits        17980    18004      +24     
+ Misses       6049     6025      -24     
Flag Coverage Δ
Unit 74.92% <ø> (+0.09%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

…規約を追記

商品名・説明に </script> や " が混入すると XSS・JSON 破壊になるため、
JSON_HEX_TAG 等を付与する観点を「よくある間違い」に追加。

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@dotani1111
dotani1111 enabled auto-merge July 1, 2026 07:36
@dotani1111
dotani1111 merged commit db3a487 into 4.4 Jul 1, 2026
352 checks passed
@dotani1111
dotani1111 deleted the docs/agents-e2e-playwright branch July 1, 2026 07:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants