Skip to content

quality: convert agent frontmatter tags to YAML block sequences to fix remark-lint reference rules - #170

Merged
ThePlenkov merged 2 commits into
mainfrom
fix/main-health
Aug 12, 2026
Merged

quality: convert agent frontmatter tags to YAML block sequences to fix remark-lint reference rules#170
ThePlenkov merged 2 commits into
mainfrom
fix/main-health

Conversation

@ThePlenkov

@ThePlenkov ThePlenkov commented Aug 12, 2026

Copy link
Copy Markdown
Member

Summary

codacy-remark-lint treats the inline YAML arrays in workflow/command frontmatter as markdown shortcut-reference links, producing remark-lint-no-undefined-references and remark-lint-no-shortcut-reference-link alerts.

  • Convert tags: [...] to unindented YAML block sequences in the 9 agent/claude frontmatter files. This keeps the parsed tags value as a list while avoiding [/] link syntax for remark.
  • Add those files to .prettierignore so Prettier does not re-indent the list items and reintroduce list-item-bullet-indent findings.

Verified locally with remark-cli (no-undefined-references, no-shortcut-reference-link, list-item-bullet-indent), Prettier --check, and nx format:check.

Link to Devin session: https://app.devin.ai/sessions/754774d02df644c5894ee8b773029700
Requested by: @ThePlenkov


Summary by cubic

Fixes remark-lint reference rule violations by converting frontmatter tags from inline arrays to YAML block sequences in agent and Claude docs. Adds the edited files to .prettierignore so Prettier won’t re-indent the lists.

  • Bug Fixes
    • Replaced tags: [a, b] with block sequences to satisfy remark-lint-no-undefined-references and remark-lint-no-shortcut-reference-link.
    • Added the affected files to .prettierignore to prevent reintroducing list-item-bullet-indent findings.

Written for commit a4f9f21. Summary will update on new commits.

Review in cubic

Summary by CodeRabbit

  • Chores
    • Standardized workflow and command metadata formatting for improved readability.
    • Updated formatting exclusions to prevent automated formatting from altering workflow and command definitions.
    • Preserved all existing tags, instructions, and workflow behavior.

@ThePlenkov ThePlenkov self-assigned this Aug 12, 2026
@devin-ai-integration

Copy link
Copy Markdown
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR that start with 'DevinAI' or '@devin'.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

@netlify

netlify Bot commented Aug 12, 2026

Copy link
Copy Markdown

Deploy Preview for adt-cli canceled.

Name Link
🔨 Latest commit a4f9f21
🔍 Latest deploy log https://app.netlify.com/projects/adt-cli/deploys/6a7c38c6b808930008c41644

@coderabbitai

coderabbitai Bot commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 04122c8a-001a-4d1d-bc88-83087f913fe6

📥 Commits

Reviewing files that changed from the base of the PR and between f7948ab and fdcdcf6.

📒 Files selected for processing (10)
  • .agents/workflows/lint.md
  • .agents/workflows/opsx-apply.md
  • .agents/workflows/opsx-archive.md
  • .agents/workflows/opsx-explore.md
  • .agents/workflows/opsx-propose.md
  • .claude/commands/opsx/apply.md
  • .claude/commands/opsx/archive.md
  • .claude/commands/opsx/explore.md
  • .claude/commands/opsx/propose.md
  • .prettierignore

📝 Walkthrough

Walkthrough

The change reformats workflow and command tags metadata as multiline YAML lists. It also adds the related .agents and .claude paths to .prettierignore.

Changes

Metadata Formatting

Layer / File(s) Summary
Multiline tag metadata
.agents/workflows/*.md, .claude/commands/opsx/*.md
Workflow and command front matter uses multiline YAML lists for tags. Tag values remain unchanged.
Prettier ignore paths
.prettierignore
The ignore list includes the .agents workflows and .claude OpsX commands. \.nx/self-healing remains ignored.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes converting agent frontmatter tags to YAML block sequences to address remark-lint issues.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/main-health

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.

@amazon-q-developer amazon-q-developer Bot 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.

Summary

This PR correctly converts inline YAML arrays in frontmatter to block sequences to fix remark-lint-no-undefined-references and remark-lint-no-shortcut-reference-link alerts. The changes are well-scoped and accomplish the stated objective.

Changes reviewed:

  • 9 markdown files with frontmatter converted from tags: [...] to block sequence format
  • .prettierignore updated to exclude these files from Prettier formatting

All changes function correctly and follow YAML syntax standards. The approach properly addresses the linting issues while preventing future formatting conflicts.


You can now have the agent implement changes and create commits directly on your pull request's source branch. Simply comment with /q followed by your request in natural language to ask the agent to make changes.

@nx-cloud

nx-cloud Bot commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

View your CI Pipeline Execution ↗ for commit fdcdcf6

Command Status Duration Result
nx affected -t lint test build e2e-ci --verbose... ✅ Succeeded 5s View ↗

💡 Verify your cache is correct by running tasks in a sandbox. Read docs ↗


☁️ Nx Cloud last updated this comment at 2026-08-12 09:12:13 UTC

@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@devin-ai-integration
devin-ai-integration Bot marked this pull request as ready for review August 12, 2026 09:08
@codeant-ai

codeant-ai Bot commented Aug 12, 2026

Copy link
Copy Markdown

🤖 CodeAnt AI — Review Status

Status Commit Started (UTC) Finished (UTC)
✅ Reviewed your PR a4f9f21 Aug 12, 2026 · 09:11 09:12

@codeant-ai

codeant-ai Bot commented Aug 12, 2026

Copy link
Copy Markdown

Thanks for using CodeAnt! 🎉

We're free for open-source projects. if you're enjoying it, help us grow by sharing.

Share on X ·
Reddit ·
LinkedIn

@baz-reviewer

baz-reviewer Bot commented Aug 12, 2026

Copy link
Copy Markdown

Merger

Ready to Merge

MERGE: low-risk frontmatter formatting-only change with no open discussions; the tags remain YAML lists and the affected files are excluded from Prettier reformatting. CI did not run, but this isolated metadata change has no evident blocker.

Commit a4f9f21 · Evaluated 2026-08-12 09:11 UTC

Review this PR on Baz | Customize your next review

@codeant-ai codeant-ai Bot added the size:M This PR changes 30-99 lines, ignoring generated files label Aug 12, 2026
@gitar-bot

gitar-bot Bot commented Aug 12, 2026

Copy link
Copy Markdown

Important

You are using the Gitar free plan. Upgrade to unlock code review, CI analysis, auto-apply, custom automations, and more.

Gitar

@ThePlenkov
ThePlenkov merged commit 9880201 into main Aug 12, 2026
27 checks passed
@ThePlenkov
ThePlenkov deleted the fix/main-health branch August 12, 2026 10:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

baz: ready to merge size:M This PR changes 30-99 lines, ignoring generated files

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant