[docs] Obsolete PublishAsConnectionString migration guidance#1237
Draft
aspire-repo-bot[bot] wants to merge 1 commit into
Draft
[docs] Obsolete PublishAsConnectionString migration guidance#1237aspire-repo-bot[bot] wants to merge 1 commit into
aspire-repo-bot[bot] wants to merge 1 commit 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
14 tasks
Contributor
Author
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
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.
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)