Add API Review Agent Skill#15359
Merged
joperezr merged 4 commits intomicrosoft:release/13.2from Mar 19, 2026
Merged
Conversation
This skill allows us to automate parts of the API reviews that we do.
eerhardt
requested review from
Copilot and
mitchdenny
and removed request for
Copilot
Contributor
|
🚀 Dogfood this PR with:
curl -fsSL https://raw.githubusercontent.com/dotnet/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 15359Or
iex "& { $(irm https://raw.githubusercontent.com/dotnet/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 15359" |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new “api-review” agent skill to automate reviewing Aspire’s generated .NET API surface diffs (src/**/api/*.cs) against design guidelines and repo conventions.
Changes:
- Registers the new api-review skill in
AGENTS.md. - Adds a detailed
.github/skills/api-review/SKILL.mdplaybook covering diff extraction, review rules, git attribution, and posting review comments via the GitHub API.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| AGENTS.md | Lists the new api-review skill among available specialized skills. |
| .github/skills/api-review/SKILL.md | Defines the workflow, ruleset, and posting mechanics for automated API review. |
- Fix description to say 'developer who introduced each API (via git blame)' instead of 'PR author' to avoid misdirected attribution - Replace broken gh api --jsonArray bash example with Python script using json.dump + gh api --input (--jsonArray is not a real gh flag) - Provide non-empty review body instead of empty string to avoid API rejection Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Before posting review comments, the skill now checks for existing API review comments by the current user on the PR. If found, it skips duplicates, updates changed findings, and only posts net-new findings. This prevents duplicate comments when the skill runs against the same PR multiple times. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
joperezr
reviewed
Mar 18, 2026
|
|
||
| **Every finding MUST include author attribution before posting to the PR.** This is critical — it routes feedback to the right person and ensures accountability. | ||
|
|
||
| For each finding, identify who introduced the API change using `git blame` on the **source file** (not the auto-generated `api/*.cs` file). |
Member
There was a problem hiding this comment.
Does this successfully find the initial person adding the change versus the last one who touched it? (given blame shows the latter I think)
Member
Author
There was a problem hiding this comment.
It will find the person who last changed the API, which at least gets us close.
So if you introduced void Foo() and I changed it to int Foo(int a), I would get tagged.
joperezr
approved these changes
Mar 18, 2026
Member
joperezr
left a comment
joperezr
left a comment
There was a problem hiding this comment.
Tell-mode, infra only change
Member
|
Note that merges from release branch are paused now, so we will need to backport this to main |
JamesNK
approved these changes
Mar 18, 2026
Copilot AI
pushed a commit
that referenced
this pull request
Mar 19, 2026
* Add API Review Agent Skill This skill allows us to automate parts of the API reviews that we do. * updates - tag the original author in the comment * Address PR review feedback on api-review skill - Fix description to say 'developer who introduced each API (via git blame)' instead of 'PR author' to avoid misdirected attribution - Replace broken gh api --jsonArray bash example with Python script using json.dump + gh api --input (--jsonArray is not a real gh flag) - Provide non-empty review body instead of empty string to avoid API rejection Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add deduplication check to api-review skill Before posting review comments, the skill now checks for existing API review comments by the current user on the PR. If found, it skips duplicates, updates changed findings, and only posts net-new findings. This prevents duplicate comments when the skill runs against the same PR multiple times. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This skill allows us to automate parts of the API reviews that we do.