Skip to content

Ignore auto-generated AGENTS.md in markdownlint#8851

Merged
Evangelink merged 1 commit into
mainfrom
dev/amauryleve/lint-agents-md
Jun 5, 2026
Merged

Ignore auto-generated AGENTS.md in markdownlint#8851
Evangelink merged 1 commit into
mainfrom
dev/amauryleve/lint-agents-md

Conversation

@Evangelink

Copy link
Copy Markdown
Member

AGENTS.md is generated by gh copilot-curate (added in #8773) and uses underscore emphasis (skill, agent) plus an H2 first heading. Editing it by hand would be lost on the next regeneration, so add it to the ignore list alongside the other auto-managed paths.

Currently blocks the lint check on all open PRs (#8580, #8586, #8819, #8820, #8823, #4268 ...).

cc @Evangelink

/cc microsoft/testfx-collaborators

AGENTS.md is generated by 'gh copilot-curate' and uses underscore
emphasis (_skill_, _agent_) plus an H2 first heading. Editing it by
hand would be lost on the next regeneration, so add it to the ignore
list alongside the other auto-managed paths.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings June 5, 2026 07:38
@Evangelink Evangelink enabled auto-merge (squash) June 5, 2026 07:40

Copilot AI 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

This PR updates the repository’s markdownlint-cli2 configuration to ignore the root AGENTS.md file, which is auto-generated by gh copilot-curate and currently causes markdownlint failures due to its formatting (underscore emphasis and heading structure). This aligns AGENTS.md with other auto-managed/third-party markdown content already excluded from linting.

Changes:

  • Add AGENTS.md to .markdownlint-cli2.jsonc ignore patterns.
  • Document the reason inline (auto-generated; do not edit by hand).
Show a summary per file
File Description
.markdownlint-cli2.jsonc Adds AGENTS.md to the markdownlint ignore list to prevent lint failures on generated content.

Copilot's findings

  • Files reviewed: 1/1 changed files
  • Comments generated: 0

@Evangelink Evangelink left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Review: Ignore auto-generated AGENTS.md in markdownlint

All 21 review dimensions assessed. Only dimension 21 (Configuration Correctness) is applicable here.

Dimension Result
1. Algorithmic Correctness N/A
2. Threading & Concurrency N/A
3. Security & IPC Contract Safety N/A
4. Public API & Binary Compatibility N/A
5. Performance & Allocations N/A
6. Cross-TFM Compatibility N/A
7. Resource & IDisposable Management N/A
8–20. (all others) N/A
21. Configuration Correctness ✅ Clean

Configuration analysis:

  • "AGENTS.md" (bare filename) matches only the root-level file, which is the correct scope — gh copilot-curate generates AGENTS.md at the repo root.
  • eng/common/AGENTS.md is already covered by the existing "eng/**/*.md" pattern, so there is no gap.
  • The pattern is consistent with the existing "SECURITY.md" entry (bare name for root-only files).
  • The inline comment accurately describes the reason for the exclusion.

No issues found. The change correctly unblocks the lint check on open PRs.

Generated by Expert Code Review (on open) for issue #8851 · sonnet46 1.5M

@Evangelink Evangelink merged commit 648605c into main Jun 5, 2026
28 of 29 checks passed
@Evangelink Evangelink deleted the dev/amauryleve/lint-agents-md branch June 5, 2026 07:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants