Skip to content

[codex] Add communication book metadata QA gate#132

Merged
ootakazuhiko merged 2 commits into
mainfrom
codex/it-communication-quality-sprint-20260604
Jun 4, 2026
Merged

[codex] Add communication book metadata QA gate#132
ootakazuhiko merged 2 commits into
mainfrom
codex/it-communication-quality-sprint-20260604

Conversation

@ootakazuhiko

Copy link
Copy Markdown
Collaborator

Summary

  • Add a stdlib-only metadata/navigation consistency check for package metadata, root/public book config, Jekyll config, top-page front matter, navigation, structure routes, and required public assets.
  • Align repository-facing metadata: package name, repository URL, homepage, bugs URL, license/homepage/repository fields in book configs, and Jekyll/front-matter author metadata.
  • Wire npm run check:metadata into local npm test and Book QA, and document the local quality gate in the README.

Validation

  • npm ci
  • npm run check:metadata
  • npm test
  • npm audit --omit=dev --omit=optional
  • git diff --check
  • CI-pinned itdojp/book-formatter@da2a49e7d2dcd9e1fa885e910c458130fe8d73a4 checks: unicode, textlint, internal links, layout risk, markdown structure
  • Jekyll build from docs/ and built-site smoke for top, quickstart, technical leadership, and appendix 01
  • Negative fixtures: homepage drift, missing navigation target, duplicate navigation target, missing structure route; CRLF front matter positive fixture

Note: npm ci still reports existing dev dependency audit findings; npm audit --omit=dev --omit=optional is clean.

Part of itdojp/it-engineer-knowledge-architecture#167

@ootakazuhiko ootakazuhiko marked this pull request as ready for review June 4, 2026 04:29
Copilot AI review requested due to automatic review settings June 4, 2026 04:29
@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: 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".

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 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.js and wires it into npm test + Book QA workflow.
  • Aligns repository-facing metadata across package.json, package-lock.json, book configs, Jekyll config, and docs/index.md author 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.

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

Copilot AI commented Jun 4, 2026

Copy link
Copy Markdown

@copilot review

I reviewed the latest PR changes and re-ran the repository checks (npm test). I didn’t find any additional actionable issues to change in this branch.

Copy link
Copy Markdown
Collaborator Author

レビュー本文・インラインコメント・review thread を再確認しました。

  • Codex/Copilot の4件の inline thread はすべて修正・返信・resolve 済みです。
    • navigation section 対応範囲を additional / resources / afterword まで拡張
    • process.cwd() 依存を __dirname ベースに変更し、docs/ 配下からの実行も検証
    • 章/付録数の固定値チェックを削除し、route coverage 検証へ変更
    • JSON.stringify 比較を util.isDeepStrictEqual に変更
  • 追加検証:
    • node scripts/check-metadata-consistency.js
    • (cd docs && node ../scripts/check-metadata-consistency.js)
    • npm test
    • npm audit --omit=dev --omit=optional
    • negative fixtures / CRLF front matter fixture
  • check_pr_review_completeness.py --repo itdojp/IT-engineer-communication-book --pr 132 --format jsonstatus=ok, unresolved_threads=0, review_comments=8, review_threads=4 です。
  • 最新 head 1e01042 の PR CI は Book QADocs Forbidden Check が成功しています。

現時点で未対応レビューはありません。

@ootakazuhiko ootakazuhiko merged commit 08504a8 into main Jun 4, 2026
2 checks passed
@ootakazuhiko ootakazuhiko deleted the codex/it-communication-quality-sprint-20260604 branch June 4, 2026 04:39
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.

3 participants