Skip to content

Correct path to gather API docs artifacts in CI #22737

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rmarinho merged 3 commits into from
May 31, 2024
Merged

Correct path to gather API docs artifacts in CI #22737

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4df2627
Correct path to gather API docs artifacts in CI
jfversluis May 30, 2024
7538067
Update Application.xml
jfversluis May 30, 2024
2fe8b4c
Filter more non-useful files
jfversluis May 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 12 additions & 26 deletions eng/cake/dotnet.cake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@ if (TestTFM == "default")
Exception pendingException = null;

var NuGetOnlyPackages = new string[] {
"Microsoft.Maui.Controls.*.nupkg",
"Microsoft.Maui.Core.*.nupkg",
"Microsoft.Maui.Essentials.*.nupkg",
"Microsoft.Maui.Graphics.*.nupkg",
"Microsoft.Maui.Maps.*.nupkg",
"Microsoft.AspNetCore.Components.WebView.*.nupkg",
"Microsoft.Maui.Controls.*.{nupkg,snupkg}",
"Microsoft.Maui.Core.*.{nupkg,snupkg}",
"Microsoft.Maui.Essentials.*.{nupkg,snupkg}",
"Microsoft.Maui.Graphics.*.{nupkg,snupkg}",
"Microsoft.Maui.Maps.*.{nupkg,snupkg}",
"Microsoft.AspNetCore.Components.WebView.*.{nupkg,snupkg}",
};

ProcessTFMSwitches();
Expand Down Expand Up @@ -334,42 +334,28 @@ Task("dotnet-pack-docs")
EnsureDirectoryExists(destDir);
CleanDirectories(destDir);

// Get the docs for .NET MAUI
foreach (var nupkg in GetFiles("./artifacts/Microsoft.Maui.*.Ref.any.*.nupkg"))
{
var d = $"{tempDir}/{nupkg.GetFilename()}";

Unzip(nupkg, d);
DeleteFiles($"{d}/**/*.pri");
DeleteFiles($"{d}/**/*.aar");
DeleteFiles($"{d}/**/*.DesignTools.*");
CopyFiles($"{d}/ref/**/net?.?/**/*.dll", $"{destDir}");
CopyFiles($"{d}/ref/**/net?.?/**/*.xml", $"{destDir}");
}

// Get the docs for libraries separately distributed as NuGets
// Extract the binaries, xml & pdb files for docs purposes
foreach (var pattern in NuGetOnlyPackages)
{
foreach (var nupkg in GetFiles($"./artifacts/{pattern}"))
foreach (var nupkg in GetFiles($"./artifacts/**/{pattern}"))
{
var filename = nupkg.GetFilename().ToString();
var d = $"{tempDir}/{filename}";
Unzip(nupkg, d);
DeleteFiles($"{d}/**/*.pri");
DeleteFiles($"{d}/**/*.aar");
DeleteFiles($"{d}/**/*.pdb");
DeleteFiles($"{d}/**/*.DesignTools.*");
DeleteFiles($"{d}/**/*.resources.dll");

if (filename.StartsWith("Microsoft.AspNetCore.Components.WebView.Wpf")
|| filename.StartsWith("Microsoft.AspNetCore.Components.WebView.WindowsForms"))
{
CopyFiles($"{d}/lib/**/net?.?-windows?.?/**/*.dll", $"{destDir}");
CopyFiles($"{d}/lib/**/net?.?-windows?.?/**/*.xml", $"{destDir}");
CopyFiles($"{d}/lib/**/net?.?-windows?.?/**/*.{{dll,xml,pdb}}", $"{destDir}");

continue;
}

CopyFiles($"{d}/lib/**/{{net,netstandard}}?.?/**/*.dll", $"{destDir}");
CopyFiles($"{d}/lib/**/{{net,netstandard}}?.?/**/*.xml", $"{destDir}");
CopyFiles($"{d}/lib/**/net?.?/**/*.{{dll,xml,pdb}}", $"{destDir}");
}
}

Expand Down
4 changes: 2 additions & 2 deletions src/Controls/docs/Microsoft.Maui.Controls/Application.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@
<Docs>
<summary>Class that represents a cross-platform mobile application.</summary>
<remarks>
<para>The <see cref="T:Microsoft.Maui.Controls.Application" /> class is the core of a Microsoft.Maui.Controls application. It sets the root page of the application, persists primitive type data across invocations of the application in the <see cref="P:Microsoft.Maui.Controls.Application.Properties" /> dictionary, and provides events to respond to pushing and popping of modal views. Visual studio creates this class for the developer in the appropriate project in a new Microsoft.Maui.Controls solution.</para>
<para>The <see cref="T:Microsoft.Maui.Controls.Application" /> class is the core of a .NET MAUI application. It sets the root page of the application, and provides events to respond to pushing and popping of modal views. Visual Studio creates this class for the developer in the appropriate project in a new .NET MAUI solution.</para>
<example>
<para>Both Visual Studio for Mac and Visual Studio create a XAML and a code-behind file for the application when the developer creates a new Microsoft.Maui.Controls solution. The following example shows a typical <c>Application</c> class, with an entry in its resource dictionary.</para>
<para>Both Visual Studio creates a XAML and a code-behind file for the application when the developer creates a new .NET MAUI solution. The following example shows a typical <c>Application</c> class, with an entry in its resource dictionary.</para>
<code lang="XAML"><![CDATA[
<Application xmlns="http://xamarin.com/schemas/2014/forms"
xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
Expand Down