docs: Fix Aspire.Hosting.Integration.Analyzers package reference in multi-language integration authoring guide#982
Merged
Conversation
The "Install the analyzer" section in the multi-language integration authoring guide instructed readers to add a PackageReference to `Aspire.Hosting.Integration.Analyzers`. That package does not exist on NuGet — the project in microsoft/aspire is `IsPackable=false`. The analyzer DLL ships embedded inside the `Aspire.Hosting` package and is activated via the `EnableAspireIntegrationAnalyzers` MSBuild property. Update the section (and the diagnostics-table heading prose) to reflect how the analyzer actually ships and how consumers enable it. Fixes #981 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Multi-language integrations authoring guide to remove instructions that reference a non-existent Aspire.Hosting.Integration.Analyzers NuGet package, aligning the docs with how the analyzer actually ships (embedded in Aspire.Hosting) and is enabled via MSBuild.
Changes:
- Renames “Install the analyzer” to “Enable the analyzer” and replaces the invalid
PackageReferencewith theEnableAspireIntegrationAnalyzersopt-in property. - Updates the analyzer diagnostics section intro to describe opt-in behavior instead of referencing the non-existent package.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
sebastienros
approved these changes
May 26, 2026
sebastienros
left a comment
sebastienros
left a comment
Contributor
There was a problem hiding this comment.
Looks good after preserving the legacy analyzer-section anchor.
IEvangelist
added a commit
that referenced
this pull request
Jun 1, 2026
* docs: Fix Aspire.Hosting.Integration.Analyzers package reference in multi-language integration authoring guide (#982) * docs: Fix Aspire.Hosting.Integration.Analyzers package reference The "Install the analyzer" section in the multi-language integration authoring guide instructed readers to add a PackageReference to `Aspire.Hosting.Integration.Analyzers`. That package does not exist on NuGet — the project in microsoft/aspire is `IsPackable=false`. The analyzer DLL ships embedded inside the `Aspire.Hosting` package and is activated via the `EnableAspireIntegrationAnalyzers` MSBuild property. Update the section (and the diagnostics-table heading prose) to reflect how the analyzer actually ships and how consumers enable it. Fixes #981 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * docs: Preserve analyzer section anchor Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: David Pine <dapine@microsoft.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Sebastien Ros <sebastienros@gmail.com> * Block rendered twoslash failures (#1085) Co-authored-by: David Pine <7679720+IEvangelist@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Hide most Asciinema embeds (#1086) Remove the repeated Asciinema recordings from CLI command docs, the CLI overview, AI coding agent docs, and the install component while leaving a single reference landing-page showcase in place. Co-authored-by: David Pine <7679720+IEvangelist@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Improve Mermaid loading styles (#1102) * Improve Mermaid loading styles Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Refine Mermaid loading skeleton Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: David Pine <7679720+IEvangelist@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Move repository skills to .agents (#1093) * Move repository skills to .agents Consolidate repository-owned skill files under .agents/skills and update repo guidance references to the standard location. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Prefer playwright-cli in doc skills Update doc-writer and doc-tester guidance to direct browser-based validation through playwright-cli instead of MCP-backed browser tooling. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Move twoslash validator skill to .agents Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> --------- Co-authored-by: David Pine <7679720+IEvangelist@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> --------- Co-authored-by: David Pine <dapine@microsoft.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Sebastien Ros <sebastienros@gmail.com> Co-authored-by: David Pine <7679720+IEvangelist@users.noreply.github.com> Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
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
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
The Multi-language integrations authoring guide currently tells readers to install a NuGet package that does not exist:
The corresponding project in
microsoft/aspire(Aspire.Hosting.Integration.Analyzers.csproj) sets<IsPackable>false</IsPackable>— the analyzer never ships as a standalone NuGet. Anyone following the guide hits NU1101.How the analyzer actually ships
It is embedded inside the
Aspire.HostingNuGet package via theIncludeIntegrationAnalyzerInPackagetarget inAspire.Hosting.csprojand activated by an MSBuild flag inbuildTransitive/Aspire.Hosting.targets:So integration authors just opt in:
Changes
## Install the analyzersection to## Enable the analyzer, explain that the analyzer ships insideAspire.Hosting, and replace the bogusPackageReferencesnippet with theEnableAspireIntegrationAnalyzersopt-in.## Analyzer diagnosticslede so it no longer names the non-existent package.Fixes #981.