Add ContainerBuildOptions support to ResourceContainerImageBuilder for customizing dotnet publish #10074

Copilot · 2025-06-26T17:23:24Z

This PR adds support for passing additional arguments to dotnet publish commands when building container images through the ResourceContainerImageBuilder.

Problem

The ResourceContainerImageBuilder currently invokes dotnet publish with hardcoded arguments and doesn't support setting additional MSBuild properties that callers might need, such as:

/p:ContainerImageFormat
/p:ContainerArchiveOutputPath
/p:ContainerRuntimeIdentifier

Solution

Added a strongly-typed API through new types:

New API Surface

[Experimental("ASPIREPUBLISHERS001")]
public enum ContainerImageFormat
{
    Docker,      // default
    Oci,
}

[Experimental("ASPIREPUBLISHERS001")] 
public class ContainerBuildOptions
{
    public string? OutputPath { get; init; }           // → /p:ContainerArchiveOutputPath
    public ContainerImageFormat? ImageFormat { get; init; }  // → /p:ContainerImageFormat  
    public ContainerTargetPlatform? TargetPlatform { get; init; }       // → /p:ContainerRuntimeIdentifier
}

Updated IResourceContainerImageBuilder interface:

Task BuildImageAsync(IResource resource, ContainerBuildOptions? options = null, CancellationToken cancellationToken = default);
Task BuildImagesAsync(IEnumerable<IResource> resources, ContainerBuildOptions? options = null, CancellationToken cancellationToken = default);

Usage Example

var options = new ContainerBuildOptions
{
    ImageFormat = ContainerImageFormat.OciTar,
    OutputPath = "/tmp/output",
    TargetPlatform = "linux-x64"  
};

await imageBuilder.BuildImageAsync(resource, options, cancellationToken);

This generates the command:

dotnet publish [project] --configuration Release /t:PublishContainer /p:ContainerRepository=[name] /p:ContainerImageFormat=OciTar /p:ContainerArchiveOutputPath=/tmp/output /p:ContainerRuntimeIdentifier=linux-x64

Implementation Details

Backward Compatible: All existing code continues to work unchanged through default parameter values
Strongly Typed: Uses enums and proper types instead of raw string arguments
MSBuild Integration: Maps options directly to the correct MSBuild properties
Minimal Changes: Only adds new functionality without modifying existing behavior
Comprehensive Testing: Includes unit tests for new functionality

Testing

Updated all existing tests to use the new signature
Added new tests validating ContainerBuildOptions functionality
Updated mock implementations in test projects
Verified all builds complete successfully
Created validation test program demonstrating the new API

Fixes #10000.

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

captainsafia

Update the implementation to respect the ImageFormat and TargetPlatform in the DockerContainerRuntime and PodmanContainerRuntime.

captainsafia · 2025-06-26T19:45:27Z

src/Aspire.Hosting/Publishing/ResourceContainerImageBuilder.cs

+    }
+
+    // Backward compatibility methods
+    public Task BuildImagesAsync(IEnumerable<IResource> resources, CancellationToken cancellationToken)


Remove the backwards compatibility methods. This is an experimental type and backwards compatible is not a consideration.

Removed the backward compatibility methods from ResourceContainerImageBuilder as requested. Since this is an experimental API, backward compatibility is not a consideration. Commit: 94d03a4

Copilot · 2025-06-26T22:10:33Z

Update the implementation to respect the ImageFormat and TargetPlatform in the DockerContainerRuntime and PodmanContainerRuntime.

Updated the implementation to respect ImageFormat and TargetPlatform in both DockerContainerRuntime and PodmanContainerRuntime. The container runtimes now accept ContainerBuildOptions and apply the appropriate command-line arguments for platform, format, and output path support. Commit: 94d03a4

captainsafia

@copilot Address the feedback. Make sure that any arguments passed to the commands from the ContainerBuildOptions are quoted correctly.

src/Aspire.Hosting/Publishing/DockerContainerRuntime.cs

