Skip to content

[docs] Document concrete Eventing.Subscribe<T> requirement - #1533

Merged
David Pine (IEvangelist) merged 1 commit into
mainfrom
dapine/docs-pr-17094-main-clean
Aug 20, 2026
Merged

[docs] Document concrete Eventing.Subscribe<T> requirement#1533
David Pine (IEvangelist) merged 1 commit into
mainfrom
dapine/docs-pr-17094-main-clean

Conversation

@IEvangelist

Copy link
Copy Markdown
Member

Summary

  • Documents the public requirement that Eventing.Subscribe<T>() use a concrete event type.
  • Preserves the exact public ArgumentException behavior and directs users to concrete event types such as BeforeStartEvent or AfterResourcesCreatedEvent.
  • Changes only src/frontend/src/content/docs/app-host/eventing.mdx.

Related to microsoft/aspire#17094.

Target

This targets main because #1233 squash-merged release/13.5 into main and the release branch was deleted. The branch was created directly from resulting main commit 785524f8ce21b9b17029f88123411c5c53d833db.

This clean main-based draft supersedes #1532, which GitHub automatically retargeted after the release branch deletion and expanded to 418 files because squash ancestry did not contain the old release head.

Validation

  • Repository Prettier check passed for eventing.mdx.
  • git diff --check passed.
  • The committed blob matches the previously source-audited one-file correction and contains no interface-subscription sample.

No reviewers requested yet. Auto-merge must remain off.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 32c349b4-907d-42e9-aad8-2f0edc267779
@aspire-repo-bot

Copy link
Copy Markdown
Contributor

Frontend HTML artifact ready

The latest frontend build uploaded the frontend-dist artifact for PR #1533. Use the VS Code button below to open this PR with GitHub Artifacts Explorer and browse the built HTML locally.

VS Code: Open PR #1533 artifacts

This comment updates automatically when a new frontend build artifact is uploaded.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the AppHost eventing documentation to explicitly state that Eventing.Subscribe<T>() requires a concrete event type, and that subscribing via an interface or abstract base type will throw an ArgumentException with the documented message.

Changes:

  • Adds a caution aside documenting the concrete-type requirement for Eventing.Subscribe<T>().
  • Documents the thrown exception type and the exact message for IDistributedApplicationEvent.
  • Points readers to concrete built-in event types (for example, BeforeStartEvent, AfterResourcesCreatedEvent) as the correct subscription targets.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@adamint Adam Ratzman (adamint) left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

@IEvangelist
David Pine (IEvangelist) merged commit 123bdee into main Aug 20, 2026
16 of 19 checks passed
@IEvangelist
David Pine (IEvangelist) deleted the dapine/docs-pr-17094-main-clean branch August 20, 2026 19:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants