docs: 仕様書の集約 export コマンドと鮮度チェック CI を追加 (#6906) - #6961
ttokoro20240902 wants to merge 2 commits into
Conversation
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Advanced Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## docs/spec-readme-colocation #6961 +/- ##
===============================================================
+ Coverage 78.42% 78.44% +0.01%
===============================================================
Files 651 652 +1
Lines 31384 31408 +24
===============================================================
+ Hits 24614 24639 +25
+ Misses 6770 6769 -1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
2e77d40 to
2618b0c
Compare
77915d7 to
5e924c7
Compare
2618b0c to
3a0a680
Compare
base の docs/spec-readme-colocation (#6909) が作り直された結果, 本ブランチは 2026-07-30 時点の 4.4 の上に取り残されていた (esbuild 移行前で gulpfile.js と html/bundle 783 件を抱え, base との差分が 1,196 ファイル / -26,066 行, README の add/add 衝突 30 件)。現在の base から作り直し, 本 PR 固有の変更だけを 載せ直す。旧先端は 77915d7。 - src/Eccube/Service/Docs/DocsExportService.php: 全 README.html の集約と data-customer フィルタ - src/Eccube/Command/DocsExportCommand.php: eccube:docs:export - .github/bin/check-readme-docs.php + .github/workflows/docs-check.yml: 鮮度チェック - .github/PULL_REQUEST_TEMPLATE.md: README 更新漏れのチェック項目 AGENTS.md と .gitignore への追記は #6909 側に既に取り込まれているため触らない。 鮮度チェッカーは作り直した base の README 構成でも合格することを実行して確認した。 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
- 終了コードを Command::SUCCESS / FAILURE にする(4.4 は Rector で定数へ統一済み) - help を #[AsCommand] 属性へ移し, #[Autowire(param: ...)] を使う(4.4 の Rector 規則) - docs-check の actions/checkout の固定 SHA を他の workflow と揃える - Command の README に eccube:docs:export を載せる Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
3a0a680 to
a409400
Compare
5e924c7 to
27aac6f
Compare
|
base(#6909)を 4.4 へ rebase したのにあわせて、本 PR も新しい base の上へ載せ直しました(旧 #6910 と同じ内容 + 4.4 への追従)。 4.4 で変わった規約に合わせた点:
検証(ローカル Docker): PHPStan(src 全体)・PHPUnit( |
概要(Overview・Refs Issue)
Refs #6906(Phase B / 戦略資料 §8.2)。#6909(Phase A)にスタックした PR(base =
docs/spec-readme-colocation)。全README.htmlを集約・出力する基盤と、顧客提出向けフィルタ、鮮度維持の CI を実装します。eccube:docs:exportコマンド(--filter=all|customer)+DocsExportService。全README.htmlを出力先へ集約し、--filter=customerでdata-customer="true"の章だけを残す。docs-check): アプリ起動不要の軽量チェッカー.github/bin/check-readme-docs.php。方針(Policy)
DocsExportServiceに集約し、コマンドは薄い入口に(Skillcommand準拠)。README.htmlは自己完結 HTML なので、ローカル閲覧・配布はビルド不要でそのまま開ける。静的サイト化の要否・本番公開先・doc4 との統合方針は Issue [4.4] コード近接の人間向け仕様ドキュメント(README.html)と静的サイト/PDF 化 — 実装設計 #6906 で継続検討(この PR はコマンドと鮮度 CI まで)。テスト(Test)
DocsExportServiceTest): customer フィルタで dev 章除去・customer 章保持、構造保持、文字化け防止、除外ディレクトリ、未知フィルタ例外、本文が属性名に言及しても除去。bin/console eccube:docs:export --filter=customerを end-to-end 実行し、出力・dev 章除去・文字化けなし・整形保持を確認。docs-checkCI がグリーン(section 属性・リンク・ポータル列挙)。🤖 Generated with Claude Code