Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Oct 21, 2025

Fixes #5315

This PR updates the Aspire orchestration overview documentation to include coverage of AddCSharpApp and CSharpAppResource, which were added in Aspire 9.5 to support C# file-based apps and provide an alternative way to add C# projects to the app model without requiring project references.

Changes

Built-in resource types table

Added a new row documenting the AddCSharpApp method and CSharpAppResource type, positioned directly after AddProject to show the relationship between the two approaches.

Enhanced project resources introduction

Updated the introductory paragraph to mention both methods for adding C# projects to the app model, noting that AddCSharpApp provides an alternative that doesn't require a project reference.

New AddCSharpApp documentation section

Added comprehensive documentation explaining:

  • How AddCSharpApp differs from AddProject (path-based vs project reference)
  • When to use AddCSharpApp (file-based apps from .NET 10, or projects without adding references)
  • Code examples showing usage with both .cs files and project directories:
    // Adds a file-based C# app "inventoryservice" from a .cs file.
    var inventoryService = builder.AddCSharpApp("inventoryservice", @"..\InventoryService.cs");
    
    // Adds a C# project "catalogservice" from a project directory.
    var catalogService = builder.AddCSharpApp("catalogservice", @"..\CatalogService");
  • Configuration compatibility with AddProject (replicas, environment variables, resource dependencies)
  • A note explaining the experimental status and .NET 10 SDK requirement for file-based apps

All changes follow the repository's documentation guidelines and have been validated with markdownlint.

Original prompt

Please work on issue #5315 - updating app-host-overview.md


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.


Internal previews

📄 File 🔗 Preview link
docs/fundamentals/app-host-overview.md Aspire orchestration overview

…view.md

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
Copilot AI changed the title [WIP] Update app host overview documentation Add AddCSharpApp and CSharpAppResource documentation to app-host-overview.md Oct 21, 2025
Copilot AI requested a review from IEvangelist October 21, 2025 12:08
Copilot finished work on behalf of IEvangelist October 21, 2025 12:09
@IEvangelist IEvangelist marked this pull request as ready for review October 23, 2025 12:16
@IEvangelist IEvangelist merged commit 7d37af5 into release-13 Oct 24, 2025
6 checks passed
@IEvangelist IEvangelist deleted the copilot/update-app-host-overview-md branch October 24, 2025 12:13
IEvangelist added a commit that referenced this pull request Nov 11, 2025
* Document ClaimActions configuration for dashboard OpenID Connect authentication (#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>

* Document breaking change: DefaultAzureCredential defaults to ManagedIdentityCredential 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>

* Update Azure AI Foundry and GitHub Models documentation to use strongly-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>

* Update environment variable format to polyglot-friendly pattern (#5320)

* 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>

* Update AppHost project documentation for Aspire 13.0 SDK format (#5319)

* 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>

* Add AddCSharpApp and CSharpAppResource documentation to app-host-overview.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>

* Add breaking changes documentation for pipeline activity reporter API 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>

* Add documentation for ASPIREPIPELINES001, ASPIREPIPELINES002, and ASPIREPIPELINES003 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>

* Add Aspire MCP docs (#5446)

* Update configuration

* Document deployment state caching (#5301)

* 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>

* Add certificate trust customization article for Aspire 13 (#5311)

* 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>

* Update documentation for new polyglot environment variables (issue #5308) (#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>

* Update documentation for Aspire 13 release

* Apply suggestions from code review

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* fix: build

---------

Co-authored-by: Copilot <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>
Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
Co-authored-by: captainsafia <1857993+captainsafia@users.noreply.github.com>
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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants