[codex] Add AgentOps metadata consistency quality gate#50
Conversation
|
@copilot review |
|
@copilot review |
|
レビュー本文・インラインコメント・review thread を確認しました。
そのため、レビュー起因の追加修正は不要と判断します。 |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: d243ce0708
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| "build:validate": "npm run build && npm run check-links", | ||
| "test": "npm run lint && npm run build:validate", | ||
| "check-external-links": "node scripts/check-external-links.js" | ||
| "test": "npm run check:metadata && npm run lint && npm run build:validate", |
There was a problem hiding this comment.
npm test では check:metadata が build:validate より前に実行されるため、build:validate 内の npm run build が docs/ を再生成した後の成果物はこの新しい整合性ゲートで検証されません。scripts/build-simple.js や src/ の変更で生成後の docs/_config.yml、front matter、navigation が不整合になっても、事前に存在していた docs/ が通っていればローカルの品質ゲートは検出できないため、少なくともビルド後に check:metadata を実行する順序にする必要があります。
Useful? React with 👍 / 👎.
There was a problem hiding this comment.
Pull request overview
Adds a stdlib-only quality gate to keep published book metadata and navigation consistent across book-config.json, package.json, Jekyll config, front matter, navigation, and required public assets—then wires it into local and CI checks.
Changes:
- Add
scripts/check-metadata-consistency.jsand expose it asnpm run check:metadata. - Extend the build generator to emit
homepage/repository_urlindocs/_config.yml, and align metadata fields across config/front matter. - Run the new check in
npm testand in Book QA workflow; refresh lockfile transitive versions.
Reviewed changes
Copilot reviewed 9 out of 10 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/check-metadata-consistency.js | New stdlib-only metadata/navigation/assets consistency checker for published docs/. |
| scripts/build-simple.js | Emit homepage and repository_url in generated Jekyll config. |
| README.md | Document the new metadata/navigation consistency check in local quality gate section. |
| package.json | Add check:metadata script and integrate it into npm test; add bugs + homepage metadata. |
| package-lock.json | Update transitive versions for brace-expansion / minimatch. |
| index.md | Add description/author/version to top-page front matter (source). |
| docs/index.md | Add description/author/version to published top-page front matter. |
| docs/_config.yml | Add homepage and repository_url keys. |
| book-config.json | Add homepage and repository to book metadata. |
| .github/workflows/book-qa.yml | Run npm run check:metadata as part of Book QA. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| "build:validate": "npm run build && npm run check-links", | ||
| "test": "npm run lint && npm run build:validate", | ||
| "check-external-links": "node scripts/check-external-links.js" | ||
| "test": "npm run check:metadata && npm run lint && npm run build:validate", |
| npm run check:metadata | ||
| npm test |
Summary
book-config.json,package.json, Jekyll config, front matter, navigation, and public assets.npm testand Book QA, and document it in the README.docs/metadata stable by updating the root index source and build config generator.minimatch/brace-expansionsonpm audit --omit=dev --omit=optionalis clean.Validation
npm cinpm run check:metadatanpm testnpm audit --omit=dev --omit=optionalgit diff --checkitdojp/book-formatter@da2a49e7d2dcd9e1fa885e910c458130fe8d73a4checks: unicode, textlint, internal links, layout risk, markdown structuredocs/and built-site smoke for top, chapter 01, chapter 11, and appendix BPart of itdojp/it-engineer-knowledge-architecture#167