fix: correct Dependabot author in Mergify rules#582
Conversation
Standardise markdown formatting across all instruction files per markdownlint-cli2 rules. https://claude.ai/code/session_015QNP4SGYZTmRmXNQachTTf
Bump versions from v1.0 to v1.1 for files modified after initial documentation: - instructions/file-organisation.instructions.md (added MIGRATION.md references) - instructions/spec-driven-workflow.instructions.md (added breaking changes guidance) Fixes frontmatter freshness validation failure. https://claude.ai/code/session_015QNP4SGYZTmRmXNQachTTf
…entation - Document template.agent.md with canonical specification structure, usage guidelines, and best practices (Issue #488) - Enhance testing.agent.md with comprehensive role, capabilities, configuration, and examples (Issue #490) - Both agents now fully documented with clear responsibilities, tools, constraints, and related references https://claude.ai/code/session_015QNP4SGYZTmRmXNQachTTf
- Update agent-development.md reference to AGENT_CREATION.md in agents/template.agent.md (correct file exists) - Fix coding-standards.instructions.md path from .github/instructions/ to instructions/ (correct location per file org standards) - Remove broken links to non-existent test-fixer.agent.md and ci.md in agents/testing.agent.md https://claude.ai/code/session_015QNP4SGYZTmRmXNQachTTf
Changed author condition from 'dependabot' to 'dependabot[bot]' to match the actual GitHub bot account name. This fixes auto-merge rules for Dependabot PRs on develop branch.
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
📝 WalkthroughSummary by CodeRabbit
WalkthroughThis PR polishes up the ChangesCI Configuration and Agent Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 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 |
github-actions
Bot
added
area:documentation
coderabbitai
Bot
added
area:ci
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the Mergify configuration to target dependabot[bot], adds comprehensive specifications for the Testing Agent and the Agent Template, corrects a path reference in the Copilot operations instructions, and documents these updates in the CHANGELOG. No review comments were provided, so there is no feedback to address.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
agents/testing.agent.md (1)
1-76:⚠️ Potential issue | 🟠 Major | ⚡ Quick winFrontmatter is incomplete for repository policy.
This spec is missing
domainandstabilityin YAML frontmatter.As per coding guidelines, “All
.mdfiles in this repository should include YAML frontmatter with required fields: file_type, title, description, version, last_updated, owners, tags, status, stability, domain”.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@agents/testing.agent.md` around lines 1 - 76, The YAML frontmatter for the "Testing" agent (agents/testing.agent.md) is missing the required keys `domain` and `stability`; update the top-level YAML block to include `domain:` (set to the appropriate repository domain string, e.g., "platform" or "services") and `stability:` (set to one of the allowed values like "stable", "experimental", or "deprecated"), preserving existing keys such as `file_type`, `title`, `description`, `version`, `last_updated`, `owners`, `tags`, and `status`, and ensure the new fields follow the repository's frontmatter conventions and formatting.agents/template.agent.md (1)
1-17:⚠️ Potential issue | 🟠 Major | ⚡ Quick winFrontmatter is missing required
stabilityanddomainfields.Quick compliance gremlin here: this
.mdfile still lacksstabilityanddomainin YAML frontmatter, which will keep the template out of policy.As per coding guidelines, “All
.mdfiles in this repository should include YAML frontmatter with required fields: file_type, title, description, version, last_updated, owners, tags, status, stability, domain”.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@agents/template.agent.md` around lines 1 - 17, The YAML frontmatter in template.agent.md is missing the required stability and domain keys; update the top-facing frontmatter block to include stability (e.g., "stable", "experimental", or the repo's accepted enum) and domain (e.g., "agents", "platform", or appropriate domain string) alongside the existing keys (file_type, name, title, description, version, last_updated, status, tags, owners) so the file conforms to the repository policy; ensure the new keys are valid values per repo guidelines and placed in the frontmatter block header.
🧹 Nitpick comments (2)
instructions/copilot-operations.instructions.md (1)
112-117: ⚡ Quick winRename this section to
Cross-Referencesfor instruction-file compliance.Tiny naming nit, big policy win: in
instructions/**, the required section name isCross-References, notReferences.As per coding guidelines, “Confirm the file has: Overview, General Rules, Detailed Guidance, Examples, Validation, and Cross-References sections.”
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@instructions/copilot-operations.instructions.md` around lines 112 - 117, Rename the markdown header "## References" to "## Cross-References" to match the instruction-file naming policy (replace the exact header text "## References" with "## Cross-References"), and while editing confirm the document contains the required sections: Overview, General Rules, Detailed Guidance, Examples, Validation, and Cross-References; add any missing sections or placeholders so the file conforms to the coding guidelines.agents/template.agent.md (1)
113-118: ⚡ Quick winSmall markdown/style tidy-up: ordered list format and UK spelling.
Use
1.for each ordered item, and switch “Organization-wide” to “Organisation-wide” for UK English consistency.As per coding guidelines, “Use
1.for ordered lists” and “Keep all wording in UK English (optimise, organisation, colour, behaviour, analyse)”.Also applies to: 124-124
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@agents/template.agent.md` around lines 113 - 118, In agents/template.agent.md, convert the displayed ordered list so every item uses the "1." numeric marker (i.e., "1." repeated for each list entry), and update UK spelling across the spec—replace "Organization-wide" with "Organisation-wide" and ensure other common words use UK variants (optimise, organisation, colour, behaviour, analyse); also apply the same "Organisation-wide" change at the other occurrence referenced (around the 124 context). Ensure the formatting remains valid Markdown and no other wording is altered.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@agents/template.agent.md`:
- Around line 40-41: The scaffold frontmatter uses the wrong key "authors"
instead of the repository-required "owners"; update the YAML block in
agents/template.agent.md to replace the "authors" field with "owners" (e.g.,
change "authors:\n- [team or person]" to "owners:\n- [team or person]") and
ensure any example or descriptive text in the template references the "owners"
key so new agent specs follow policy.
In `@agents/testing.agent.md`:
- Around line 157-163: The fenced code examples in agents/testing.agent.md lack
explicit language tags; update the triple-backtick fences at the example blocks
around the sections referenced (the block showing Jest/Playwright output at
lines ~157-163 and the subsequent similar block at ~167-173) to include an
explicit language tag such as "text" or "markdown" (e.g., replace ``` with
```text or ```markdown) so both fenced code blocks conform to the markdown
guideline requiring language identifiers.
In `@CHANGELOG.md`:
- Around line 27-33: Update the Unreleased changelog bullet titled "Complete
Agent Specifications & Documentation Audit" in CHANGELOG.md to include the
corresponding PR link(s) alongside the existing issue links (e.g., add a PR
reference like "(#<PR-number>)" or full PR URL next to each issue reference) so
the entry meets the policy that each [Unreleased] item lists both the PR and
issue; ensure the PR link is added to the same bullet lines that reference
agents/template.agent.md, agents/testing.agent.md, and the audited items so they
appear together.
---
Outside diff comments:
In `@agents/template.agent.md`:
- Around line 1-17: The YAML frontmatter in template.agent.md is missing the
required stability and domain keys; update the top-facing frontmatter block to
include stability (e.g., "stable", "experimental", or the repo's accepted enum)
and domain (e.g., "agents", "platform", or appropriate domain string) alongside
the existing keys (file_type, name, title, description, version, last_updated,
status, tags, owners) so the file conforms to the repository policy; ensure the
new keys are valid values per repo guidelines and placed in the frontmatter
block header.
In `@agents/testing.agent.md`:
- Around line 1-76: The YAML frontmatter for the "Testing" agent
(agents/testing.agent.md) is missing the required keys `domain` and `stability`;
update the top-level YAML block to include `domain:` (set to the appropriate
repository domain string, e.g., "platform" or "services") and `stability:` (set
to one of the allowed values like "stable", "experimental", or "deprecated"),
preserving existing keys such as `file_type`, `title`, `description`, `version`,
`last_updated`, `owners`, `tags`, and `status`, and ensure the new fields follow
the repository's frontmatter conventions and formatting.
---
Nitpick comments:
In `@agents/template.agent.md`:
- Around line 113-118: In agents/template.agent.md, convert the displayed
ordered list so every item uses the "1." numeric marker (i.e., "1." repeated for
each list entry), and update UK spelling across the spec—replace
"Organization-wide" with "Organisation-wide" and ensure other common words use
UK variants (optimise, organisation, colour, behaviour, analyse); also apply the
same "Organisation-wide" change at the other occurrence referenced (around the
124 context). Ensure the formatting remains valid Markdown and no other wording
is altered.
In `@instructions/copilot-operations.instructions.md`:
- Around line 112-117: Rename the markdown header "## References" to "##
Cross-References" to match the instruction-file naming policy (replace the exact
header text "## References" with "## Cross-References"), and while editing
confirm the document contains the required sections: Overview, General Rules,
Detailed Guidance, Examples, Validation, and Cross-References; add any missing
sections or placeholders so the file conforms to the coding guidelines.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Organization UI (inherited)
Review profile: CHILL
Plan: Pro
Run ID: b1899285-4b07-465a-83cd-ac8d3f04bd43
📒 Files selected for processing (5)
.github/mergify.ymlCHANGELOG.mdagents/template.agent.mdagents/testing.agent.mdinstructions/copilot-operations.instructions.md
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: Unified Labeling, Status, and Type Assignment
- GitHub Check: lint
- GitHub Check: coderabbit-gate
- GitHub Check: check
🧰 Additional context used
📓 Path-based instructions (6)
**/*.{md,mdx,yaml,yml}
📄 CodeRabbit inference engine (CLAUDE.md)
Use UK English throughout (optimise, organisation, colour, behaviour)
Files:
instructions/copilot-operations.instructions.mdCHANGELOG.mdagents/testing.agent.mdagents/template.agent.md
**/*.instructions.md
📄 CodeRabbit inference engine (CLAUDE.md)
**/*.instructions.md: Do not include areferencesfrontmatter field in instruction files; use inline links or footer sections instead
Instruction files must follow the pattern: frontmatter + role declaration + Overview + General Rules + Detailed Guidance + Examples + Validation + References
Files:
instructions/copilot-operations.instructions.md
**/*.md
📄 CodeRabbit inference engine (.github/instructions/markdown.instructions.md)
**/*.md: Use one H1 (#) per file; keep heading levels sequential (never skip from H2 to H4)
Use fenced code blocks with explicit language tags (bash,yaml,markdown, etc.)
Keep links relative for in-repo files; verify they resolve before merging
Use1.for ordered lists and-for unordered lists
Keep all wording in UK English (optimise, organisation, colour, behaviour, analyse)
Do not add areferences:frontmatter field — use inline links or a footer section instead
Blank lines before and after headings, code blocks, and block-level elements
Maximum line length: 120 characters (soft limit; prefer wrapping at natural sentence boundaries)
All.mdfiles in this repository should include YAML frontmatter with required fields: file_type, title, description, version, last_updated, owners, tags, status, stability, domain
Every image (![]()) must have descriptive alt text explaining the image's purpose, not its appearance. Empty alt (![ ]()) is valid only for purely decorative images
Link text must describe the destination — never use 'click here', 'read more', or bare URLs as visible text
Every table must have a header row (| Header |). Avoid merged cells
Use headings to communicate document structure, not for visual styling
Do not rely on colour alone to convey information in diagrams or callout blocks
Mermaid diagrams must includeaccTitleandaccDescrattributes for accessibility
Specify language in frontmatter; use plain language, avoid jargon where possible
Files:
instructions/copilot-operations.instructions.mdCHANGELOG.mdagents/testing.agent.mdagents/template.agent.md
instructions/**
⚙️ CodeRabbit configuration file
instructions/**: Review portable instruction files:
- Verify frontmatter follows the canonical pattern (file_type, version, last_updated, owners, tags, status, domain, stability).
- Flag any
references:frontmatter field — prohibited by CLAUDE.md.- Confirm the file has: Overview, General Rules, Detailed Guidance, Examples, Validation, and Cross-References sections.
- Check that language is UK English throughout.
Files:
instructions/copilot-operations.instructions.md
CHANGELOG.md
⚙️ CodeRabbit configuration file
CHANGELOG.md: Review CHANGELOG.md:
- Confirm entries follow Keep a Changelog 1.1.0 format.
- Each entry under [Unreleased] must include a PR link and issue link.
- Verify entries use the correct section headings (Added, Changed, Fixed, Deprecated, Removed, Security, Documentation, Performance).
- Check UK English spelling throughout.
Files:
CHANGELOG.md
**/{agents,ai}/**/*.{js,py,ts,tsx,md}
📄 CodeRabbit inference engine (AGENTS.md)
Each AI agent must have both a code file (.js, .py, etc.) and a spec (.md) following the agent template
Files:
agents/testing.agent.mdagents/template.agent.md
🪛 LanguageTool
CHANGELOG.md
[uncategorized] ~34-~34: The official name of this software platform is spelled with a capital “H”.
Context: ...ing Agent Current-State Audit** — Added `.github/projects/active/ISSUE_48_CURRENT_STATE_...
(GITHUB)
agents/testing.agent.md
[duplication] ~112-~112: Possible typo: you repeated a word.
Context: ...ct path:** Root directory of project to test - Test framework(s): Which test runners to e...
(ENGLISH_WORD_REPEAT_RULE)
agents/template.agent.md
[duplication] ~123-~123: Possible typo: you repeated a word.
Context: ...CREATION.md) – Building and testing new agents - AGENTS.md – Organization-wide a...
(ENGLISH_WORD_REPEAT_RULE)
🔇 Additional comments (1)
.github/mergify.yml (1)
4-4: LGTM!Also applies to: 17-17
| authors: | ||
| - [team or person] |
There was a problem hiding this comment.
Use owners in the scaffold, not authors.
The template example currently teaches authors, but repo policy expects owners; that mismatch will spread invalid frontmatter to new agent specs.
As per coding guidelines, “All .md files in this repository should include YAML frontmatter with required fields: ... owners ...”.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@agents/template.agent.md` around lines 40 - 41, The scaffold frontmatter uses
the wrong key "authors" instead of the repository-required "owners"; update the
YAML block in agents/template.agent.md to replace the "authors" field with
"owners" (e.g., change "authors:\n- [team or person]" to "owners:\n- [team or
person]") and ensure any example or descriptive text in the template references
the "owners" key so new agent specs follow policy.
| ``` | ||
| Agent: Run all tests in this project and generate a coverage report. | ||
| Output: | ||
| - Jest: 125 tests pass, 2 fail (coverage: 82%) | ||
| - Playwright: 8 tests pass, 0 fail | ||
| - Overall: 96% of tests passing, coverage above threshold | ||
| ``` |
There was a problem hiding this comment.
Please add explicit language tags to the fenced examples.
Both example blocks use plain ``` fences; tag them (for example text or `markdown`) to satisfy the markdown standard.
As per coding guidelines, “Use fenced code blocks with explicit language tags (bash, yaml, markdown, etc.)”.
Also applies to: 167-173
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@agents/testing.agent.md` around lines 157 - 163, The fenced code examples in
agents/testing.agent.md lack explicit language tags; update the triple-backtick
fences at the example blocks around the sections referenced (the block showing
Jest/Playwright output at lines ~157-163 and the subsequent similar block at
~167-173) to include an explicit language tag such as "text" or "markdown"
(e.g., replace ``` with ```text or ```markdown) so both fenced code blocks
conform to the markdown guideline requiring language identifiers.
| - **Complete Agent Specifications & Documentation Audit** — Completed specification documentation for tracking agents and audited documentation cross-references: | ||
| - Completed `agents/template.agent.md` with canonical agent specification template, usage guidelines, structure documentation, and best practices ([#488](https://github.com/lightspeedwp/.github/issues/488)) | ||
| - Enhanced `agents/testing.agent.md` with comprehensive role/responsibilities, capabilities, configuration, examples, and related agent references ([#490](https://github.com/lightspeedwp/.github/issues/490)) | ||
| - Audited documentation cross-references to CONTRIBUTING.md, GOVERNANCE.md, coding standards, and linting instructions ([#22](https://github.com/lightspeedwp/.github/issues/22)) | ||
| - Verified CONTRIBUTING.md has adequate Quick Start section and workflow diagram ([#18](https://github.com/lightspeedwp/.github/issues/18)) | ||
| - Verified PR template includes comprehensive accessibility and security checklists ([#21](https://github.com/lightspeedwp/.github/issues/21)) | ||
|
|
There was a problem hiding this comment.
Add a PR link to this Unreleased entry.
Nice update, but this new bullet only references issues; changelog policy requires both an issue link and a PR link under [Unreleased].
As per coding guidelines, “Each entry under [Unreleased] must include a PR link and issue link.”
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@CHANGELOG.md` around lines 27 - 33, Update the Unreleased changelog bullet
titled "Complete Agent Specifications & Documentation Audit" in CHANGELOG.md to
include the corresponding PR link(s) alongside the existing issue links (e.g.,
add a PR reference like "(#<PR-number>)" or full PR URL next to each issue
reference) so the entry meets the policy that each [Unreleased] item lists both
the PR and issue; ensure the PR link is added to the same bullet lines that
reference agents/template.agent.md, agents/testing.agent.md, and the audited
items so they appear together.
🔍 Reviewer Summary for PR #582CI Status: ✅ Recommendations
|
|
Closing in favour of clean PR #583 which contains only the Mergify fix without the unrelated commits from PR #581. Generated by Claude Code |
2 participants
Summary
Fix Mergify auto-merge rules for Dependabot PRs by correcting the author condition.
Problem
The Mergify configuration had
author=dependabotbut GitHub's Dependabot bot account is registered asdependabot[bot], causing the auto-merge rules to never match.Solution
Updated both auto-merge rules (dependency updates and security updates) to use the correct author:
author=dependabot[bot]Testing
This will be validated once the Dependabot PRs (#532, #533) are processed by Mergify with the corrected rules.
Generated by Claude Code