[docs] Obsolete PublishAsConnectionString migration guidance#1237
[docs] Obsolete PublishAsConnectionString migration guidance#1237aspire-repo-bot[bot] wants to merge 2 commits into
Conversation
… use AddConnectionString - Update 'Parameter example' in external-parameters.mdx to use execution-context-based pattern (IsRunMode) instead of the now-obsolete PublishAsConnectionString() API - Update the Japanese localized version of external-parameters.mdx to match - Mark PublishAsConnectionString as obsolete in the azure/overview.mdx API table and add a migration caution callout showing the AddConnectionString pattern with execution context Relates to microsoft/aspire#18044 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
aspire-repo-bot
Bot
added
the
docs-from-code
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 Aspire docs to reflect the deprecation of PublishAsConnectionString (Aspire 9.5) and guide users toward an execution-context-based pattern (AddConnectionString + run/publish branching).
Changes:
- Updates external parameters examples to avoid
PublishAsConnectionStringand use execution context branching. - Marks
PublishAsConnectionStringas obsolete in Azure docs and adds a cautionary migration callout. - Updates the Japanese localized fundamentals page to match the new C# guidance.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| src/frontend/src/content/docs/fundamentals/external-parameters.mdx | Updates C#/TS examples and steps to remove PublishAsConnectionString and use execution-context branching. |
| src/frontend/src/content/docs/integrations/cloud/azure/overview.mdx | Marks API as obsolete and adds a caution callout with a migration example. |
| src/frontend/src/content/docs/ja/fundamentals/external-parameters.mdx | Updates the Japanese C# example and steps to match the new execution-context pattern. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| var resource = builder.ExecutionContext.IsPublishMode | ||
| ? builder.AddAzureServiceBus("messaging") | ||
| : builder.AddConnectionString("messaging"); |
| IResourceBuilder<IResourceWithConnectionString> db = builder.ExecutionContext.IsRunMode | ||
| ? builder.AddSqlServer("sql").AddDatabase("db") | ||
| : builder.AddConnectionString("db"); | ||
|
|
||
| var insertionRows = builder.AddParameter("insertionRows"); |
|
We've retriggered CI several times, and the current failures appear to be caused by changes in this PR rather than a transient runner issue. This likely needs updates in the PR content/code to get green checks. |
|
[docs-from-code-ci] CI has been retriggered multiple times and is still failing. This appears to be due to the current PR changes rather than a transient infrastructure issue. |
|
CI has been retriggered multiple times and is still failing for this PR (latest failures: 'CI' (attempt 7)). This likely needs changes in the PR itself rather than another rerun. |
|
CI has already been retriggered many times here, and the current failure still looks content-related rather than transient. Latest failing signal: |
|
This PR has had CI retriggered multiple times and is still failing on PR-specific checks. It likely needs a change in this PR to pass. |
|
[docs-from-code automation] repeated-rerun-note |
|
We've retriggered CI many times on this PR and it's still failing. At this point, the failure likely comes from changes in this PR rather than transient CI flakiness, so this probably needs a content/code fix in the PR itself. |
|
CI has failed repeatedly on this docs-from-code PR after multiple reruns, and the failures appear to be related to the changes in this PR. Please review and adjust the PR content so the checks can pass. |
|
CI has been retriggered multiple times on this PR and is still failing. The failures appear tied to the current PR changes rather than a transient runner issue, so this likely needs an update in the PR content before CI will pass. |
|
[docs-from-code-ci-retry-note] We've retriggered CI multiple times and failures are still occurring. This appears likely caused by changes in this PR and may require updating the PR content to resolve. |
|
[docs-from-code-ci-retries] |
|
CI has been retriggered multiple times and is still failing. The failure appears to be related to the PR changes rather than transient runner issues, so this likely needs a docs/content fix in this PR. |
|
team We've retriggered CI multiple times and it is still failing on this PR. This appears to require changes in the PR itself to get green. |
|
CI has already been retriggered many times (30+ attempts) and continues to fail in frontend validation jobs (build/tests), which strongly suggests this is due to the current PR changes rather than transient CI instability. This PR likely needs an update to get green. |
|
CI has failed after multiple reruns on this PR. This likely indicates the failure is caused by the PR changes themselves and may need a code/doc fix before CI will pass. |
|
[docs-from-code-ci-repeated-failure] |
|
[docs-from-code-ci-retrigger-notice] |
|
docs-from-code: persistent-ci-failure-note |
|
This PR has had multiple CI reruns and the current failures appear to be caused by the changes in this PR (e.g., build/test/lint checks). Please address the failing jobs in this branch so this docs-from-code PR can move forward. |
|
[docs-from-code-ci-note] Please update the PR content to resolve the failing checks. |
|
[docs-from-code-auto-note] |
|
CI has been retriggered many times for this docs-from-code PR (latest run attempt: 47), and the recurring failure is in rontend-build / Frontend Build. This looks like a PR-content-related failure rather than an intermittent runner issue, so this PR likely needs a docs/content fix before CI can pass. |
CI has already been retriggered many times for this PR (current run attempt: 48) and the persistent failing check is frontend-build / Frontend Build. This looks likely tied to the current PR changes rather than a transient runner issue, so we should update the PR content to resolve it. |
|
docs-from-code reviewer note: CI has been retriggered multiple times and is still failing. This appears to be caused by changes in this PR, so this PR likely needs fixes before checks will pass. |
|
[docs-from-code-bot-note] |
CI Failures ReportBoth CI failures in this PR are due to changes in the PR content itself and require fixes before merging: 1. Forbidden Words Check Failed
2. TypeScript Compilation Errors in Code SamplesThree TypeScript diagnostic errors found in undamentals/external-parameters.mdx (block #10):
Fix Required: Update the code sample to fix these TypeScript errors. The snippet currently has syntax/type issues that would render compiler errors on aspire.dev. Once these content issues are resolved, the CI will pass and the PR will be ready to review. |
CI Failure: Forbidden Word DetectedThe Check forbidden words CI check is failing due to content in this PR. The word obsolete was detected as a forbidden phrase in the modified file:
This is a content-level failure that will persist across CI retriggers — it requires a manual fix. The PR correctly documents the API deprecation, but the forbidden-words check does not allow the term obsolete in added lines. Suggested fix: Replace obsolete with an acceptable equivalent such as deprecated or /cc @davidfowl |
|
[docs-from-code-ci-rerun-note] |
CI Failure NoticeThe PR currently has two CI issues that need to be addressed: 1. Forbidden Words Check ❌The content contains ".NET Aspire" but the style guide requires using just "Aspire" instead. Please update all instances of ".NET Aspire" to "Aspire" in the documentation. 2. Frontend Build Validation ❌There are 3 unexpected TypeScript diagnostics/validation errors in code blocks. These typically occur when:
Please review the code samples in your changes and ensure they compile correctly and match the current API signatures. Once these issues are fixed, the CI will pass automatically on the next push. |
|
CI has been re-run multiple times and is still failing for this PR. The failures appear tied to the current PR changes, so this likely needs a content/code fix in the branch rather than another retry. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: David Pine <david.pine@microsoft.com>
|
CI has been retriggered multiple times for this PR and is still failing on the current branch. This likely needs changes in this PR to resolve before checks can pass. |
|
[docs-from-code-ci-note] CI has been retriggered multiple times and failures are still occurring. These failures appear tied to the current PR changes and likely need fixes in this PR before CI will pass. |
|
CI has been retriggered multiple times and is still failing due to this PR's current changes. Please review and update the PR to address the failing checks. |
|
CI has already been retriggered numerous times on this PR, and the current failure is in rontend-build unit tests (not an infrastructure/startup issue). This likely needs a change in the PR content to resolve. |
|
[docs-from-code triage] CI was retriggered again, but this PR has already had numerous reruns (current workflow attempt: 10) and the failure is coming from PR content changes, not transient infra. Current failing diagnostics are in |
Documents changes from microsoft/aspire#18044 — authored by
@davidfowl.Targeting
release/13.5based on the source PR milestone13.5.Why this PR is needed
PublishAsConnectionString(in bothAspire.HostingandAspire.Hosting.Azure) has been marked[Obsolete]in .NET Aspire 9.5 (microsoft/aspire#18044). The API only changes the manifest representation and does not affect other publishers, which misled callers. Existing users who call it will now receive a CS0618 compiler warning directing them to useAddConnectionStringwith execution context instead.The docs previously contained code examples that called this API and a table entry listing it without any deprecation notice. Without documentation updates, users will see compiler warnings referencing an undocumented migration path.
Why docs are needed
Three signals fired from the source PR:
obsolete_attribute_added:[Obsolete]added toPublishAsConnectionStringinAzureResourceExtensions.csandParameterResourceBuilderExtensions.cspr_body_has_deprecation_marker: PR body explicitly states the extension methods are being made obsoletepr_label_breaking_change: PR carries thebreaking-changelabelChanges made
Updated:
src/frontend/src/content/docs/fundamentals/external-parameters.mdx.PublishAsConnectionString()call in the C# and TypeScript code examples with the preferred execution-context-based pattern usingIsRunMode/executionContext.isRunMode. The run-mode branch adds the actual SQL Server resource; the publish-mode branch usesAddConnectionString.Updated:
src/frontend/src/content/docs/integrations/cloud/azure/overview.mdxPublishAsConnectionStringrow in the API naming-conventions table as (obsolete) and updated its description to point toAddConnectionString.:::cautioncallout block below the table explaining the deprecation and showing the correctExecutionContext.IsPublishModemigration pattern.Updated:
src/frontend/src/content/docs/ja/fundamentals/external-parameters.mdx.PublishAsConnectionString(), used execution-context pattern).Files modified
src/frontend/src/content/docs/fundamentals/external-parameters.mdx(updated)src/frontend/src/content/docs/integrations/cloud/azure/overview.mdx(updated)src/frontend/src/content/docs/ja/fundamentals/external-parameters.mdx(updated)