[docs] Document Cosmos DB emulator default changes - #1563
[docs] Document Cosmos DB emulator default changes#1563aspire-repo-bot[bot] wants to merge 1 commit into
Conversation
…AsClassicEmulator) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
| /> | ||
|
|
||
| <Aside type="note"> | ||
| As of Aspire 13.6, `RunAsPreviewEmulator` and `WithDataExplorer` are no longer experimental and do not trigger `ASPIRECOSMOSDB001`. `RunAsEmulator` now defaults to the Linux-based (vNext) emulator, and `RunAsPreviewEmulator` is retained only as an obsolete compatibility alias that forwards to `RunAsEmulator`. Use `RunAsClassicEmulator` if you need the classic (Windows-based) emulator instead. This diagnostic only applies if you're using an earlier version of Aspire. |
There was a problem hiding this comment.
| As of Aspire 13.6, `RunAsPreviewEmulator` and `WithDataExplorer` are no longer experimental and do not trigger `ASPIRECOSMOSDB001`. `RunAsEmulator` now defaults to the Linux-based (vNext) emulator, and `RunAsPreviewEmulator` is retained only as an obsolete compatibility alias that forwards to `RunAsEmulator`. Use `RunAsClassicEmulator` if you need the classic (Windows-based) emulator instead. This diagnostic only applies if you're using an earlier version of Aspire. | |
| As of Aspire 17.0, `RunAsPreviewEmulator` and `WithDataExplorer` are no longer experimental and do not trigger `ASPIRECOSMOSDB001`. `RunAsEmulator` now defaults to the Linux-based (vNext) emulator, and `RunAsPreviewEmulator` is retained only as an obsolete compatibility alias that forwards to `RunAsEmulator`. Use `RunAsClassicEmulator` if you need the classic (Windows-based) emulator instead. This diagnostic only applies if you're using an earlier version of Aspire. |
David Pine (IEvangelist)
left a comment
There was a problem hiding this comment.
Docs-accuracy review — cannot verify against source of truth
Status: Claim verification (Phase A) could not run, and doc-tester (Phase B) was skipped.
This PR targets release/13.6, but microsoft/aspire has not yet cut a release/13.6 branch. The latest release branch there is release/13.5; the 13.6 changes currently live on main.
This reviewer verifies each claim against the release branch the PR actually targets. When that branch doesn't exist in microsoft/aspire, I flag the mismatch instead of falling back to another branch (e.g. main): main may have diverged from what 13.6 will ship, which would risk both false "verified" and false "contradicted" verdicts. So I have not verified the individual claims in this PR — the emulator vNext-default change, RunAsClassicEmulator, the now-obsolete RunAsPreviewEmulator, WithDataExplorer / NotSupportedException, and the ASPIRECOSMOSDB001 note.
Because Phase A could not establish a source of truth, Phase B (doc-tester) was skipped as well.
| Field | Value |
|---|---|
| PR target branch | release/13.6 |
Matching microsoft/aspire branch |
none (latest is release/13.5) |
| Head SHA reviewed | 3f8dcf169867a598d39f5e05fccea00f07fe6d4a |
Next step: once microsoft/aspire cuts release/13.6, push a new commit or re-request review and I'll verify every claim against that branch.
Automated docs-accuracy reviewer — branch-mismatch exit.
Adam Ratzman (adamint)
left a comment
There was a problem hiding this comment.
No additional issues beyond the existing review threads.
Documents changes from microsoft/aspire#19510
@eerhardtTargeting
release/17.0— the latest release branch onmicrosoft/aspire.dev— becauserelease/13.6(from the source PR milestone13.6) does not exist there.Why
microsoft/aspire#19510 makes the Linux-based (vNext) Cosmos DB emulator the default for
RunAsEmulator(previouslystable/classic), introduces a new non-experimentalRunAsClassicEmulatorAPI for the classic emulator, obsoletesRunAsPreviewEmulatoras a compatibility alias forwarding toRunAsEmulator, and promotesWithDataExplorerout of experimental status. This is a breaking-change PR (labeledbreaking-change) with a "User-facing usage" section in the PR body, so the docs need to reflect the new default behavior and API surface.What changed
integrations/cloud/azure/azure-cosmos-db/azure-cosmos-db-host.mdx:RunAsEmulatordefaulting to the vNext (vnext-latest) image, with a breaking-changeAsidepointing users toRunAsClassicEmulatorfor the old behavior.RunAsClassicEmulator(thestableimage, TLS/SSL certificate requirement) and a note thatRunAsPreviewEmulatoris now an obsolete alias forRunAsEmulator.ASPIRECOSMOSDB001) with a "Configure the Data Explorer" section showingWithDataExplorerused directly withRunAsEmulator, since both APIs are no longer experimental.diagnostics/aspirecosmosdb001.mdx: added a version note (matching the convention used for other retired experimental diagnostics, e.g.aspireazure002.mdx) explaining that as of Aspire 13.6RunAsPreviewEmulator/WithDataExplorerare no longer experimental and don't triggerASPIRECOSMOSDB001.No new pages were created; both existing pages were updated in place.