[codex] Add metadata consistency gate#230
Conversation
|
@copilot review |
There was a problem hiding this comment.
Pull request overview
Aligns public metadata to the v1.1.0 release across package.json, package-lock.json, book-config.json, docs/_config.yml, and docs/index.md, and introduces a metadata consistency gate (scripts/check-metadata-consistency.js) wired into npm run test:light and the Book QA workflow. It also restores a non-destructive Jekyll-based local build (moving the legacy generator to build:generate), scopes a relaxed markdownlint config to src/, and surfaces the existing afterword page in published navigation and the top-page ToC.
Changes:
- Add
scripts/check-metadata-consistency.jsand run it fromtest:light/book-qa.yml. - Realign package/lock/book/Jekyll/front-matter metadata (name, version 1.1.0, author, URLs, description).
- Switch local
buildto Jekyll overdocs/, addbuild:generatefor the legacy generator, and publish afterword in navigation and the index ToC.
Reviewed changes
Copilot reviewed 9 out of 11 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| scripts/check-metadata-consistency.js | New gate validating package, book-config, Jekyll config, index front matter/ToC, and navigation paths. |
| package.json | Renames package to github-workflow-book@1.1.0, swaps build to Jekyll, adds check:metadata and build:generate. |
| package-lock.json | Updates root name/version to match package.json. |
| book-config.json | Adds book.version: 1.1.0. |
| docs/_config.yml | Adds version: "1.1.0". |
| docs/index.md | Updates author/version in front matter and adds afterword section to ToC. |
| docs/_data/navigation.yml | Adds afterword section so the page is published in nav. |
| README.md | Updates quickstart and contact email; documents new scripts. |
| .markdownlint-src.json | Adds relaxed lint config for legacy src/**/*.md. |
| .gitignore | Ignores docs/Gemfile.lock. |
| .github/workflows/book-qa.yml | Runs metadata consistency check before book-formatter install. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: a031b2c77c
ℹ️ 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".
|
@copilot review |
Summary
scripts/check-metadata-consistency.jsand wire it into localtest:lightand Book QA.src/**/*.mdmarkdownlint exceptions separately from publisheddocs/.Validation
PUPPETEER_SKIP_DOWNLOAD=true npm ci(completed; npm still reports existing dev/optional audit findings during install)npm run check:metadatanpm run test:lightnpm audit --omit=dev --omit=optionalgit diff --checkdocs//,/afterword/, and/appendices/appendix-g/Part of itdojp/it-engineer-knowledge-architecture#152.