Set default OutputPath and add IntermediateOutputPath at PipelineContext level #12414

Copilot · 2025-10-27T20:27:37Z

Summary: Fix Default Output Path Issue During Aspire Deploy

The issue occurs when aspire deploy or aspire do <step> is called without an explicit --output-path. Previously, various parts of the code assumed OutputPath would always be set, causing failures.

Solution (Rebased on latest main)

Following feedback, the fix now sets defaults at the PipelineContext level and simplifies the code:

Default OutputPath is set in PipelineContext constructor to Path.Combine(Environment.CurrentDirectory, "aspire-output") when null
Added IntermediateOutputPath property to PipelineContext for temporary build artifacts
- Uses Directory.CreateTempSubdirectory to create temp folders
- For known apphosts: creates subfolder with prefix aspire-{appHostSha} using IConfiguration["AppHost:PathSha256"]
- For unknown apphosts: creates subfolder with prefix aspire
Removed PublishingContextUtils class entirely
- Inlined the simple logic directly in Docker and Kubernetes environment resources
- Logic: if multiple compute environments, append environment name to output path; otherwise use root output path
Removed CLI default output path logic
- PublishCommand no longer sets a default output path to "aspire-output"
- Default is now only set in PipelineContext, ensuring consistency
Changed OutputPath from nullable to non-nullable since it always has a default value

Testing Results

CLI tests (DeployCommand): 6/6 passed ✅
Kubernetes tests: 10/10 passed ✅
Docker tests: 56/56 passed ✅

Files Changed

src/Aspire.Hosting/Pipelines/PipelineContext.cs: Added defaults for OutputPath and IntermediateOutputPath using Directory.CreateTempSubdirectory
src/Aspire.Hosting/Pipelines/PipelineStepContext.cs: Exposed IntermediateOutputPath, changed OutputPath to non-nullable
src/Shared/PublishingContextUtils.cs: Deleted - logic inlined where needed
src/Aspire.Hosting.Azure/AzureEnvironmentResource.cs: Removed exception for null OutputPath
src/Aspire.Hosting.Docker/DockerComposeEnvironmentResource.cs: Inlined output path logic, removed PublishingContextUtils usage
src/Aspire.Hosting.Docker/Aspire.Hosting.Docker.csproj: Removed PublishingContextUtils.cs reference
src/Aspire.Hosting.Kubernetes/KubernetesEnvironmentResource.cs: Inlined output path logic, removed PublishingContextUtils usage
src/Aspire.Hosting.Kubernetes/Aspire.Hosting.Kubernetes.csproj: Removed PublishingContextUtils.cs reference
src/Aspire.Hosting.Docker/DockerComposePublishingContext.cs: Removed null check exception
src/Aspire.Hosting.Kubernetes/KubernetesPublishingContext.cs: Removed null check exception
src/Aspire.Hosting/Cli/Commands/PublishCommand.cs: Removed default output path logic (now handled in PipelineContext)

The fix ensures consistent and predictable output paths across all publish/deploy commands, with defaults set at a single location in PipelineContext.

Fixes Default output path set from CLI not respected during aspire deploy #12412

Original prompt

This section details on the original issue you should resolve

<issue_title>Default output path set from CLI not respected during aspire deploy</issue_title>
<issue_description>The default output path that should be set during aspire deploy is not respected on the host side. Things work fine if you call aspire publish at the top level but not if you do aspire do publish-step.

Instead of throwing an exception when the OutputPath is set, use a fallback value that is the CWD + aspire-output in the PublishingContext for each resource.</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes Default output path set from CLI not respected during aspire deploy #12412

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

- Update PublishingContextUtils.GetEnvironmentOutputPath to use fallback when OutputPath is null - Fallback is Path.Combine(Environment.CurrentDirectory, "aspire-output") - Add comprehensive tests for null and non-null output paths - Add tests for single and multiple environment scenarios Co-authored-by: captainsafia <1857993+captainsafia@users.noreply.github.com>

github-actions · 2025-10-27T20:58:47Z

🚀 Dogfood this PR with:

⚠️ WARNING: Do not do this without first carefully reviewing the code of this PR to satisfy yourself it is safe.

curl -fsSL https://raw.githubusercontent.com/dotnet/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 12414

Or

Run remotely in PowerShell:

iex "& { $(irm https://raw.githubusercontent.com/dotnet/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 12414"

github-actions · 2025-10-27T20:58:48Z

🚀 Dogfood this PR with:

⚠️ WARNING: Do not do this without first carefully reviewing the code of this PR to satisfy yourself it is safe.

curl -fsSL https://raw.githubusercontent.com/dotnet/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 12414

Or

