ci(markdown-linting): Optimize CI scope by excluding vendored and generated content — Phase 1 - #1226
Conversation
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository YAML (base), Organization UI (inherited) Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (9)
📝 WalkthroughSummary by CodeRabbit
WalkthroughThis PR narrows Markdown linting scope and updates PRD factory planner configurations for Claude, OpenAI, and Copilot, including tool schemas, skills, prompts, metadata, and checksum manifests. ChangesMarkdown lint scope
PRD factory planner configuration
Estimated code review effort: 3 (Moderate) | ~20 minutes Possibly related issues
Possibly related PRs
Suggested labels: Suggested reviewers: ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
✅ Template check passed after update. Thanks for fixing the PR description. |
github-actions
Bot
added
status:needs-review
⏱️ Aging and SLA annotation
Maintained by project-meta-sync workflow. |
github-actions
Bot
added
area:dependencies
🔍 Reviewer Summary for PR #1226CI Status: ❌ Recommendations
|
![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: 4fee513a78
ℹ️ 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".
| Dependabot rule -> expects: "All Checks Passed" | ||
| ImgBot rule -> expects: "All Checks Passed" | ||
| Meta rule -> expects: "All Checks Passed" | ||
|
|
There was a problem hiding this comment.
When the unified checks reach npm run lint:all and then lint:md, this whitespace-only line violates the enabled MD009 rule, so the lint job fails for every PR containing this document; git diff --check 022e6ae1^ 022e6ae1 also reports this exact line. Remove the spaces from the blank line.
AGENTS.md reference: AGENTS.md:L20-L20
Useful? React with 👍 / 👎.
| "lint:js": "eslint '**/*.{js,jsx,ts,tsx}' --ignore-pattern 'design_handoff_awesome_github/**' --ignore-pattern 'website/**' --fix", | ||
| "lint:md": "markdownlint-cli2 \"**/*.{md,mdx}\" \"!node_modules\" \"!website/**\" \"!wceu-2026/**\" \"!.github/projects/**\" \"!.github/reports/**\" \"!.claude/**\" \"!agents/**\" \"!AWESOME_GITHUB_MAPPING_STRATEGY.md\" \"!docs/MIGRATION.md\" \"!**/plugin-provided/**\" \"!**/platform-managed/**\" \"!**/directory-installed/**\" \"!**/tests/markdown-issues.md\" \"!**/agentskills-main/**\"", | ||
| "lint:md:fix": "markdownlint-cli2 --fix \"**/*.{md,mdx}\" \"!node_modules\" \"!wceu-2026/**\" \"!.github/projects/**\" \"!.claude/**\" \"!agents/**\" \"!AWESOME_GITHUB_MAPPING_STRATEGY.md\" \"!docs/MIGRATION.md\"", | ||
| "lint:md": "markdownlint-cli2 \"**/*.{md,mdx}\" \"!node_modules\" \"!website/**\" \"!wceu-2026/**\" \"!.github/projects/**\" \"!.github/reports/**\" \"!.github/audits/**\" \"!.github/metrics/**\" \"!.claude/**\" \"!agents/**\" \"!AWESOME_GITHUB_MAPPING_STRATEGY.md\" \"!docs/MIGRATION.md\" \"!**/plugin-provided/**\" \"!**/platform-managed/**\" \"!**/directory-installed/**\" \"!**/tests/markdown-issues.md\" \"!**/agentskills-main/**\"", |
There was a problem hiding this comment.
When a contributor changes .github/metrics/README.md, this directory-wide negation prevents lint:md from checking that tracked, hand-authored guide even though only outputs such as .github/metrics/out/** and snapshot files are generated. The config-level duplicate also causes the changed-file lint in meta.yml to skip it, so Markdown regressions can be merged silently; exclude the generated files rather than all of .github/metrics/**.
AGENTS.md reference: AGENTS.md:L20-L20
Useful? React with 👍 / 👎.
| - Author is Dependabot (`dependabot[bot]` or `app/dependabot`) | ||
| - Base branch is `develop` | ||
| - Has `area:dependencies` label | ||
| - Check success: `All Checks Passed` ⚠️ **Issue: Check name mismatch** |
There was a problem hiding this comment.
The inspected unified workflow already declares the composite job as name: All Checks Passed in .github/workflows/checks.yml, exactly matching the Mergify condition, so labelling this as a check-name mismatch is factually incorrect. The troubleshooting section repeatedly recommends changing a valid condition, which can send maintainers away from the actual cause of failed Dependabot merges or lead them to break the rule.
Useful? React with 👍 / 👎.
github-actions
Bot
removed
type:performance
e618638 to
1b2b1f8
Compare
github-actions
Bot
added
lang:yaml
ad4ea67 to
d98d039
Compare
- Exclude .github/metrics/out/** and *.json snapshot files (generated outputs) - Keep .github/metrics/README.md in linting scope (hand-authored documentation) - Prevents accidental skipping of tracked metrics documentation - Aligns config file with narrowed npm script exclusions - Addresses code review feedback from Codex Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
**Critical Fixes:** - Fixed UK English violations: Behavioural, organise (vs American English) - Fixed Claude tools.json: Added provider field and input_schema for all tools - Created copilot/skills.yaml (was missing, required by multi-provider contract) - Fixed OpenAI tools.json: Changed from tools[] to functions[] format per schema - Recomputed checksums for prd-factory-planner, tour-operator-config, woo-config agents - Removed Icon file paths from checksums (untracked artifacts) **Remaining Items:** - Agent registration in canonical indexes (already in catalogue.ts) - PR template update with Global DoD checklist These fixes address all P1 and P2 Codex review findings for agent standardization Phase 2. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
d98d039 to
2ee2bd0
Compare
coderabbitai
Bot
added
area:scripts
1 participant
CI Configuration & Markdown Linting Scope Optimization
Linked issues
Relates to #1224, #1229, #1230, #1232
Build/CI change
Phase 1 of 3-phase markdown audit initiative. Optimize CI linting workflow by excluding vendored assets, generated reports, and platform-managed content. Reduces linting scope from 9,024 → ~5,600 files (38% reduction) with estimated 35-45% CI time savings.
Baseline & Target
Notes
Changelog
Improved
Checklist (Global DoD / PR)