Skip to content

[codex] Add metadata consistency gate#29

Merged
ootakazuhiko merged 2 commits into
mainfrom
codex/issue-driven-quality-sprint-20260525
May 25, 2026
Merged

[codex] Add metadata consistency gate#29
ootakazuhiko merged 2 commits into
mainfrom
codex/issue-driven-quality-sprint-20260525

Conversation

@ootakazuhiko

Copy link
Copy Markdown
Collaborator

Summary

  • add a metadata/navigation consistency gate sourced from book-config.json
  • register the existing published case study appendix in book-config.json and navigation
  • align package/Jekyll/top-page metadata and wire the check into npm test

Validation

  • npm ci (install still reports existing dev dependency audit findings)
  • npm run check:metadata
  • (cd docs && node ../scripts/check-metadata-consistency.js)
  • negative fixture: removing case-studies from book-config.json fails the metadata check
  • BOM + CRLF fixture for docs/index.md front matter passes
  • npm test
  • npm audit --omit=dev --omit=optional → 0 vulnerabilities
  • Jekyll build to /home/devuser/work/CodeX/booksB/.codex-local/tmp/issue-driven-quality-site
  • built-site smoke for /, /appendices/case-studies/, /chapters/chapter-05/
  • book-formatter checks: Unicode, textlint/PRH, internal links, layout risk, markdown structure
  • git diff --check

Tracking

Copilot AI review requested due to automatic review settings May 25, 2026 04:22
@ootakazuhiko

Copy link
Copy Markdown
Collaborator Author

@copilot review

@chatgpt-codex-connector chatgpt-codex-connector 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.

💡 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".

Comment thread scripts/check-metadata-consistency.js Outdated

Copilot AI 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.

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.js and wire it into npm test via npm run check:metadata.
  • Register the existing case study appendix in book-config.json structure and in docs/_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.

Comment thread scripts/check-metadata-consistency.js Outdated
Comment thread scripts/check-metadata-consistency.js
@ootakazuhiko ootakazuhiko merged commit e0d6823 into main May 25, 2026
1 check passed
@ootakazuhiko ootakazuhiko deleted the codex/issue-driven-quality-sprint-20260525 branch May 25, 2026 04:42
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.

2 participants