Skip to content

[codex] Add AgentOps metadata consistency quality gate#50

Merged
ootakazuhiko merged 1 commit into
mainfrom
codex/agentops-quality-sprint-20260604
Jun 4, 2026
Merged

[codex] Add AgentOps metadata consistency quality gate#50
ootakazuhiko merged 1 commit into
mainfrom
codex/agentops-quality-sprint-20260604

Conversation

@ootakazuhiko

Copy link
Copy Markdown
Collaborator

Summary

  • Add a stdlib-only metadata/navigation consistency check for book-config.json, package.json, Jekyll config, front matter, navigation, and public assets.
  • Add the check to local npm test and Book QA, and document it in the README.
  • Keep generated docs/ metadata stable by updating the root index source and build config generator.
  • Refresh production lockfile transitive versions for minimatch / brace-expansion so npm audit --omit=dev --omit=optional is clean.

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, chapter 01, chapter 11, and appendix B
  • Negative fixtures: package homepage drift, missing navigation target, duplicate navigation target; CRLF front matter positive fixture

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

@ootakazuhiko

Copy link
Copy Markdown
Collaborator Author

@copilot review

@ootakazuhiko
ootakazuhiko marked this pull request as ready for review June 4, 2026 04:17
Copilot AI review requested due to automatic review settings June 4, 2026 04:17
@ootakazuhiko

Copy link
Copy Markdown
Collaborator Author

@copilot review

Copilot AI commented Jun 4, 2026

Copy link
Copy Markdown

@copilot review

Reviewed the latest PR state (commit d243ce0). Local validation is passing (npm test), and I did not find additional actionable issues to change in this branch.

Copy link
Copy Markdown
Collaborator Author

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

  • Copilot SWE agent の本文コメントは「最新 PR 状態で追加の actionable issue はない」という確認内容でした。
  • check_pr_review_completeness.py --repo itdojp/GitHub-AgentOps-book --pr 50 --format jsonstatus=okunresolved_threads=0review_comments=0review_threads=0 でした。
  • PR head d243ce0 の CI は qa / test / docs-forbidden がすべて成功しています。

そのため、レビュー起因の追加修正は不要と判断します。

@ootakazuhiko
ootakazuhiko merged commit 3fcc09c into main Jun 4, 2026
6 checks passed

Copilot AI commented Jun 4, 2026

Copy link
Copy Markdown

@copilot review

Re-reviewed the branch at d243ce0. After reinstalling deps (npm ci), npm test passes and I don’t see additional actionable fixes to apply.

@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: 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".

Comment thread package.json
"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",

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge メタデータ検証をビルド後にも実行する

npm test では check:metadatabuild:validate より前に実行されるため、build:validate 内の npm run builddocs/ を再生成した後の成果物はこの新しい整合性ゲートで検証されません。scripts/build-simple.jssrc/ の変更で生成後の docs/_config.yml、front matter、navigation が不整合になっても、事前に存在していた docs/ が通っていればローカルの品質ゲートは検出できないため、少なくともビルド後に check:metadata を実行する順序にする必要があります。

Useful? React with 👍 / 👎.

@ootakazuhiko
ootakazuhiko deleted the codex/agentops-quality-sprint-20260604 branch June 4, 2026 04:21

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 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.js and expose it as npm run check:metadata.
  • Extend the build generator to emit homepage / repository_url in docs/_config.yml, and align metadata fields across config/front matter.
  • Run the new check in npm test and 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.

Comment thread package.json
"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",
Comment thread README.md
Comment on lines +37 to 38
npm run check:metadata
npm test
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