[codex] Add communication book metadata QA gate#132
Conversation
|
@copilot review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: cf6133ec42
ℹ️ 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".
There was a problem hiding this comment.
Pull request overview
Adds a stdlib-only “metadata/navigation consistency” quality gate to keep npm/package metadata, book configs, Jekyll config/front matter, navigation, and required public assets aligned before publishing the docs/ site.
Changes:
- Introduces
scripts/check-metadata-consistency.jsand wires it intonpm test+ Book QA workflow. - Aligns repository-facing metadata across
package.json,package-lock.json, book configs, Jekyll config, anddocs/index.mdauthor front matter. - Documents the local QA gate commands in
README.md.
Reviewed changes
Copilot reviewed 8 out of 9 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/check-metadata-consistency.js | New stdlib-only consistency checker for metadata, navigation coverage, structure routes, and required assets. |
| README.md | Documents running the local QA gate commands. |
| package.json | Adds check:metadata, runs it in npm test, and aligns repository/homepage/bugs metadata. |
| package-lock.json | Updates lock metadata to match the new package name. |
| docs/index.md | Aligns author front matter with the canonical metadata. |
| docs/book-config.json | Adds license/homepage/repository fields for consistency checks. |
| docs/_config.yml | Aligns author metadata and adds license/homepage/repository_url. |
| book-config.json | Adds license/homepage/repository fields for consistency checks. |
| .github/workflows/book-qa.yml | Runs npm run check:metadata as part of Book QA. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
I reviewed the latest PR changes and re-ran the repository checks ( |
|
レビュー本文・インラインコメント・review thread を再確認しました。
現時点で未対応レビューはありません。 |
Summary
npm run check:metadatainto localnpm testand Book QA, and document the local quality gate in the README.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, quickstart, technical leadership, and appendix 01Note:
npm cistill reports existing dev dependency audit findings;npm audit --omit=dev --omit=optionalis clean.Part of itdojp/it-engineer-knowledge-architecture#167