Welcome to mirror list, hosted at ThFree Co, Russian Federation.

RunApiDiff.md « release-notes - github.com/dotnet/core.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: be7a0fc600653e93832bcf1273983b44b651e366 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
# RunApiDiff Script

The [`RunApiDiff.ps1`](./RunApiDiff.ps1) script can automatically generate an API comparison report for two specified .NET previews, in the format expected for publishing in the dotnet/core repo.

## Instructions

1. Clone the dotnet/arcade repo. Let's assume you clone it into `D:\arcade`.
2. Clone the dotnet/core repo. Let's assume you clone it into `D:\core`.
3. Create a temporary directory. Let's assume you create it in `D:\tmp`.
4. Run the command. Execution example:

```powershell
.\RunApiDiff.ps1 `
   -PreviousDotNetVersion 7.0 `
   -PreviousPreviewOrRC preview `
   -PreviousPreviewNumberVersion 2 `
   -CurrentDotNetVersion 7.0 `
   -CurrentPreviewOrRC preview `
   -CurrentPreviewNumberVersion 3 `
   -CoreRepo D:\core\ `
   -ArcadeRepo D:\arcade\ `
   -TmpFolder D:\tmp\
```

Examples of what this script generates:

- PR comparing .NET 6.0 vs .NET 7.0 Preview1: https://github.com/dotnet/core/pull/7211
- PR comparing .NET 7.0 Preview1 vs Preview2: https://github.com/dotnet/core/pull/7307