Skip to content
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.

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

Integrate InheritDoc into the build #17123

Merged
4 commits merged into from
Nov 23, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
4 changes: 2 additions & 2 deletions eng/Directory.Build.Data.props
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
<UpdateSourceOnBuild Condition="'$(UpdateSourceOnBuild)' == ''">$(AZURE_DEV_UPDATESOURCESONBUILD)</UpdateSourceOnBuild>
<PowerShellExe Condition="'$(PowerShellExe)' == ''">pwsh</PowerShellExe>
<CoverletOutputFormat Condition="'$(CoverletOutputFormat)' == '' and '$(CollectCoverage)' == 'true'">cobertura</CoverletOutputFormat>
<InheritDocEnabled Condition="'$(EnableInheritDoc)' == '' or '$(EnableInheritDoc)' == 'true'">true</InheritDocEnabled>
<InheritDocEnabled Condition="'$(EnableInheritDoc)' != 'false'">true</InheritDocEnabled>
christothes marked this conversation as resolved.
Show resolved Hide resolved
</PropertyGroup>

<PropertyGroup Condition="'$(IsShippingClientLibrary)' == 'true' and '$(TF_BUILD)' == 'true'">
Expand All @@ -69,7 +69,7 @@
</NoWarn>
</PropertyGroup>

<PropertyGroup Condition="'$(InheritDocEnabled)' == 'true' and '$(TargetFramework)'=='netstandard2.0'">
<PropertyGroup Condition="'$(EnableInheritDoc)' != 'false' and '$(TargetFramework)'=='netstandard2.0'">
<NoWarn>
$(NoWarn);IDT001<!-- InheritDoc related to malformed XML in netstandard.xml -->
</NoWarn>
Expand Down
8 changes: 4 additions & 4 deletions eng/Directory.Build.Data.targets
Original file line number Diff line number Diff line change
Expand Up @@ -201,14 +201,14 @@
</Target>

<!-- InheritDoc-->
<ItemGroup Condition="'$(InheritDocEnabled)' == 'true'">
<ItemGroup Condition="'$(EnableInheritDoc)' != 'false'">
<PackageReference Include="SauceControl.InheritDoc" PrivateAssets="all" />
</ItemGroup>

<!-- Fixup netstandard2.malformed docs issue https://github.com/saucecontrol/InheritDoc#bad-netstandard-docs -->
<ItemGroup Condition="'$(InheritDocEnabled)' == 'true' and '$(TargetFramework)'=='netstandard2.0'">
<PackageDownload Include="NETStandard.Library.Ref" Version="[2.1.0]" />
<InheritDocReference Include="$([MSBuild]::EnsureTrailingSlash('$(NugetPackageRoot)'))netstandard.library.ref\2.1.0\ref\netstandard2.1\netstandard.xml" />
<ItemGroup Condition="'$(EnableInheritDoc)' != 'false' and '$(TargetFramework)'=='netstandard2.0'">
<PackageDownload Include="NETStandard.Library.Ref" />
<InheritDocReference Include="$(NugetPackageRoot)\netstandard.library.ref\2.1.0\ref\netstandard2.1\netstandard.xml" />
</ItemGroup>

<!-- Additional PackageReferences should be placed above this PropertyGroup -->
Expand Down
7 changes: 6 additions & 1 deletion eng/Packages.Data.props
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,12 @@
</ItemGroup>

<!-- InheritDoc-->
<ItemGroup Condition="'$(InheritDocEnabled)' == 'true'">
<ItemGroup>
<PackageReference Update="SauceControl.InheritDoc" Version="1.1.1" />
</ItemGroup>

<ItemGroup Condition="'$(TargetFramework)'=='netstandard2.0'">
<PackageDownload Update="NETStandard.Library.Ref" Version="[2.1.0]" />
</ItemGroup>

</Project>