Surface ASPIRE010 help link inline in warning text - #19375
Conversation
MSBuild HelpLink metadata is not rendered in terminal/console build output, so users who hit ASPIRE010 never saw the forward link. Append the help URL inline to the warning Text so it appears in the console, while keeping the existing HelpLink metadata. Keep the docs diagnostics table in sync. Contributes to #19368 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
|
🚀 Dogfood this PR with:
curl -fsSL https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 19375Or
iex "& { $(irm https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 19375" |
github-actions
Bot
added
the
needs-area-label
Tests selector (audit mode)The full test matrix and all jobs still run in audit mode. The tests and jobs below are what selective CI would run under enforcement. 42 / 100 test projects · 2 jobs, from 1 changed file. Selected test projects (42 / 100)
Selected jobs (2)
How these were chosen — grouped by what changed
🔧 show 41
📦 affected project Job reasons
Selection computed for commit |
There was a problem hiding this comment.
Pull request overview
Surfaces the ASPIRE010 help URL directly in console warning output.
Changes:
- Appends the diagnostic URL to the warning text.
- Synchronizes the diagnostics documentation.
Show a summary per file
| File | Description |
|---|---|
src/Aspire.Hosting.AppHost/build/Aspire.Hosting.AppHost.in.targets |
Adds the inline help URL. |
docs/list-of-diagnostics.md |
Updates the documented warning text. |
Review details
- Files reviewed: 2/2 changed files
- Comments generated: 1
- Review effort level: Balanced
|
Retrying the failed CI jobs for this pull request from the CI run attempt. The rerun is being tracked in the rerun attempt. |
0cedb24
into
main
|
/backport to release/13.5 |
|
Started backporting to |
|
Pull request created: #1504
|
|
📝 Documentation has been drafted in microsoft/aspire.dev#1504 targeting Added a note to
Note This draft PR needs human review before merging. |
Description
The MSBuild warning
ASPIRE010(emitted when an AppHost is configured withAspireUseCliBundle=false) carries its forward link only as aHelpLinkmetadata attribute pointing athttps://aka.ms/aspire/diagnostics/aspire010.MSBuild's
HelpLinkmetadata is not rendered in terminal/console build output, so users who hit this warning in the console never see the link. This surfaces the URL inline in the warningTextso it appears in console output, while keeping the existingHelpLinkmetadata as-is.Changes
src/Aspire.Hosting.AppHost/build/Aspire.Hosting.AppHost.in.targets: appendedSee https://aka.ms/aspire/diagnostics/aspire010 for more information.to the end of the ASPIRE010 warningText.HelpLink,Code,Condition, and target name are unchanged. (Edited the.in.targetssource template, not any generated.targets.)docs/list-of-diagnostics.md: updated theASPIRE010row's description to match the new message text.Existing MSBuild tests assert on substrings of the warning message and remain valid.
Contributes to #19368