Content for Aspire v13 #5199
Merged
Content for Aspire v13 #5199
+1,317
−107
Conversation
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
…entication (#5192) * Initial plan * Document ClaimActions configuration for dashboard OIDC authentication Co-authored-by: JamesNK <303201+JamesNK@users.noreply.github.com> * Apply suggestion from @JamesNK * Apply suggestion from @JamesNK * Apply suggestion from @JamesNK * Update configuration.md --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: JamesNK <303201+JamesNK@users.noreply.github.com> Co-authored-by: James Newton-King <james@newtonking.com>
…dentityCredential on ACA and App Service (#5303) * Initial plan * Add breaking change documentation for DefaultAzureCredential in 13.0 Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Fix markdown linting error - add blank line before list Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Update docs/compatibility/13.0/defaultazurecredential-managedidentity-default.md --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> Co-authored-by: David Pine <david.pine@microsoft.com>
…ly-typed model constants (#5302) * Initial plan * Update documentation to use AIFoundryModel and GitHubModel constants Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Update compatibility matrix to use GitHubModel constant Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Apply suggestions from code review --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> Co-authored-by: David Pine <david.pine@microsoft.com>
* Initial plan * Update environment variable format to polyglot-friendly pattern Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
* Initial plan * Update AppHost project section to show new SDK format for Aspire 13.0 Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
…view.md (#5318) * Initial plan * Add AddCSharpApp and CSharpAppResource documentation to app-host-overview.md Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Apply suggestions from code review * Update docs/fundamentals/app-host-overview.md --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> Co-authored-by: David Pine <david.pine@microsoft.com>
… rename (PR #12137) (#5310) * Initial plan * Add breaking changes article for PR #12137 and update documentation Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Fix parameter naming consistency in breaking change examples Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Fix cross reference warnings by using inline code formatting Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> Co-authored-by: David Pine <david.pine@microsoft.com>
…IREPIPELINES003 diagnostics (#5359) * Initial plan * Add documentation for three new pipeline-related diagnostics Co-authored-by: captainsafia <1857993+captainsafia@users.noreply.github.com> * Fix ms.date to reflect current date in diagnostic documentation Co-authored-by: captainsafia <1857993+captainsafia@users.noreply.github.com> * Update diagnostic codes to use ASPIREPIPELINES001-003 instead of mixed naming scheme Co-authored-by: captainsafia <1857993+captainsafia@users.noreply.github.com> * Add ASPIREPIPELINES001-003 diagnostics to TOC Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: captainsafia <1857993+captainsafia@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
Member
|
@IEvangelist I've added new dashboard configuration for v13. The changes will need to be mirrored to aspire.dev. |
* Initial plan * Add local deployment state documentation Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Address feedback: Add intros, italicize paths, add CI/CD example Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Rename and relocate deployment state doc outside Azure section Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Clarify cache save behavior in GitHub Actions example Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
* Initial plan * Add certificate trust customization article Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Fix cross-reference title to match actual article title Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Address PR feedback: update API examples, add runtime callout, document default scopes Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Update callback APIs to use async Task and simplified context objects Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Replace deprecated callback APIs with new simplified APIs Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
Copilot finished reviewing on behalf of
IEvangelist
November 11, 2025 05:03
) (#5313) * Initial plan * Update documentation with new polyglot environment variable format Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Add clarification about resource names in environment variables Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Improve clarity of note about connection name parameter Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> * Update docs/fundamentals/app-host-overview.md --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> Co-authored-by: David Pine <david.pine@microsoft.com>
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR contains comprehensive documentation updates for Aspire v13, including breaking changes, new features, and updated code examples to reflect the latest API changes.
- Purpose: Document Aspire v13.0 features, breaking changes, and updated APIs
- Key Changes:
- Introduced MCP (Model Context Protocol) server documentation
- Updated environment variable naming convention from
services__*__*__0to{RESOURCENAME}_{ENDPOINTNAME}format - Renamed pipeline activity reporter APIs from
IPublishingActivityReportertoIPipelineActivityReporter - Added documentation for three new ASPIREPIPELINES diagnostics
- Updated breaking changes documentation with two new entries for v13.0
- Enhanced GitHub Models and Azure AI Foundry integrations to use strongly-typed model constants
Reviewed Changes
Copilot reviewed 32 out of 33 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/toc.yml | Added MCP server and new pipeline diagnostic entries to navigation |
| docs/testing/snippets/testing/xunit/AspireApp.Tests/EnvVarTests.cs | Updated environment variable names to new format (APISERVICE_HTTPS) |
| docs/testing/snippets/testing/nunit/AspireApp.Tests/EnvVarTests.cs | Updated environment variable names to new format (APISERVICE_HTTPS) |
| docs/testing/snippets/testing/mstest/AspireApp.Tests/EnvVarTests.cs | Updated environment variable names to new format (APISERVICE_HTTPS) |
| docs/snippets/azure/AppHost/AppHost.cs | Updated Phi-4 model version from "1" to "7" |
| docs/github/github-models-integration.md | Updated to use strongly-typed GitHubModel constants throughout examples |
| docs/get-started/build-aspire-apps-with-nodejs.md | Updated environment variable references to new naming format |
| docs/fundamentals/orchestrate-resources.md | Updated environment variable examples to new format |
| docs/fundamentals/dashboard/snippets/Mcp/launchSettings.json | Added new configuration example for MCP endpoint |
| docs/fundamentals/dashboard/mcp-server.md | New comprehensive documentation for Aspire MCP server feature |
| docs/fundamentals/dashboard/configuration.md | Added MCP endpoint configuration options and claim actions documentation |
| docs/fundamentals/custom-deployments.md | Updated API names from PublishingActivityReporter to PipelineActivityReporter |
| docs/fundamentals/app-host-overview.md | Updated to document new SDK configuration and AddCSharpApp method |
| docs/extensibility/interaction-service.md | Updated context reference from DeploymentContext to PipelineStepContext |
| docs/extensibility/dev-tunnels-integration.md | Updated environment variable example to new format |
| docs/diagnostics/overview.md | Added three new ASPIREPIPELINES diagnostic entries |
| docs/diagnostics/aspirepipelines001.md | New diagnostic documentation for pipeline infrastructure APIs |
| docs/diagnostics/aspirepipelines002.md | New diagnostic documentation for deployment state manager APIs |
| docs/diagnostics/aspirepipelines003.md | New diagnostic documentation for container image build APIs |
| docs/deployment/manifest-format.md | Updated environment variable examples to new format |
| docs/deployment/azd/aca-deployment-azd-in-depth.md | Updated environment variable examples in deployment configuration |
| docs/compatibility/toc.yml | Added Aspire 13.0 section with breaking changes navigation |
| docs/compatibility/13.0/index.md | New breaking changes overview for v13.0 |
| docs/compatibility/13.0/pipeline-activity-reporter-renamed.md | New breaking change documentation for renamed APIs |
| docs/compatibility/13.0/defaultazurecredential-managedidentity-default.md | New breaking change documentation for credential behavior |
| docs/azureai/azureai-foundry-integration.md | Updated to use strongly-typed AIFoundryModel constants |
| docs/azureai/ai-integrations-compatibility-matrix.md | Updated GitHub Models example to use strongly-typed constants |
joperezr
approved these changes
Nov 11, 2025
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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.
Content for v13:
Internal previews
Toggle expand/collapse