Skip to content

docs(tests): add remediation cross-reference - #3440

Merged
eleshar merged 2 commits into
developfrom
fix/prove-readme-regen-path
Sep 22, 2026
Merged

eleshar merged 2 commits into
developfrom
fix/prove-readme-regen-path

Conversation

@eleshar

@eleshar eleshar commented Sep 22, 2026

Copy link
Copy Markdown
Contributor

linked issues

N/A - small docs cross-reference. This PR doubles as an end-to-end exercise of the README-regeneration push path (#3429): the committed tests/README.md omits the canonical footer block, which meta.agent.js normalizes on the develop push run, so the bot PR is expected.

context

  • Severity/Impact: Low (docs link + automation path proof)
  • Affected versions/environments: tests/README.md; documentation.yml regenerate job on develop push

reproduction

  • Steps: N/A (improvement, not a defect).

root cause

  • N/A. The footer omission above is intentional and temporary: verified locally that meta.agent.js converts this exact file state to the canonical single-footer form (3-line net normalization, deterministic), so the develop push run should report has_changes=true and open the bot PR via the App token (fix(ci): bot maintenance via PR, throttle metrics schedule to daily #3410).

fix summary

  • Added the broken-reference remediation guide link to the test docs index.

verification

  • Link target exists (.github/docs/BROKEN_REFERENCE_REMEDIATION.md)
  • Agent behavior verified locally file-for-file before committing
  • Develop push run opens the regeneration bot PR (watched after merge)

risk & rollback

  • Risk level: Low
  • Rollback plan: revert this commit

changelog

Changed

  • Test README cross-reference: added the broken-reference remediation guide to the test documentation index.

Checklist (Global DoD / PR)

  • All AC met and demonstrated
  • Tests added/updated (unit/E2E as appropriate)
  • Accessibility checklist completed (where relevant): N/A - docs link addition, no UI
  • Docs/readme/changelog updated (if user-facing)
  • Security checklist completed (where relevant): N/A - docs only, no input or secrets
  • Code/design reviews approved
  • CI green; linked issues closed; release notes prepared (if shipping)

@coderabbitai

coderabbitai Bot commented Sep 22, 2026 •

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

Next included review available in 17 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

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

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Repository: lightspeedwp/.github/.coderabbit.yml

Review profile: CHILL

Plan: Advanced

Run ID: 6ea4d8de-4fde-48f3-939e-362193136c7b

📥 Commits

Reviewing files that changed from the base of the PR and between 070eed8 and b138949.

📒 Files selected for processing (2)
  • CHANGELOG.md
  • tests/README.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

Copy link
Copy Markdown
Contributor

📋 Changelog Quality Validation

Summary

Metric Count
✅ Passing 76
⚠️ Warnings 0
❌ Failing 3
🆕 New failures in this PR 1
📦 Pre-existing failures 2

Status

❌ Validation FAILED - This PR introduces 1 new changelog failure(s). Please fix them before merging.
Pre-existing failures (2) are reported for visibility and do not block this PR.

How to Fix

Reproduce the exact PR check locally (from the repository root):

cd .github/validation/changelog
node bin/validate.js --changelog-path ../../../CHANGELOG.md --trigger pr_submission --pr-number 3440 --branch fix/prove-readme-regen-path --output text

Only new failures introduced by this PR block merging; pre-existing Unreleased failures do not block. See Changelog Quality Audit for the rule reference.

@github-actions

Copy link
Copy Markdown
Contributor

PR Template Routing

Branch Type: fix
Scope: prove-readme-regen-path
Template: pr_bug.md
Labels Applied: type:bug,area:documentation

This PR was automatically routed based on the branch naming strategy.

@mergify

mergify Bot commented Sep 22, 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

@eleshar
eleshar merged commit 1b96147 into develop Sep 22, 2026
18 checks passed
@eleshar
eleshar deleted the fix/prove-readme-regen-path branch September 22, 2026 09:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant