[docs] Document WithExplicitStart() callback deferral behavior - #1194
[docs] Document WithExplicitStart() callback deferral behavior#1194aspire-repo-bot[bot] wants to merge 2 commits into
Conversation
Add a new 'Defer resource start with explicit start' section to resource-lifetimes.mdx explaining how WithExplicitStart() interacts with execution configuration callbacks (WithEnvironment, WithArgs): - Session-scoped explicit-start resources defer DCP registration until manual start, so callbacks run only when the user starts the resource from the dashboard. - Persistent explicit-start resources are registered immediately (to detect existing instances), but use a Spec.Start patch on manual start so callbacks are not re-evaluated a second time. Documents microsoft/aspire#17825. 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. |
There was a problem hiding this comment.
Pull request overview
Updates the Configure resource lifetimes documentation to explain how WithExplicitStart() affects when resources start and when execution configuration callbacks are evaluated, based on resource lifetime.
Changes:
- Expanded the page frontmatter description to include explicit start.
- Added a new “Defer resource start with explicit start” section describing session-scoped vs. persistent behaviors with C# examples.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
IEvangelist
left a comment
There was a problem hiding this comment.
Source-of-truth branch mismatch — review skipped
Cannot verify this PR against microsoft/aspire.
PR base branch (microsoft/aspire.dev) |
release/13.5 |
Matching branch in microsoft/aspire |
does not exist |
Latest release branch in microsoft/aspire |
release/13.4 (4f2189335) |
| Source PR cited in body | microsoft/aspire# — merged to main, milestone 13.5 |
My review protocol requires using the matching microsoft/aspire release branch as the single source of truth for claim verification. Because no release/13.5 branch exists on microsoft/aspire yet (13.5 has not been cut), I cannot verify the API/CLI/config claims in this PR against an authoritative source code snapshot for that release.
Possible resolutions:
- Re-target this PR to
release/13.4inaspire.devif the documented behavior is already present in 13.4. - Wait until
release/13.5is cut inmicrosoft/aspire, then re-run review against that branch.
Skipping Phase B (doc-tester) as well — running it without the Phase A claim verification would produce an incomplete review per protocol.
Source-of-truth branch mismatch — feedback response pausedI rechecked this PR during the hourly docs-feedback pass and cannot verify it against
The feedback responder must verify API, behavior, CLI, configuration, package, and version claims against the matching |
|
I couldn't process the review feedback automatically because this PR targets Per the docs-feedback responder rules, source-of-truth verification must use the matching Aspire branch, so I'm stopping here rather than guessing against another branch. |
|
I couldn't process the review feedback automatically because this PR targets Per the docs-feedback responder rules, source-of-truth verification must use the matching Aspire branch, so I'm stopping here rather than guessing against another branch. No files were edited and no review threads were resolved. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Documents changes from microsoft/aspire#17825 by
@danegsta.Targeting
release/13.4— the latest release branch onmicrosoft/aspire.dev— becauserelease/13.5(from the source PR milestone13.5) does not exist there.Why this PR is needed
Aspire 13.5 changed how
WithExplicitStart()interacts with execution configuration callbacks (WithEnvironment,WithArgs, etc.):Spec.Start = truerather than delete/recreate, so callbacks are not re-evaluated a second time.This is a meaningful user-facing behavioral change for anyone using dynamic configuration callbacks (e.g., prompts for credentials) with
WithExplicitStart().What was changed
Updated
src/frontend/src/content/docs/app-host/resource-lifetimes.mdx:WithExplicitStart()and its two sub-behaviors (session-scoped vs. persistent).descriptionfrontmatter to mention explicit start.Files modified
src/frontend/src/content/docs/app-host/resource-lifetimes.mdx(updated)