Run remotely in PowerShell:

iex "& { $(irm https://raw.githubusercontent.com/dotnet/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 12414"

captainsafia

@copilot We need to fix all the of the checks when initializing the output path:

aspire/src/Aspire.Hosting.Azure/AzureEnvironmentResource.cs

Line 126 in e39f33d

context.OutputPath ?? throw new InvalidOperationException("OutputPath is required for Azure publishing."),
https://github.com/dotnet/aspire/blob/main/src/Aspire.Hosting.Docker/DockerComposePublishingContext.cs#L40
aspire/src/Aspire.Hosting.Kubernetes/KubernetesPublishingContext.cs

Line 23 in e39f33d

public readonly string OutputPath = outputPath ?? throw new InvalidOperationException("OutputPath is required for Kubernetes publishing.");

Unify the handling for output path across all these areas.

captainsafia · 2025-10-28T15:53:27Z

tests/Aspire.Hosting.Kubernetes.Tests/PublishingContextUtilsTests.cs

Delete this test file.

Done in commit 5ce261a.

- Azure: Use fallback to Path.Combine(Environment.CurrentDirectory, "aspire-output") when OutputPath is null - Docker: Remove null check exception since PublishingContextUtils.GetEnvironmentOutputPath guarantees non-null - Kubernetes: Remove null check exception since PublishingContextUtils.GetEnvironmentOutputPath guarantees non-null - Delete PublishingContextUtilsTests.cs as requested Co-authored-by: captainsafia <1857993+captainsafia@users.noreply.github.com>

Copilot · 2025-10-28T16:10:37Z

@copilot We need to fix all the of the checks when initializing the output path:

https://github.com/dotnet/aspire/blob/e39f33d23d01e443be1ff2215e029f1a483bbc54/src/Aspire.Hosting.Azure/AzureEnviron...

Unified output path handling across all three locations in commit 5ce261a:

Azure: Added fallback to Path.Combine(Environment.CurrentDirectory, "aspire-output") when OutputPath is null
Docker: Removed exception since PublishingContextUtils.GetEnvironmentOutputPath guarantees non-null
Kubernetes: Removed exception since PublishingContextUtils.GetEnvironmentOutputPath guarantees non-null

davidfowl · 2025-10-31T00:59:04Z

@copilot Let's do this generally at the PipelineStepContext level and set a default top level when creating it. Let's also add an IntermediateOutputPath and default that to a temporary folder derived from apphost path (IConfiguration["AppHost:PathSha256"]).

…utputPath - Set OutputPath default to Path.Combine(Environment.CurrentDirectory, "aspire-output") in PipelineContext constructor - Add IntermediateOutputPath property to PipelineContext, defaulting to Path.Combine(Path.GetTempPath(), "aspire", appHostSha) - IntermediateOutputPath uses IConfiguration["AppHost:PathSha256"] for consistent temporary folder per apphost - Change OutputPath from nullable to non-nullable since it always has a default value - Simplify PublishingContextUtils to use non-nullable OutputPath - Update Azure, Docker, and Kubernetes to use non-nullable OutputPath - Remove redundant null checks and exceptions Co-authored-by: davidfowl <95136+davidfowl@users.noreply.github.com>

Copilot · 2025-10-31T01:10:17Z

@copilot Let's do this generally at the PipelineStepContext level and set a default top level when creating it. Let's also add an IntermediateOutputPath and default that to a temporary folder derive...

Implemented in commit 7a481ce:

Set default OutputPath at PipelineContext level to Path.Combine(Environment.CurrentDirectory, "aspire-output") when null
Added IntermediateOutputPath property to PipelineContext, defaulting to Path.Combine(Path.GetTempPath(), "aspire", appHostSha) using IConfiguration["AppHost:PathSha256"]
Changed OutputPath to non-nullable since it now always has a default value
Simplified all consuming code to use non-nullable OutputPath

src/Aspire.Hosting/Pipelines/PipelineContext.cs

…and remove CLI default output path - Use Directory.CreateTempSubdirectory for IntermediateOutputPath instead of manual path construction - Remove PublishingContextUtils class entirely and inline logic where needed - Inline GetEnvironmentOutputPath logic in Docker and Kubernetes environment resources - Remove PublishingContextUtils.cs file and references from .csproj files - Remove special case logic in PublishCommand that sets default output path to "aspire-output" - Output path now defaults in PipelineContext only, not in CLI Co-authored-by: davidfowl <95136+davidfowl@users.noreply.github.com>

davidfowl · 2025-10-31T07:02:22Z

@copilot Redo this change in the face of the merge conflcit

Copilot · 2025-10-31T07:18:46Z

@copilot Redo this change in the face of the merge conflcit

