[docs] Document concrete Eventing.Subscribe<T> requirement - #1532
Closed
David Pine (IEvangelist) wants to merge 191 commits into
Closed
[docs] Document concrete Eventing.Subscribe<T> requirement#1532David Pine (IEvangelist) wants to merge 191 commits into
David Pine (IEvangelist) wants to merge 191 commits into
Conversation
…1181) * docs: document timestamp search qualifier for telemetry filtering Documents the new 'timestamp' search qualifier added in microsoft/aspire#17816. Users can now filter traces and structured logs by date/time using ISO 8601 strings with comparison operators (>, >=, <, <=) in the dashboard filter bar. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Move timestamp qualifier docs to shared CLI references Co-authored-by: JamesNK <303201+JamesNK@users.noreply.github.com> * Fix severity casing in timestamp search example Co-authored-by: JamesNK <303201+JamesNK@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: James Newton-King <james@newtonking.com> * Apply suggestion from @JamesNK * Apply suggestion from @JamesNK * docs: clarify date-only timestamp search values Co-authored-by: JamesNK <303201+JamesNK@users.noreply.github.com> * Apply suggestion from @JamesNK * Apply suggestion from @JamesNK * Update timestamp example dates to use 2026 --------- Co-authored-by: aspire-repo-bot[bot] <268009190+aspire-repo-bot[bot]@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: JamesNK <303201+JamesNK@users.noreply.github.com> Co-authored-by: James Newton-King <james@newtonking.com>
* Fix persistent container endpoint proxy default docs Persistent containers use proxied endpoints by default (same as session containers), while persistent executables and projects default to proxyless endpoints. Also document that proxyless container endpoints with only a targetPort immediately allocate the targetPort as the host port. Corrects docs that previously stated all persistent resources default to proxyless endpoints. Documents changes from microsoft/aspire#17960. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: aspire-repo-bot[bot] <268009190+aspire-repo-bot[bot]@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: David Negstad <50252651+danegsta@users.noreply.github.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…re#17889) (#1210) * docs: update Foundry Local section to reflect CLI-based lifecycle The Foundry Local integration now uses the installed 'foundry' CLI (foundry service start/stop/list and foundry model download/load) instead of the FoundryLocalManager in-proc APIs. Aspire manages the entire service lifecycle automatically. Update docs to: - Clarify users do not need to pre-start Foundry Local - State that the 'foundry' CLI must be on PATH - Describe the automatic start/stop lifecycle management Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: aspire-repo-bot[bot] <268009190+aspire-repo-bot[bot]@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Sébastien Ros <sebastienros@gmail.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Add a new row to the CLI telemetry data points table for Aspire CLI 13.5 documenting the new coding agent detection telemetry. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…8065-a0f9d35c8766b2f3 [docs] Document coding agent telemetry detection in CLI telemetry page
* docs: add WithTerminal() interactive terminal sessions page Documents the WithTerminal() experimental API introduced in Aspire 13.5: - Basic usage (C# and TypeScript) - Custom terminal dimensions - Multi-replica support - Dashboard terminal view - aspire terminal attach / aspire terminal ps CLI commands Closes microsoft/aspire#17866 (docs obligation) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * docs: address PR review feedback for withterminal docs - remove redundant sidebar translations block - clean up unused import and wording updates - fix CLI reference link target - remove duplicate build/run call in dimensions sample Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Mitch Denny <midenn@orangecake.local> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Update all banners (18 files across English and 16 locale variants) from 13.4 to 13.5 with engaging messaging - Replace 13.5 placeholder release notes with comprehensive content from the official changelog - Include detailed release highlights covering AppHost, CLI, Dashboard, and Extensions improvements - Document breaking changes (ServiceProvider renamed, PublishAsConnectionString obsolete, aspire ps --resources flag removed) - Maintain consistent tone and voice with prior What's new articles Changes cover: - Interactive terminal sessions with WithTerminal() - Polyglot IInteractionService across TypeScript, Python, Go, Java, Rust - User-defined resource command arguments - TypeScript AppHost stability fixes and optimizations - Custom health checks for TypeScript AppHosts - CLI enhancements (npm package, embedded skills bundle) - Dashboard telemetry improvements (timestamp filtering, better error messages) - VS Code extension enhancements (Dashboard side panel, Bun debugging, resource commands) - Foundry Local integration CLI updates - And more bug fixes and improvements Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Add documentation for the new operating system check introduced in microsoft/aspire#18252. The check appears in the Environment section of `aspire doctor` output and includes structured metadata in JSON format. Changes: - Update Environment checks description to mention OS reporting - Add OS check to sample table output - Add operating-system entry to JSON output example - Document the osType/displayName/version/description metadata fields Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Point to /app-host/withterminal/ which is the correct slug for the interactive terminal sessions page, fixing the starlight-links-validator CI failure. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
* Add deprecation notices to GitHub Models integration docs The GitHub Models service is no longer available to new customers. Aspire.Hosting.GitHub.Models is sunset in 13.5 — all public APIs are marked [Obsolete] and the package is hidden from aspire add. Add a :::caution callout to all three GitHub Models documentation pages to surface this to existing users. Documents changes from microsoft/aspire#18405. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * docs: add GitHub Models sunset to 13.5 breaking changes Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * docs: recommend Azure AI Foundry integration as GitHub Models replacement Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: David Pine <david.pine@microsoft.com> --------- Co-authored-by: aspire-repo-bot[bot] <268009190+aspire-repo-bot[bot]@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Sebastien Ros <sebastienros@gmail.com> Co-authored-by: David Pine <david.pine@microsoft.com>
…#1484) * docs: document AspireCliInvocationMode for dotnet run DNX invocation Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: David Pine <david.pine@microsoft.com> --------- Co-authored-by: aspire-repo-bot[bot] <268009190+aspire-repo-bot[bot]@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: David Pine <david.pine@microsoft.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: aspire-repo-bot[bot] <268009190+aspire-repo-bot[bot]@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: aspire-repo-bot[bot] <268009190+aspire-repo-bot[bot]@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…ns (#1519) * docs: document WithServiceDelegation and AzureSubnetServiceDelegations Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * docs: correct Azure subnet delegation guidance Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> * docs: fix Azure subnet delegation guidance Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> * Clarify subnet delegation behavior Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 32c349b4-907d-42e9-aad8-2f0edc267779 --------- Co-authored-by: aspire-repo-bot[bot] <268009190+aspire-repo-bot[bot]@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: David Pine <7679720+IEvangelist@users.noreply.github.com> Copilot-Session: 32c349b4-907d-42e9-aad8-2f0edc267779
) * docs: document ASPIRE009/010/011 and restored CLI bundle default Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * docs: correct Aspire CLI bundle diagnostics Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> * docs: distinguish DNX invocation modes Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> * Fix diagnostic overview messages Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> * Nest ASPIRE011 remedy examples Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: aspire-repo-bot[bot] <268009190+aspire-repo-bot[bot]@users.noreply.github.com> 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-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
…redential (#1527) * docs: document ITokenCredentialProvider for reusing Aspire's Azure credential Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * docs: correct Azure credential registration guidance Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 2fc23d00-db43-47fd-a3aa-290b772db576 * docs: add Azure Resource Manager namespace Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 2fc23d00-db43-47fd-a3aa-290b772db576 * docs: clarify Azure credential implementation detail Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 2fc23d00-db43-47fd-a3aa-290b772db576 --------- Co-authored-by: aspire-repo-bot[bot] <268009190+aspire-repo-bot[bot]@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: David Pine <7679720+IEvangelist@users.noreply.github.com> Copilot-Session: 2fc23d00-db43-47fd-a3aa-290b772db576
…certs trust` (#1528) * Document partial Linux certificate trust behavior in aspire certs trust Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Correct Linux certificate trust guidance Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 2fc23d00-db43-47fd-a3aa-290b772db576 * Fix certificate trust wording Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 2fc23d00-db43-47fd-a3aa-290b772db576 --------- Co-authored-by: aspire-repo-bot[bot] <268009190+aspire-repo-bot[bot]@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: David Pine <7679720+IEvangelist@users.noreply.github.com> Copilot-Session: 2fc23d00-db43-47fd-a3aa-290b772db576
…upling (ASPIREPROJECTS001) (#1511) * docs: add ASPIREPROJECTS001 diagnostic page; update ASPIREEXTENSION001 for public debug-support API surface Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Correct generated diagnostic documentation Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> * Correct diagnostics overview ordering Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> * Register projects diagnostic topic Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> * Document project launch args override API Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: aspire-repo-bot[bot] <268009190+aspire-repo-bot[bot]@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: David Pine <7679720+IEvangelist@users.noreply.github.com>
Co-authored-by: aspire-repo-bot[bot] <268009190+aspire-repo-bot[bot]@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…#1505) * docs: document mixed-quality staging package discovery for aspire add Documents microsoft/aspire#19426 - Fix mixed-quality staging package discovery. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: David Pine <david.pine@microsoft.com> --------- Co-authored-by: aspire-repo-bot[bot] <268009190+aspire-repo-bot[bot]@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: David Pine <david.pine@microsoft.com>
Co-authored-by: David Pine <dapine@microsoft.com> Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 32c349b4-907d-42e9-aad8-2f0edc267779
Co-authored-by: David Pine <7679720+IEvangelist@users.noreply.github.com> Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 2fc23d00-db43-47fd-a3aa-290b772db576
Co-authored-by: David Pine <7679720+IEvangelist@users.noreply.github.com>
* docs: document dashboard bundle preparation status message Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * docs: clarify dashboard startup status order Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: aspire-repo-bot[bot] <268009190+aspire-repo-bot[bot]@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: David Pine <7679720+IEvangelist@users.noreply.github.com>
Documents changes from microsoft/aspire#17235. Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
) * docs: document default fsGroup for Kubernetes persistent volumes Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * docs: address persistent volume review feedback Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: aspire-repo-bot[bot] <268009190+aspire-repo-bot[bot]@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: David Pine <david.pine@microsoft.com>
Resolve conflicts per update-release-branch.yml file-class policy (#1491): - Generated data (pkgs, ts-modules, twoslash, integrations, github-stats): kept release/13.5 staged 13.5.0 data - Curated content/imagery conflicts: kept release/13.5 versions (13.5 banners, dashboard screenshots, translations) - CustomSelect.astro + ui-regressions.spec.ts: took main (newer hardening #1490 + matching regression tests) - generate-ts-api-json.ps1: kept release/13.5 (superset: main API-gen hardening #1461 + carry-forward #1514) Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Contributor
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
David Pine (IEvangelist)
marked this pull request as ready for review
August 18, 2026 15:42
50 tasks
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the AppHost eventing documentation to clarify a public requirement of Eventing.Subscribe<T>(): the generic type argument must be a concrete event type (not an interface or abstract type), and that subscribing to an invalid type results in an ArgumentException.
Changes:
- Adds a new caution aside describing the “concrete event type” requirement for
Eventing.Subscribe<T>(). - Documents the
ArgumentExceptionbehavior and points readers to concrete event types likeBeforeStartEventandAfterResourcesCreatedEvent.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+117
to
+118
| `Eventing.Subscribe<T>()` requires `T` to be a concrete event type. | ||
| Subscribing to an interface or abstract class throws an `ArgumentException`. |
Comment on lines
+119
to
+122
| For `IDistributedApplicationEvent`, the exception message is | ||
| `Cannot subscribe to interface or abstract type 'IDistributedApplicationEvent'. Subscribe to a concrete event type instead.` | ||
| Use a concrete event type such as `BeforeStartEvent` or | ||
| `AfterResourcesCreatedEvent`. |
Member
Author
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
Eventing.Subscribe<T>()use a concrete event type.ArgumentExceptionbehavior and directs users to concrete event types such asBeforeStartEventorAfterResourcesCreatedEvent.src/frontend/src/content/docs/app-host/eventing.mdx.Related to microsoft/aspire#17094.
Target
This targets
release/13.5because aspire.dev has norelease/13.4branch.No reviewers requested yet.