Surface dotnet-getdocument output to Terminal Logger#66421
Open
KitKeen wants to merge 1 commit intodotnet:mainfrom
Open
Surface dotnet-getdocument output to Terminal Logger#66421KitKeen wants to merge 1 commit intodotnet:mainfrom
KitKeen wants to merge 1 commit intodotnet:mainfrom
Conversation
github-actions
Bot
added
the
area-commandlinetools
dotnet-policy-service
Bot
added
the
community-contribution
Contributor
|
Thanks for your PR, @KitKeen. Someone from the team will get assigned to your PR shortly and we'll get it reviewed. |
Add StandardOutputImportance="High" and StandardErrorImportance="High"
to the Exec task invoking dotnet-getdocument so its messages
("Generating document named 'v1'", etc.) are visible at default
verbosity when MSBuild Terminal Logger is enabled (default in .NET 8+).
Fixes dotnet#62273
KitKeen
force-pushed
the
fix/apidescription-server-terminal-logger
branch
from
6cdfbaf to
08780de
Compare
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #62273.
The
Microsoft.Extensions.ApiDescription.ServerMSBuild target invokesdotnet-getdocumentvia the<Exec>task. By default<Exec>capturesstdout/stderr at
MessageImportance="Low", so MSBuild Terminal Logger(default in .NET 8+) hides the messages emitted by the tool — including
Generating document named '{name}'andWriting document '{name}' to '{path}'.Users currently have to pass
--tl:offor-tlp:v=dto see them, whichis poorly discoverable.
Change
Add
StandardOutputImportance="High"andStandardErrorImportance="High"to the
<Exec>invocation insrc/Tools/Extensions.ApiDescription.Server/src/build/Microsoft.Extensions.ApiDescription.Server.targets.These attributes have been part of the MSBuild
Exectask for a long time(see also dotnet/msbuild#9810 for the broader Terminal Logger surfacing
work), so there is no SDK-version risk.
Behavior
dotnet-getdocumentare silent underTerminal Logger at default verbosity.
high-importance pipeline and shown in Terminal Logger like any other
high-priority build message.
Risk
Minimal. The change only raises the importance of messages already emitted
by the tool. No new messages, no behavior change at any verbosity level
where the messages were previously visible.