[codex] Add metadata consistency gate#29
Conversation
|
@copilot review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 174ae8cf8a
ℹ️ 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 Node-based consistency gate to keep the book’s canonical metadata (title/description/author/version/license/repo), navigation, and key entry pages synchronized, using book-config.json as the source of truth. This strengthens CI by failing npm test when published metadata drifts.
Changes:
- Introduce
scripts/check-metadata-consistency.jsand wire it intonpm testvianpm run check:metadata. - Register the existing case study appendix in
book-config.jsonstructure and indocs/_data/navigation.yml. - Align top-page and Jekyll/package metadata (version/homepage/bugs/front matter) to match
book-config.json.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/check-metadata-consistency.js | New metadata/navigation consistency checker used by CI. |
| package.json | Adds check:metadata, runs it in test, and aligns homepage/bugs metadata. |
| book-config.json | Adds repository URL and registers case-studies appendix in structure. |
| docs/_data/navigation.yml | Adds navigation entry for the case studies appendix. |
| docs/index.md | Aligns front matter fields with canonical book metadata and updates top-page description/body. |
| docs/_config.yml | Adds version field to match canonical metadata. |
| _config.yml | Adds version field to match canonical metadata. |
| README.md | Documents the new metadata consistency check command. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Summary
book-config.jsonbook-config.jsonand navigationnpm testValidation
npm ci(install still reports existing dev dependency audit findings)npm run check:metadata(cd docs && node ../scripts/check-metadata-consistency.js)case-studiesfrombook-config.jsonfails the metadata checkdocs/index.mdfront matter passesnpm testnpm audit --omit=dev --omit=optional→ 0 vulnerabilities/home/devuser/work/CodeX/booksB/.codex-local/tmp/issue-driven-quality-site/,/appendices/case-studies/,/chapters/chapter-05/git diff --checkTracking