Skip to content

fix(#1375): Resolve README frontmatter validation issue - #1540

Merged
ashleyshaw merged 7 commits into
developfrom
fix/1375-readme-frontmatter-validation
Aug 5, 2026
Merged

fix(#1375): Resolve README frontmatter validation issue#1540
ashleyshaw merged 7 commits into
developfrom
fix/1375-readme-frontmatter-validation

Conversation

@ashleyshaw

@ashleyshawashleyshaw commented Aug 5, 2026

Copy link
Copy Markdown
Member

Bugfix Pull Request

This repository enforces changelog, release, and label automation for all PRs and issues.
See the organisation-wide Automation Governance & Release Strategy for required rules.

Linked issues

Fixes#1375

Context

  • Severity/Impact: Low (validation/schema compliance, infrastructure bug fix)
  • Affected versions/environments: All environments (frontmatter validation enforced on commit, labeling affects all PRs)

Problem Statement

Two separate infrastructure issues discovered while reviewing the closure of PR #1375:

  1. Frontmatter Schema Validation - README files created by PR docs(phase-2b): Phase B skills consolidation planning & architecture #1370 (Phase 2B planning documents) had invalid frontmatter
  2. Labeling Agent Import Errors - Critical bugs preventing PR labeling workflows from executing

Root Cause

README Frontmatter

The Phase 2B skills audit README did not conform to LightSpeed schema:

  • Missing required file_type: readme field
  • Using created instead of created_date
  • Version mismatch (frontmatter vs. content)
  • Non-schema fields present

Labeling Agent Imports

Two named imports referenced non-existent exports:

  • _fetchCanonicalLabels (actual: fetchCanonicalLabels)
  • _formatErrors (actual: formatErrors)

Fix Summary

  1. Corrected README frontmatter - Compliant with LightSpeed schema
  2. Fixed labeling agent imports - Removed unused import, corrected export names
  3. Updated CHANGELOG - Documented fixes with accurate file references

Verification

  • Frontmatter validates against LightSpeed readme schema (0 errors, 0 warnings)
  • CHANGELOG.md validates against schema (0 errors, 0 warnings)
  • Labeling agent imports resolved (module resolution errors fixed)
  • No breaking changes to file content/structure
  • All README and changelog checks pass

Risk & Rollback

  • Risk level: Low
  • Rollback plan: Simple revert if needed (schema validation will catch regressions)

Related Work

Changelog

Fixed


Checklist (Global DoD / PR)

  • All AC met and demonstrated
  • Tests added/updated (unit/E2E as appropriate)
  • Accessibility checklist completed (where relevant):
    • Semantic HTML and heading order verified
    • Keyboard navigation and visible focus states verified
    • ARIA used only where needed
    • Contrast and non-colour cues reviewed (WCAG 2.2 AA or higher)
  • Docs/readme/changelog updated (if user-facing)
  • Security checklist completed (where relevant):
    • Untrusted input validated and sanitised
    • Output escaped for its rendering context
    • Privileged actions enforce nonce and capability checks
    • No secrets/sensitive data introduced; OWASP risks reviewed
  • Code/design reviews approved
  • CI green; linked issues closed; release notes prepared (if shipping)

🧠 Generated with Claude Code

@coderabbitai

coderabbitaiBot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

@ashleyshaw, you've reached your PR review limit, so we couldn't start this review.

Next review available in:38 minutes

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: 322b88bf-0cf0-4012-8edd-f7222d6e1487

📥 Commits

Reviewing files that changed from the base of the PR and between 37b1ea1 and 678bd1a.

📒 Files selected for processing (3)
  • .github/projects/active/phase-2b-skills-audit/README.md
  • .github/scripts/agents/labeling.agent.js
  • CHANGELOG.md

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

github-actionsBot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

✅ Template check passed after update. Thanks for fixing the PR description.

@github-actions

Copy link
Copy Markdown
Contributor

📄 README Validation

✅ All README checks passed.

CheckResult
✅ FrontmatterPassed
✅ StructurePassed

@github-actions

github-actionsBot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

⏱️ Aging and SLA annotation

  • Age: 0 day(s)
  • SLA state: Within SLA
  • Thresholds: warn at 7 days, breach at 14 days
  • Last updated: 2026-08-05T12:09:54.591Z

Maintained by project-meta-sync workflow.

@github-actions

github-actionsBot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

🔍 Reviewer Summary for PR #1540

CI Status:success
Files changed: 3
Risk Distribution: 0 critical, 2 high, 0 medium, 1 low

Recommendations

  • Ready to proceed pending human review

@ashleyshaw
ashleyshaw enabled auto-merge (squash) August 5, 2026 09:09
@ashleyshaw
ashleyshaw disabled auto-merge August 5, 2026 09:09
@ashleyshaw
ashleyshawforce-pushed the fix/1375-readme-frontmatter-validation branch 4 times, most recently from 9041778 to b60d5fbCompareAugust 5, 2026 09:16
ashleyshaw added a commit that referenced this pull request Aug 5, 2026
Added two changelog entries under Fixed section:
- README frontmatter schema compliance fix for Phase 2B Skills Audit
- Labeling agent module import error fix
References issue #1375 (README frontmatter) and documents the labeling
agent bug fix that was blocking PR validation workflows.
ashleyshaw added a commit that referenced this pull request Aug 5, 2026
Added two changelog entries under Fixed section:
- README frontmatter schema compliance fix for Phase 2B Skills Audit
- Labeling agent module import error fix
References issue #1375 (README frontmatter) and documents the labeling
agent bug fix that was blocking PR validation workflows.
@ashleyshaw
ashleyshawforce-pushed the fix/1375-readme-frontmatter-validation branch from a491c10 to 333d045CompareAugust 5, 2026 09:23
ashleyshawand others added 3 commits August 5, 2026 11:24
Corrected frontmatter in Phase 2B skills audit README files:
- Added `file_type: readme` (required schema field)
- Changed `created` to `created_date` (correct schema field name)
- Removed non-schema fields: name, related_issues, related_branches
- Standardised frontmatter to match LightSpeed readme schema
Applies fix across both locations:
- .github/projects/active/phase-2b-skills-audit/README.md
- projects/active/phase-2b-skills-audit/README.md
Resolves issue #1375 with proper frontmatter validation.
Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
…t underscore)
The labeling agent was trying to import _fetchCanonicalLabels but the actual
function in label-lookup.js is named fetchCanonicalLabels. Fixed import name
to match the actual export.
Added two changelog entries under Fixed section:
- README frontmatter schema compliance fix for Phase 2B Skills Audit
- Labeling agent module import error fix
References issue #1375 (README frontmatter) and documents the labeling
agent bug fix that was blocking PR validation workflows.
@ashleyshaw
ashleyshawforce-pushed the fix/1375-readme-frontmatter-validation branch from 333d045 to 794a878CompareAugust 5, 2026 09:25
@ashleyshawashleyshaw self-assigned this Aug 5, 2026
@ashleyshaw
ashleyshaw requested a lite review from CopilotAugust 5, 2026 10:10
@ashleyshawashleyshaw added this to the v1.0 milestone Aug 5, 2026
@ashleyshaw
ashleyshaw enabled auto-merge (squash) August 5, 2026 10:10

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Resolves #1375 by bringing a Phase 2B project README into frontmatter-schema compliance and fixing broken named imports in the unified labelling agent that were preventing the agent module from loading.

Changes:

  • Updated CHANGELOG.md freshness metadata and recorded the two fixes.
  • Fixed named imports in .github/scripts/agents/labeling.agent.js to match actual exports.
  • Normalised frontmatter in the Phase 2B skills audit README (adds file_type: readme, updates dates/version, removes some metadata fields).

Reviewed changes

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

FileDescription
CHANGELOG.mdUpdates last_updated and documents the fixes under Fixed.
.github/scripts/agents/labeling.agent.jsCorrects named imports to actual exported symbols to prevent module load errors.
.github/projects/active/phase-2b-skills-audit/README.mdUpdates YAML frontmatter to satisfy file_type: readme schema expectations and refreshes metadata.
Suppressed comments (1)

.github/scripts/agents/labeling.agent.js:43

  • formatErrors is imported but never used in this module. If it is not needed, drop it from the import to keep the dependency surface minimal and avoid potential lint failures.
import {
buildLabelingReport,
formatErrors,
} from "../../../scripts/agents/includes/label-reporting.js";

Comment on lines 25 to 29
import {
_fetchCanonicalLabels,
fetchCanonicalLabels,
buildLabelAliasMap,
findStandardLabel,
} from "../../../scripts/agents/includes/label-lookup.js";
version: 1.0.0
created_date: 2026-07-24
last_updated: 2026-08-05
version: 1.0.1
Comment threadCHANGELOG.md Outdated

### Fixed

- **README frontmatter schema compliance (Phase 2B Skills Audit)** — Corrected frontmatter in Phase 2B skills audit README files to comply with LightSpeed documentation schema: added required `file_type: readme` field, renamed `created` to `created_date`, updated `last_updated` and `version` fields, and removed non-schema fields (`name`, `related_issues`, `related_branches`). Resolves frontmatter validation failures and ensures project documentation adheres to canonical schema standards. ([PR #1540](https://github.com/lightspeedwp/.github/pull/1540), [#1375](https://github.com/lightspeedwp/.github/issues/1375))
@ashleyshaw
ashleyshaw disabled auto-merge August 5, 2026 10:31
- Remove unused fetchCanonicalLabels import from labeling.agent.js
- Align README version field (1.0.1 → 1.1.0) with Quick Facts table
- Clarify CHANGELOG entry to specify exact file changed (.github/projects/active/phase-2b-skills-audit/README.md)
@github-actionsgithub-actionsBot added status:needs-review Awaiting code review type:bug Bug or defect priority:normal Default priority labels Aug 5, 2026
@github-actionsgithub-actionsBot added lang:md Markdown content/docs type:chore Chore / small hygiene change meta:needs-changelog Requires a changelog entry before merge labels Aug 5, 2026
@ashleyshawashleyshaw added status:ready Groomed and ready to start meta:no-changelog No changelog needed labels Aug 5, 2026
@ashleyshaw

Copy link
Copy Markdown
MemberAuthor

Review Status

README frontmatter validation fix — ready for merge

Assessment:

For Merge:

  • Frontmatter validation passes
  • CHANGELOG entry included (marked meta:needs-changelog)
  • Merge to develop

Status: Ready for merge.

@github-actionsgithub-actionsBot removed status:ready Groomed and ready to start type:chore Chore / small hygiene change labels Aug 5, 2026
@ashleyshawashleyshaw added status:ready Groomed and ready to start and removed meta:needs-changelog Requires a changelog entry before merge priority:normal Default priority status:needs-review Awaiting code review lang:md Markdown content/docs type:bug Bug or defect labels Aug 5, 2026
@mergify

mergifyBot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Tick the box to add this pull request to the merge queue (same as @mergifyio queue).

  • Queue this pull request

@github-actionsgithub-actionsBot added status:needs-review Awaiting code review type:bug Bug or defect priority:normal Default priority lang:md Markdown content/docs type:chore Chore / small hygiene change labels Aug 5, 2026
@ashleyshaw
ashleyshaw enabled auto-merge (squash) August 5, 2026 11:32
@github-actionsgithub-actionsBot removed status:ready Groomed and ready to start type:chore Chore / small hygiene change labels Aug 5, 2026
@ashleyshaw
ashleyshaw merged commit a1c2bcd into developAug 5, 2026
25 of 26 checks passed
@ashleyshaw
ashleyshaw deleted the fix/1375-readme-frontmatter-validation branch August 5, 2026 11:34
@ashleyshaw

Copy link
Copy Markdown
MemberAuthor

⏳ Awaiting Maintainer Review

Current Status

  • Review Decision: PENDING (Copilot comments only)
  • Workflows: 90% complete
  • Changelog: Has entry but marked meta:no-changelog ❌

Issues Found:

  1. Conflicting label: marked as meta:no-changelog but body contains CHANGELOG content
  2. No maintainer review: Only has Copilot review comments
  3. Changelog status unclear: Remove meta:no-changelog OR confirm no entry needed

Action Items:

  1. Maintainer review needed
  2. Clarify changelog status (meta:no-changelog vs has content)
  3. Remove conflicting label
  4. Approve and merge

Status: ⏳ Needs maintainer review

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:documentationDocs & guideslang:mdMarkdown content/docspriority:normalDefault prioritystatus:needs-reviewAwaiting code reviewtype:bugBug or defect

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@ashleyshaw