Skip to content

Commit 4c895cf

Browse files
jeffhandleyCopilot
andcommitted
Simplify api-diff skill to single SKILL.md
Remove reference/interpreting-input.md and reference/parameters.md, consolidating the skill into a single file. The skill now only adds natural language to parameter mapping and defers to RunApiDiff.md for the full parameter reference. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 2dfb6b9 commit 4c895cf

File tree

3 files changed

+18
-63
lines changed

3 files changed

+18
-63
lines changed

.github/skills/api-diff/SKILL.md

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,31 @@ disable-model-invocation: true
66

77
# API Diff Generation
88

9-
This skill interprets the user's request and runs `release-notes/RunApiDiff.ps1` with the appropriate parameters.
9+
Map the user's request to parameters for `release-notes/RunApiDiff.ps1` and run it. See [release-notes/RunApiDiff.md](../../../release-notes/RunApiDiff.md) for the full parameter reference.
1010

11-
## Workflow
11+
When no versions are mentioned, run with no parameters — the script auto-infers versions.
1212

13-
### 1. Map the user's intent to script parameters
13+
## Mapping natural language to parameters
1414

15-
Read [reference/interpreting-input.md](reference/interpreting-input.md) for version format rules and examples of how to map natural language to script parameters. Read [reference/parameters.md](reference/parameters.md) for the full parameter reference.
15+
| User says | Parameters |
16+
|---|---|
17+
| "generate the next API diff" | *(none)* |
18+
| ".NET 10 GA vs .NET 11 Preview 1" | `-PreviousMajorMinor 10.0 -CurrentMajorMinor 11.0 -CurrentPrereleaseLabel preview.1` |
19+
| "net9.0-preview6 to net10.0-preview5" | `-PreviousMajorMinor 9.0 -PreviousPrereleaseLabel preview.6 -CurrentMajorMinor 10.0 -CurrentPrereleaseLabel preview.5` |
20+
| ".NET 10 RC 2 vs .NET 10 GA" | `-PreviousMajorMinor 10.0 -PreviousPrereleaseLabel rc.2 -CurrentMajorMinor 10.0` |
21+
| "10.0.0-preview.7.25380.108 to 10.0.0-rc.1.25451.107" | `-PreviousVersion "10.0.0-preview.7.25380.108" -CurrentVersion "10.0.0-rc.1.25451.107"` |
1622

17-
By default (when the user doesn't specify versions), RunApiDiff.ps1 auto-infers the next version from existing api-diff folders. Only supply parameters when the user explicitly mentions versions.
23+
- **GA** or no qualifier → omit the PrereleaseLabel parameter
24+
- **Preview N** / **previewN**`-PrereleaseLabel preview.N`
25+
- **RC N** / **rcN**`-PrereleaseLabel rc.N`
26+
- **netX.Y-previewN** (TFM format) → `-MajorMinor X.Y -PrereleaseLabel preview.N`
27+
- Full NuGet version strings → use `-PreviousVersion` / `-CurrentVersion` directly
28+
- The "previous" version is always the older version; "current" is the newer one
1829

19-
### 2. Run the script
20-
21-
Run the constructed command from the repository root. Set an initial wait of at least 300 seconds — the script takes several minutes to download packages and generate diffs. Use `read_powershell` to poll for completion.
30+
## Running the script
2231

2332
```powershell
2433
.\release-notes\RunApiDiff.ps1 [mapped parameters]
2534
```
2635

27-
**Detecting completion:** The API diff tool writes progress bars with ANSI escape sequences to the terminal, which makes output noisy and hard to parse. Do not try to detect completion from the command output. Instead, check whether the PowerShell process has exited — when the shell returns to a prompt or `read_powershell` reports the process has ended, the script is done. The script does not print a final "done" message; it simply exits after generating a README.md in the output folder.
28-
29-
After completion, summarize the results: how many diff files were generated and where.
36+
Set an initial wait of at least 300 seconds — the script takes several minutes. Use `read_powershell` to poll for completion. The script does not print a final "done" message; it exits after generating a README.md in the output folder. After completion, summarize the results: how many diff files were generated and where.

.github/skills/api-diff/reference/interpreting-input.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

.github/skills/api-diff/reference/parameters.md

Lines changed: 0 additions & 32 deletions
This file was deleted.

0 commit comments

Comments
 (0)