Skip to content

[codex] Add GitHub beginners metadata quality gate#220

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

[codex] Add GitHub beginners metadata quality gate#220
ootakazuhiko merged 2 commits into
mainfrom
codex/github-beginners-quality-sprint-20260525

Conversation

@ootakazuhiko

@ootakazuhiko ootakazuhiko commented May 25, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Add scripts/check-metadata-consistency.js to guard package, lockfile, Jekyll config, top-page front matter, and navigation/book-config consistency.
  • Align published metadata to version 1.1.0, canonical GitHub capitalization, package homepage/bugs URLs, and current docs navigation order.
  • Restore local quality gates by adding the metadata check to npm test and Book QA, while scoping legacy src MD012 spacing to .markdownlint-src.json so docs:lint remains strict.
  • Align start / build to the same Bundler + docs/_config.yml + docs source path and document current setup/build commands.

Validation

  • Baseline: no open Issues/PRs; npm test failed before this change on legacy src/**/*.md MD012 blank-line findings; npm audit --omit=dev --omit=optional was clean.
  • npm ci
  • npm run check:metadata
  • npm test
  • npm run docs:quality-gate
  • npm audit --omit=dev --omit=optional
  • git diff --check
  • npm run build with Bundler-backed Jekyll docs build and built-site smoke for /, /chapters/chapter-docs-as-code/, and /appendices/appendix-resources/
  • Metadata negative fixture: removing docs-as-code from book-config.json fails with actionable navigation/order errors
  • CI-pinned-style itdojp/book-formatter@da2a49e7d2dcd9e1fa885e910c458130fe8d73a4 checks over docs: Unicode, textlint/PRH, internal links, layout risk, markdown structure
  • PR CI on 1bfbed1: Book QA, Docs Quality Gate, and Docs Forbidden Check succeeded
  • Final pr-review-completeness: status=ok, unresolved_threads=0, generated_count_mismatches=0
  • Main CI/Pages on merge commit 4132582: Docs Forbidden Check, Book QA, Docs Quality Gate, and pages build/deployment succeeded
  • Public GitHub Pages smoke passed for /, /chapters/chapter-docs-as-code/, and /appendices/appendix-resources/

Release gates

  • GitHub Copilot review requested and addressed
  • PR CI green
  • Squash-merge after review/CI
  • Public GitHub Pages smoke check

Related: itdojp/it-engineer-knowledge-architecture#152

Copilot AI review requested due to automatic review settings May 25, 2026 02:39
@ootakazuhiko

Copy link
Copy Markdown
Collaborator Author

@copilot review

#152 対応の小粒PRです。metadata consistency gate、book-config/navigation整合、local QA復旧、Bundler/Jekyllローカルビルド整備を中心にレビューしてください。

Copilot AI commented May 25, 2026

Copy link
Copy Markdown

@copilot review

#152 対応の小粒PRです。metadata consistency gate、book-config/navigation整合、local QA復旧、Bundler/Jekyllローカルビルド整備を中心にレビューしてく��...

確認しました。f68ec9d を対象に metadata consistency gate / book-config-navigation 整合 / local QA / Bundler-Jekyll ローカルビルド前提の観点で再チェックし、追加修正は不要と判断しました。現時点で当該ブランチの主要CI(Book QA / Docs Quality Gate / Docs Forbidden Check)は success、ローカルでも npm run check:metadatanpm testnpm run docs:quality-gate が通過しています。

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

This PR introduces a repo-level “metadata quality gate” to keep package/Jekyll/book configuration and docs navigation consistent, while aligning the published metadata (version, author, GitHub capitalization, URLs) and making the docs build work via Bundler.

Changes:

  • Added scripts/check-metadata-consistency.js and wired it into npm test and the Book QA GitHub Actions workflow.
  • Normalized metadata across package.json, lockfile, Jekyll configs, book-config.json, and docs front matter/navigation (including version bump to 1.1.0).
  • Updated local build/docs dependencies and tooling (Bundler plugins, README setup commands, markdownlint rule adjustment).

Reviewed changes

Copilot reviewed 9 out of 10 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
scripts/check-metadata-consistency.js Adds a Node-based consistency checker across package/lock/Jekyll/front matter/nav/book config.
package.json Adds check:metadata, integrates it into test, and changes build to Bundler-backed docs build.
package-lock.json Aligns lockfile version fields with package.json (1.1.0).
book-config.json Aligns description/version and synchronizes chapter/appendix titles + ordering with docs navigation.
docs/index.md Updates front matter author to match canonical author string.
docs/_data/navigation.yml (Context) Used as the canonical nav order that metadata check enforces.
_config.yml Aligns description/version capitalization and version.
Gemfile Adds required Jekyll plugin gems used by docs/_config.yml.
README.md Updates setup/build commands (npm ci, bundler install, metadata/QA commands).
.markdownlint.json Disables MD012 (multiple blank lines).
.github/workflows/book-qa.yml Runs the metadata consistency check as part of CI QA.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread package.json Outdated
Comment thread README.md
Comment thread .markdownlint.json Outdated
@ootakazuhiko

Copy link
Copy Markdown
Collaborator Author

@copilot review

レビュー指摘3件へ対応済みです。差分 1bfbed1 を再確認してください。

Copilot AI commented May 25, 2026

Copy link
Copy Markdown

@copilot review

レビュー指摘3件へ対応済みです。差分 1bfbed1 を再確認してください。

1bfbed1 を再確認しました。3点とも意図どおり反映されています(start の Bundler+docs config/source 統一、README 記載整合、MD012 の src 専用スコープ化)。PR ブランチの pull_request 系 CI(Book QA / Docs Quality Gate / Docs Forbidden Check)はすべて success で、追加修正は不要です。

@ootakazuhiko ootakazuhiko merged commit 4132582 into main May 25, 2026
4 checks passed
@ootakazuhiko ootakazuhiko deleted the codex/github-beginners-quality-sprint-20260525 branch May 25, 2026 02:49
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