src/Aspire.Hosting/Publishing/ResourceContainerImageBuilder.cs

Copilot · 2025-07-03T20:59:02Z

@copilot Address the feedback. Make sure that any arguments passed to the commands from the ContainerBuildOptions are quoted correctly.

Fixed argument quoting for all ContainerBuildOptions commands in DockerContainerRuntime, PodmanContainerRuntime, and ResourceContainerImageBuilder. All file paths, image names, platform values, and MSBuild properties are now properly quoted. Commit: 471e770

captainsafia

@copilot More changes are required here.

src/Aspire.Hosting/Publishing/DockerContainerRuntime.cs

src/Aspire.Hosting/Publishing/PodmanContainerRuntime.cs

src/Aspire.Hosting/Publishing/ResourceContainerImageBuilder.cs

src/Aspire.Hosting/Publishing/DockerContainerRuntime.cs

src/Aspire.Hosting/Publishing/ResourceContainerImageBuilder.cs

src/Aspire.Hosting/Publishing/DockerContainerRuntime.cs

Copilot · 2025-07-08T00:44:42Z

@copilot More changes are required here.

Addressed all feedback comments including enum changes, runtime updates, validation improvements, and proper file naming. All requested changes have been implemented. Commit: 1a17636

Co-authored-by: captainsafia <[email protected]>

… backward compatibility methods Co-authored-by: captainsafia <[email protected]>

Co-authored-by: captainsafia <[email protected]>

…pings, enhance Docker/Podman runtime support Co-authored-by: captainsafia <[email protected]>

src/Aspire.Hosting/Publishing/ResourceContainerImageBuilder.cs

Co-authored-by: eerhardt <[email protected]>

Copilot · 2025-07-08T15:48:17Z

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses

I tried to connect to the following addresses, but was blocked by firewall rules:

centralus.data.mcr.microsoft.com
- Triggering command: dotnet publish /home/REDACTED/work/aspire/aspire/tests/testproject/TestProject.ServiceA/TestProject.ServiceA.csproj --configuration Release /t:PublishContainer /p:ContainerRepository=servicea (dns block)
- Triggering command: dotnet publish /home/REDACTED/work/aspire/aspire/tests/testproject/TestProject.ServiceA/TestProject.ServiceA.csproj --configuration Release /t:PublishContainer /p:ContainerRepository=servicea /p:ContainerArchiveOutputPath=/tmp/test-output /p:ContainerImageFormat=OCI /p:ContainerRuntimeIdentifier=linux-x64 (dns block)
- Triggering command: dotnet publish /home/REDACTED/work/aspire/aspire/tests/testproject/TestProject.ServiceA/TestProject.ServiceA.csproj --configuration Release /t:PublishContainer /p:ContainerRepository=servicea /p:ContainerRuntimeIdentifier=linux-x64 (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to my firewall allow list

eerhardt · 2025-07-08T15:49:16Z

src/Aspire.Hosting/Publishing/DockerContainerRuntime.cs

        var spec = new ProcessSpec("docker")
        {
-            Arguments = "info",
+            Arguments = "buildx version",


Why did this change from info to buildx version?

We're taking a dependency on buildx now to support all the output types and buildx is an add-on that's included by default in certain implementations. docker info isn't a sufficient enough check.

…set properties, and eliminate code duplication Co-authored-by: eerhardt <[email protected]>

eerhardt · 2025-07-08T16:05:24Z

src/Aspire.Hosting/Publishing/DockerContainerRuntime.cs

+
+                if (!string.IsNullOrEmpty(options?.OutputPath))
+                {
+                    outputType += $",dest=\"{options.OutputPath}/{imageName}.tar\"";


How does quotes inside of quotes work here?

--output "type=oci,dest="C:\temp\foo.tar""

Quoted values have been working fine for me in Bash/zshell. Some further digging reveals that Powershell doesn't handle this as nicely so the best thing to do is no quotes, although that assumes an output path with no spaces. :/

Why can't this be inverted? Quote the path, but don't quote around the value to --output?

You mean like --output type=oci,dest="C:\temp\foo.tar"? I think that's probably worse because there is no indication to the shell that the value is on cohesive string other than the whitespace separation. We're also pretty consistently quoting outer arguments in our CLI calls.

You mean like --output type=oci,dest="C:\temp\foo.tar"?

Yes

I think that's probably worse because there is no indication to the shell that the value is on cohesive string other than the whitespace separation.

What else could have whitespace?

eerhardt · 2025-07-09T18:58:41Z

src/Aspire.Hosting/Publishing/PodmanContainerRuntime.cs

+        {
+            // Extract resource name from imageName for the file name
+            var resourceName = imageName.Split('/').Last().Split(':').First();
+            arguments += $" --output \"{options.OutputPath}/{resourceName}.tar\"";


Path.Combine

eerhardt · 2025-07-09T18:59:33Z

src/Aspire.Hosting/Publishing/DockerContainerRuntime.cs

+
+                if (!string.IsNullOrEmpty(options?.OutputPath))
+                {
+                    outputType += $",dest={Path.Combine(options.OutputPath, imageName)}.tar";


There is a difference in behavior between the .NET Project publish and this. The .NET Project publish appears to write .tar.gz file extensions, where this does .tar.

How is a caller supposed to know the name of the files that were outputted have different name formats? Should they assume projects product .tar.gz and docker files produce .tar?

I'm not sure if .NET publish actually gzips the tarball after it creates it but docker build/podman build don't provide this as an option. We could change the filenames but that feels misleading given they don't actually produce gzipped assets. Maybe we just document?

eerhardt · 2025-07-10T15:10:25Z

/backport to release/9.4

github-actions · 2025-07-10T15:10:34Z

Started backporting to release/9.4: https://github.com/dotnet/aspire/actions/runs/16198906310

Copilot AI assigned Copilot and captainsafia Jun 26, 2025

Copilot started work on behalf of captainsafia June 26, 2025 17:23 View session

Copilot AI changed the title ~~[WIP] ResourceContainerImageBuilder should support setting additional arguments for dotnet publish built images~~ Add ContainerBuildOptions support to ResourceContainerImageBuilder for customizing dotnet publish Jun 26, 2025

Copilot AI requested a review from captainsafia June 26, 2025 17:45

Copilot finished work on behalf of captainsafia June 26, 2025 17:45

captainsafia reviewed Jun 26, 2025

View reviewed changes

Copilot started work on behalf of captainsafia June 26, 2025 21:54 View session

Copilot AI requested a review from captainsafia June 26, 2025 22:11

Copilot finished work on behalf of captainsafia June 26, 2025 22:11

captainsafia force-pushed the copilot/fix-10000-2 branch from 94d03a4 to 6c585a3 Compare July 3, 2025 20:19

captainsafia reviewed Jul 3, 2025

View reviewed changes

src/Aspire.Hosting/Publishing/DockerContainerRuntime.cs Outdated Show resolved Hide resolved

src/Aspire.Hosting/Publishing/ResourceContainerImageBuilder.cs Show resolved Hide resolved

Copilot started work on behalf of captainsafia July 3, 2025 20:47 View session

Copilot AI requested a review from captainsafia July 3, 2025 20:59

Copilot finished work on behalf of captainsafia July 3, 2025 20:59

captainsafia reviewed Jul 8, 2025

View reviewed changes

Copilot started work on behalf of captainsafia July 8, 2025 00:27 View session

Copilot AI requested a review from captainsafia July 8, 2025 00:45

Copilot finished work on behalf of captainsafia July 8, 2025 00:45

Copilot AI and others added 8 commits July 7, 2025 22:05

Initial plan

e59eb66

Implement ContainerBuildOptions for ResourceContainerImageBuilder

a455b56

Co-authored-by: captainsafia <[email protected]>

Update container runtimes to support ContainerBuildOptions and remove…

7d99db0

… backward compatibility methods Co-authored-by: captainsafia <[email protected]>

Fix argument quoting, use docker buildx, and restore missing else case

0844e4d

Co-authored-by: captainsafia <[email protected]>

Use enum for TargetPlatform

9864489

Update compat suppressions file

fcbd217

Address all feedback comments: Remove DockerTar enum, fix MSBuild map…

9125a8f

…pings, enhance Docker/Podman runtime support Co-authored-by: captainsafia <[email protected]>

Clean up logs and format

e00837e

Copilot AI requested a review from eerhardt July 8, 2025 15:36

Copilot finished work on behalf of eerhardt July 8, 2025 15:36

Copilot started work on behalf of eerhardt July 8, 2025 15:37 View session

eerhardt reviewed Jul 8, 2025

View reviewed changes

src/Aspire.Hosting/Publishing/ResourceContainerImageBuilder.cs Outdated Show resolved Hide resolved

eerhardt reviewed Jul 8, 2025

View reviewed changes

src/Aspire.Hosting/Publishing/ResourceContainerImageBuilder.cs Show resolved Hide resolved

eerhardt reviewed Jul 8, 2025

View reviewed changes

src/Aspire.Hosting/Publishing/ResourceContainerImageBuilder.cs Outdated Show resolved Hide resolved

Add WindowsArm64 platform support to ContainerTargetPlatform enum

115e593

Co-authored-by: eerhardt <[email protected]>

Copilot AI requested a review from eerhardt July 8, 2025 15:48

Copilot finished work on behalf of eerhardt July 8, 2025 15:48

Copilot started work on behalf of eerhardt July 8, 2025 15:48 View session

eerhardt reviewed Jul 8, 2025

View reviewed changes

captainsafia unassigned Copilot Jul 8, 2025

Address code review feedback: make extension class internal, use get/…

f0c0fee

…set properties, and eliminate code duplication Co-authored-by: eerhardt <[email protected]>

Copilot AI requested a review from eerhardt July 8, 2025 16:02

Copilot finished work on behalf of eerhardt July 8, 2025 16:02

eerhardt reviewed Jul 8, 2025

View reviewed changes

captainsafia added 3 commits July 9, 2025 00:25

Feedback and test update

cd81d67

Fix output path formatting

ad2c9f3

Use default format for Docker compose

7f3ca1e

eerhardt reviewed Jul 9, 2025

View reviewed changes

eerhardt approved these changes Jul 9, 2025

View reviewed changes

Fix output path names

6fff8f4

captainsafia merged commit f2bedf4 into main Jul 10, 2025
496 of 498 checks passed

captainsafia deleted the copilot/fix-10000-2 branch July 10, 2025 02:14

github-actions bot mentioned this pull request Jul 10, 2025

[release/9.4] Add ContainerBuildOptions support to ResourceContainerImageBuilder for customizing dotnet publish #10312

Merged

github-actions bot locked and limited conversation to collaborators Aug 10, 2025

Uh oh!

Add ContainerBuildOptions support to ResourceContainerImageBuilder for customizing dotnet publish #10074

Add ContainerBuildOptions support to ResourceContainerImageBuilder for customizing dotnet publish #10074

Uh oh!

Conversation

Copilot AI commented Jun 26, 2025 • edited by captainsafia Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Problem

Solution

New API Surface

Usage Example

Implementation Details

Testing

Uh oh!

captainsafia left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jun 26, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Jun 26, 2025

Uh oh!

captainsafia left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI commented Jul 3, 2025

Uh oh!

captainsafia left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI commented Jul 8, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI commented Jul 8, 2025

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

captainsafia Jul 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

eerhardt commented Jul 10, 2025

Uh oh!

github-actions bot commented Jul 10, 2025

Uh oh!

Reviewers

Assignees

Labels

Copilot AI commented Jun 26, 2025 •

edited by captainsafia

Loading

captainsafia Jul 9, 2025 •

edited

Loading