Rebased all changes onto latest main in commit ffacbc0. All changes have been reapplied cleanly on top of the latest main branch. Tests pass successfully:

CLI DeployCommand tests: 6/6 ✅
Docker tests: 56/56 ✅
Kubernetes tests: 10/10 ✅

The branch is ready but I need assistance force-pushing the rebased branch since I don't have direct push access.

eerhardt · 2025-10-31T15:24:27Z

src/Aspire.Hosting/Pipelines/PipelineContext.cs

+    /// </summary>
+    public string IntermediateOutputPath { get; } = GetIntermediateOutputPath(serviceProvider);
+
+    private static string GetIntermediateOutputPath(IServiceProvider serviceProvider)


How does this directory get cleaned up?

We dont clean anything up. I think it should be relative to your app folder tbh but I just want to flow a property through so we can begin to use it.

eerhardt · 2025-10-31T15:27:29Z

src/Aspire.Hosting.Docker/DockerComposeEnvironmentResource.cs

    private Task PublishAsync(PipelineStepContext context)
    {
-        var outputPath = PublishingContextUtils.GetEnvironmentOutputPath(context, this);
+        // Inline logic from PublishingContextUtils.GetEnvironmentOutputPath


Why not continue using the shared Utils method?

yea I didn't rrealize what it did originally.

davidfowl · 2025-10-31T15:42:55Z

Making a new PR

Initial plan

adf5bc4

Copilot AI assigned Copilot and captainsafia Oct 27, 2025

Copilot started work on behalf of captainsafia October 27, 2025 20:28 View session

Copilot AI changed the title ~~[WIP] Fix default output path handling during aspire deploy~~ Fix default output path fallback for aspire deploy Oct 27, 2025

Copilot AI requested a review from captainsafia October 27, 2025 20:50

Copilot finished work on behalf of captainsafia October 27, 2025 20:50

captainsafia reviewed Oct 28, 2025

View reviewed changes

Copilot started work on behalf of captainsafia October 28, 2025 15:57 View session

Copilot AI requested a review from captainsafia October 28, 2025 16:11

Copilot finished work on behalf of captainsafia October 28, 2025 16:11

Copilot started work on behalf of davidfowl October 31, 2025 00:59 View session

Copilot AI changed the title ~~Fix default output path fallback for aspire deploy~~ Set default OutputPath and add IntermediateOutputPath at PipelineContext level Oct 31, 2025

Copilot AI requested a review from davidfowl October 31, 2025 01:11

Copilot finished work on behalf of davidfowl October 31, 2025 01:11

davidfowl reviewed Oct 31, 2025

View reviewed changes

src/Aspire.Hosting/Pipelines/PipelineContext.cs Show resolved Hide resolved

Copilot started work on behalf of davidfowl October 31, 2025 02:25 View session

Copilot AI requested a review from davidfowl October 31, 2025 02:37

Copilot finished work on behalf of davidfowl October 31, 2025 02:37

Copilot started work on behalf of davidfowl October 31, 2025 07:02 View session

Copilot finished work on behalf of davidfowl October 31, 2025 07:19

eerhardt reviewed Oct 31, 2025

View reviewed changes

Copilot AI mentioned this pull request Oct 31, 2025

Register IPipelineOutputService in DI for pipeline output directory management #12563

Merged

12 tasks

davidfowl closed this Oct 31, 2025

dotnet-policy-service bot added this to the 13.0 milestone Oct 31, 2025

github-actions bot locked and limited conversation to collaborators Dec 1, 2025

Set default OutputPath and add IntermediateOutputPath at PipelineContext level #12414

Set default OutputPath and add IntermediateOutputPath at PipelineContext level #12414

Uh oh!

Conversation

Copilot AI commented Oct 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary: Fix Default Output Path Issue During Aspire Deploy

Solution (Rebased on latest main)

Testing Results

Files Changed

Comments on the Issue (you are @copilot in this section)

Uh oh!

github-actions bot commented Oct 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Oct 27, 2025

Uh oh!

captainsafia left a comment

Choose a reason for hiding this comment

Uh oh!

captainsafia Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Oct 28, 2025

Uh oh!

davidfowl commented Oct 31, 2025

Uh oh!

Copilot AI commented Oct 31, 2025

Uh oh!

Uh oh!

davidfowl commented Oct 31, 2025

Uh oh!

Copilot AI commented Oct 31, 2025

Uh oh!

eerhardt Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

davidfowl Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

eerhardt Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

davidfowl Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

davidfowl commented Oct 31, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Copilot AI commented Oct 27, 2025 •

edited

Loading

github-actions bot commented Oct 27, 2025 •

edited

Loading