Skip to content

Trim docs using pwsh via dotnet tool to support cross-platform local development. #4121

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
cheenamalhotra merged 2 commits into from
Apr 1, 2026
Merged

Trim docs using pwsh via dotnet tool to support cross-platform local development. #4121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4a44cd0
Trim docs using pwsh via dotnet tool to support cross-platform local …
mdaigle Mar 31, 2026
2fe538c
Merge branch 'main' into dev/mdaigle/pwsh-via-dotnet-tool
mdaigle Mar 31, 2026
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
7 changes: 7 additions & 0 deletions dotnet-tools.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,13 @@
"apicompat"
],
"rollForward": false
},
"powershell": {
"version": "7.6.0",
"commands": [
"pwsh"
],
"rollForward": false
}
}
}
9 changes: 6 additions & 3 deletions src/Microsoft.Data.SqlClient/ref/Microsoft.Data.SqlClient.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,10 @@
<OutputPath>$(ArtifactPath)$(AssemblyName).ref/$(ReferenceType)-$(Configuration)/</OutputPath>
</PropertyGroup>

<Target Name="RestoreTools">
<Exec Command="dotnet tool restore" />
Comment thread
mdaigle marked this conversation as resolved.
</Target>

<!-- Trim Docs for IntelliSense ====================================== -->
<!--
It has been determined that including the remarks section in IntelliSense docs looks bad in
Expand All @@ -46,12 +50,11 @@
<!-- This target runs after Build, and trims XML documentation generated in the $(OutputPath) of the project where this target is included.-->
<Target Name="TrimDocsForIntelliSense"
AfterTargets="Build"
DependsOnTargets="RestoreTools"
Condition="'$(IsCrossTargetingBuild)' != 'true' AND '$(GenerateDocumentationFile)' == 'true'">
Comment thread
mdaigle marked this conversation as resolved.
<PropertyGroup>
<PowerShellCommand Condition="'$(OS)' == 'Windows_NT'">powershell.exe</PowerShellCommand>
<PowerShellCommand Condition="'$(OS)' != 'Windows_NT'">pwsh</PowerShellCommand>
<PowerShellCommand>
$(PowerShellCommand)
dotnet tool run pwsh
-NonInteractive
-ExecutionPolicy Unrestricted
-Command "$(RepoRoot)tools\intellisense\TrimDocs.ps1 -inputFile '$(DocumentationFile)' -outputFile '$(DocumentationFile)'"
Expand Down
4 changes: 2 additions & 2 deletions tools/targets/TrimDocsForIntelliSense.targets
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ The .NET Foundation licenses this file to you under the MIT license. -->
<Project>
<!-- This target runs after Build, and trims XML documentation generated in the $(OutputPath) of the project where this target is included.-->
<Target Name="TrimDocsForIntelliSense" AfterTargets="Build" Condition="'$(GenerateDocumentationFile)' == 'true'">
<Exec Command="powershell.exe -NonInteractive -ExecutionPolicy Unrestricted -Command &quot;$(ToolsDir)intellisense\TrimDocs.ps1 -inputFile &apos;$(OutputPath)\Microsoft.Data.SqlClient.xml&apos; -outputFile &apos;$(OutputPath)\Microsoft.Data.SqlClient.xml&apos;&quot;" Condition=" '$(OS)' == 'Windows_NT' " />
<Exec Command="pwsh -NonInteractive -ExecutionPolicy Unrestricted -Command &quot;$(ToolsDir)intellisense\TrimDocs.ps1 -inputFile &apos;$(OutputPath)\Microsoft.Data.SqlClient.xml&apos; -outputFile &apos;$(OutputPath)\Microsoft.Data.SqlClient.xml&apos;&quot;" Condition=" '$(OS)' != 'Windows_NT' " />
<Exec Command="dotnet tool restore" />
<Exec Command="dotnet tool run pwsh -NonInteractive -ExecutionPolicy Unrestricted -Command &quot;$(ToolsDir)intellisense\TrimDocs.ps1 -inputFile &apos;$(OutputPath)\Microsoft.Data.SqlClient.xml&apos; -outputFile &apos;$(OutputPath)\Microsoft.Data.SqlClient.xml&apos;&quot;" />
Comment thread
mdaigle marked this conversation as resolved.
Comment thread
mdaigle marked this conversation as resolved.
</Target>
</Project>
Loading