Skip to content

[Mono.Android] Improve generated API docs diff #7427

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
merged 2 commits into from
Sep 30, 2022
Merged

[Mono.Android] Improve generated API docs diff #7427

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c0f0d93
[Mono.Android] Improve generated API docs diff
pjcollins Sep 29, 2022
8739797
Apply feedback
pjcollins Sep 30, 2022
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
25 changes: 18 additions & 7 deletions src/Mono.Android/Mono.Android.targets
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<Project DefaultTargets="Build" ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
<UsingTask AssemblyFile="$(PrepTasksAssembly)" TaskName="Xamarin.Android.BuildTools.PrepTasks.ReplaceFileContents" />
<UsingTask AssemblyFile="$(PrepTasksAssembly)" TaskName="Xamarin.Android.BuildTools.PrepTasks.Git" />
<UsingTask AssemblyFile="$(BootstrapTasksAssembly)" TaskName="Xamarin.Android.Tools.BootstrapTasks.CheckApiCompatibility" />
<Import Project="..\..\build-tools\scripts\XAVersionInfo.targets" />
<Import Project="..\..\bin\Build$(Configuration)\Mono.Android.Apis.projitems" Condition="Exists('..\..\bin\Build$(Configuration)\Mono.Android.Apis.projitems')"/>
Expand Down Expand Up @@ -292,7 +293,7 @@
<DocsApiLevel Condition=" '$(DocsApiLevel)' == '' ">31</DocsApiLevel>
<DocsPlatformId Condition=" '$(DocsPlatformId)' == '' ">31</DocsPlatformId>
<DocsFxVersion Condition=" '$(DocsFxVersion)' == '' ">v12.0</DocsFxVersion>
<_Binlog>$(MSBuildThisFileDirectory)../../bin/Build$(Configuration)/UpdateApiDocs-$([System.DateTime]::Now.ToString ("yyyyMMddTHHmmss")).binlog</_Binlog>
<_LogPrefix>$(MSBuildThisFileDirectory)../../bin/Build$(Configuration)/UpdateApiDocs-$([System.DateTime]::Now.ToString ("yyyyMMddTHHmmss"))</_LogPrefix>
</PropertyGroup>

<!-- Generate documentation using MDoc -->
Expand All @@ -312,7 +313,7 @@
<_BuildProps Include="-p:AndroidFrameworkVersion=$(DocsFxVersion)" />
</ItemGroup>
<Exec
Command="&quot;$(DotNetPreviewTool)&quot; build -v:n -c $(Configuration) -bl:$(_Binlog) @(_BuildProps, ' ')"
Command="&quot;$(DotNetPreviewTool)&quot; build -v:n -c $(Configuration) -bl:$(_LogPrefix).binlog @(_BuildProps, ' ')"
IgnoreStandardErrorWarningFormat="True"
WorkingDirectory="$(MSBuildThisFileDirectory)"
/>
Expand Down Expand Up @@ -365,15 +366,25 @@
Command="$(ManagedRuntime) $(ManagedRuntimeArgs) $(_Mdoc) --debug update --use-docid --delete $(_Libdir) $(_ImportXml) $(_Output) $(_DocTypeArgs) $(_FxConfig) $(_Lang)"
WorkingDirectory="$(MSBuildThisFileDirectory)"
/>
<!-- Ensure updated docs can also be exported to msxdoc format -->
<Exec
Command="$(ManagedRuntime) $(ManagedRuntimeArgs) $(_Mdoc) --debug export-msxdoc -o &quot;$(_LogPrefix)-Export.xml&quot; &quot;$(XamarinAndroidSourcePath)external/android-api-docs/docs/Mono.Android/en/&quot;"
WorkingDirectory="$(MSBuildThisFileDirectory)"
/>
</Target>

<Target Name="_GenerateApiDocsDiff">
<PropertyGroup>
<_DiffFile>$(XamarinAndroidSourcePath)bin/Build$(Configuration)/UpdateApiDocs$([System.DateTime]::Now.ToString ("yyyyMMddTHHmmss")).diff</_DiffFile>
</PropertyGroup>
<Exec
Command="git diff --output=&quot;$(_DiffFile)&quot;"
<Git
Arguments="add ."
WorkingDirectory="$(XamarinAndroidSourcePath)external/android-api-docs"
ToolPath="$(GitToolPath)"
ToolExe="$(GitToolExe)"
/>
<Git
Arguments="diff --cached --output=&quot;$(_LogPrefix).diff&quot;"
WorkingDirectory="$(XamarinAndroidSourcePath)external/android-api-docs"
ToolPath="$(GitToolPath)"
ToolExe="$(GitToolExe)"
/>
</Target>

Expand Down