-
-
Notifications
You must be signed in to change notification settings - Fork 749
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
PublicApiAnalyzer refinements (#3677)
- Loading branch information
1 parent
16c10d4
commit e5c0595
Showing
38 changed files
with
1,659 additions
and
258 deletions.
There are no files selected for viewing
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,177 @@ | ||
| using System.IO; | ||
| using System.Linq; | ||
| using Colorful; | ||
| using Nuke.Common; | ||
| using Nuke.Common.IO; | ||
| using Nuke.Common.Tooling; | ||
| using Nuke.Common.Tools.DotNet; | ||
| using static Nuke.Common.Tools.DotNet.DotNetTasks; | ||
| using static Nuke.Common.Tools.Git.GitTasks; | ||
| using static Helpers; | ||
| using System.Collections.Generic; | ||
| using System.Threading.Tasks; | ||
| using System.Text; | ||
| using System; | ||
| using System.Drawing; | ||
|
|
||
| partial class Build : NukeBuild | ||
| { | ||
| private readonly string _shippedApiFile = "PublicAPI.Shipped.txt"; | ||
| private readonly string _unshippedApiFile = "PublicAPI.Unshipped.txt"; | ||
| private readonly string _removedApiPrefix = "*REMOVED*"; | ||
|
|
||
| [Parameter] readonly string From; | ||
| [Parameter] readonly string To; | ||
| [Parameter] readonly bool Breaking; | ||
|
|
||
| Target CheckPublicApi => _ => _ | ||
| .DependsOn(Restore) | ||
| .Executes(() => | ||
| { | ||
| if (!InvokedTargets.Contains(Restore)) | ||
| { | ||
| DotNetBuildSonarSolution(AllSolutionFile); | ||
| } | ||
|
|
||
| DotNetBuild(c => c | ||
| .SetProjectFile(AllSolutionFile) | ||
| .SetNoRestore(InvokedTargets.Contains(Restore)) | ||
| .SetConfiguration(Configuration) | ||
| .SetProperty("RequireDocumentationOfPublicApiChanges", true)); | ||
| }); | ||
|
|
||
| Target AddUnshipped => _ => _ | ||
| .DependsOn(Restore) | ||
| .Executes(() => | ||
| { | ||
| // first we ensure that the All.sln exists. | ||
| if (!InvokedTargets.Contains(Restore)) | ||
| { | ||
| DotNetBuildSonarSolution(AllSolutionFile); | ||
| } | ||
|
|
||
| // new we restore our local dotnet tools including dotnet-format | ||
| DotNetToolRestore(c => c.SetProcessWorkingDirectory(RootDirectory)); | ||
|
|
||
| // last we run the actual dotnet format command. | ||
| DotNet($@"format ""{AllSolutionFile}"" --fix-analyzers warn --diagnostics RS0016", workingDirectory: RootDirectory); | ||
| }); | ||
|
|
||
| Target DiffShippedApi => _ => _ | ||
| .Executes(() => | ||
| { | ||
| var from = string.IsNullOrEmpty(From) ? GitRepository.Branch : From; | ||
| var to = string.IsNullOrEmpty(To) ? "main" : To; | ||
|
|
||
| if (from == to) | ||
| { | ||
| Colorful.Console.WriteLine("Nothing to diff here.", Color.Yellow); | ||
| return; | ||
| } | ||
|
|
||
| AbsolutePath shippedPath = SourceDirectory / "**" / _shippedApiFile; | ||
|
|
||
| Git($@" --no-pager diff --minimal -U0 --word-diff ""{from}"" ""{to}"" -- ""{shippedPath}""", RootDirectory); | ||
| }); | ||
|
|
||
| Target DisplayUnshippedApi => _ => _ | ||
| .Executes(async () => | ||
| { | ||
| var unshippedFiles = Directory.GetFiles(SourceDirectory, _unshippedApiFile, SearchOption.AllDirectories); | ||
|
|
||
| if (Breaking) | ||
| { | ||
| Colorful.Console.WriteLine("Unshipped breaking changes:", Color.Red); | ||
| } | ||
| else | ||
| { | ||
| Colorful.Console.WriteLine("Unshipped changes:"); | ||
| } | ||
|
|
||
| Colorful.Console.WriteLine(); | ||
|
|
||
| foreach (var unshippedFile in unshippedFiles) | ||
| { | ||
| IEnumerable<string> unshippedApis = await GetNonEmptyLinesAsync(unshippedFile); | ||
|
|
||
| if (Breaking) | ||
| { | ||
| unshippedApis = unshippedApis.Where(u => u.StartsWith(_removedApiPrefix)).ToList(); | ||
| } | ||
|
|
||
| if (!unshippedApis.Any()) | ||
| { | ||
| continue; | ||
| } | ||
|
|
||
| foreach (var unshippedApi in unshippedApis) | ||
| { | ||
| if (unshippedApi.StartsWith(_removedApiPrefix)) | ||
| { | ||
| var value = unshippedApi[_removedApiPrefix.Length..]; | ||
| Colorful.Console.WriteLine(value); | ||
| } | ||
| else | ||
| { | ||
| Colorful.Console.WriteLine(unshippedApi); | ||
| } | ||
| } | ||
| } | ||
| }); | ||
|
|
||
| Target MarkApiShipped => _ => _ | ||
| .Executes(async () => | ||
| { | ||
| var shippedFiles = Directory.GetFiles(SourceDirectory, _shippedApiFile, SearchOption.AllDirectories); | ||
|
|
||
| foreach (var shippedFile in shippedFiles) | ||
| { | ||
| var projectDir = Path.GetDirectoryName(shippedFile); | ||
| var unshippedFile = Path.Join(projectDir, _unshippedApiFile); | ||
|
|
||
| if (!File.Exists(unshippedFile)) | ||
| { | ||
| continue; | ||
| } | ||
|
|
||
| List<string> unshippedApis = await GetNonEmptyLinesAsync(unshippedFile); | ||
|
|
||
| if (!unshippedApis.Any()) | ||
| { | ||
| continue; | ||
| } | ||
|
|
||
| List<string> shippedApis = await GetNonEmptyLinesAsync(shippedFile); | ||
|
|
||
| List<string> removedApis = new(); | ||
|
|
||
| foreach (var unshippedApi in unshippedApis) | ||
| { | ||
| if (unshippedApi.StartsWith(_removedApiPrefix)) | ||
| { | ||
| var value = unshippedApi[_removedApiPrefix.Length..]; | ||
| removedApis.Add(value); | ||
| } | ||
| else | ||
| { | ||
| shippedApis.Add(unshippedApi); | ||
| } | ||
| } | ||
|
|
||
| IOrderedEnumerable<string> newShippedApis = shippedApis | ||
| .Where(s => !removedApis.Contains(s)) | ||
| .Distinct() | ||
| .OrderBy(s => s); | ||
|
|
||
| await File.WriteAllLinesAsync(shippedFile, newShippedApis, Encoding.ASCII); | ||
| await File.WriteAllTextAsync(unshippedFile, "", Encoding.ASCII); | ||
| } | ||
| }); | ||
|
|
||
| private static async Task<List<string>> GetNonEmptyLinesAsync(string filepath) | ||
| { | ||
| var lines = await File.ReadAllLinesAsync(filepath); | ||
|
|
||
| return lines.Where(c => !string.IsNullOrWhiteSpace(c)).ToList(); | ||
| } | ||
| } |
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| name: Check Public API | ||
|
|
||
| on: | ||
| pull_request: | ||
| branches: | ||
| - main | ||
|
|
||
| jobs: | ||
| check-public-api: | ||
| name: "Check Public API" | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v2 | ||
| - uses: actions/setup-dotnet@v1 | ||
| - run: ./build.sh CheckPublicApi | ||
| name: "Check for undocumented public API changes" |
Oops, something went wrong.