You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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>
Copy file name to clipboardExpand all lines: .github/skills/api-diff/SKILL.md
+18-11Lines changed: 18 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,24 +6,31 @@ disable-model-invocation: true
6
6
7
7
# API Diff Generation
8
8
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.
10
10
11
-
## Workflow
11
+
When no versions are mentioned, run with no parameters — the script auto-infers versions.
12
12
13
-
### 1. Map the user's intent to script parameters
13
+
##Mapping natural language to parameters
14
14
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`|
| "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"`|
16
22
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
- Full NuGet version strings → use `-PreviousVersion` / `-CurrentVersion` directly
28
+
- The "previous" version is always the older version; "current" is the newer one
18
29
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.
**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.
0 commit comments