[Automated] Update API Surface Area by github-actions[bot] · Pull Request #9359 · microsoft/aspire

github-actions · 2025-05-16T16:18:35Z

Auto-generated update to the API surface to compare current surface vs latest release. This should only be merged once this surface area ships in a new release.

davidfowl · 2025-05-17T19:05:16Z

@joperezr @eerhardt Some of these changes should be in 9.3, do we know what's happening?

eerhardt · 2025-05-19T14:06:22Z

Some of these changes should be in 9.3, do we know what's happening?

Yes, main and release/9.3 are out of sync. We need to merge release/9.3 into main.

joperezr · 2025-05-20T21:15:04Z

Some of these changes should be in 9.3, do we know what's happening?

Yes, main and release/9.3 are out of sync. We need to merge release/9.3 into main.

That was done yesterday, so I'd expect things to look correct now.

mitchdenny · 2025-07-18T01:55:07Z

+        public static bool IsEmulator(this ApplicationModel.IResource resource) { throw null; }
+    }
+
+    public static partial class EventingExtensions


Should we call this DistributedApplicationEventingExtensions for consistency? /cc @davidfowl

mitchdenny · 2025-07-18T01:58:00Z

+    {
+        public static ApplicationModel.IResourceBuilder<ExternalServiceResource> AddExternalService(this IDistributedApplicationBuilder builder, string name, ApplicationModel.IResourceBuilder<ApplicationModel.ParameterResource> urlParameter) { throw null; }
+
+        public static ApplicationModel.IResourceBuilder<ExternalServiceResource> AddExternalService(this IDistributedApplicationBuilder builder, string name, string url) { throw null; }


nit: should this be string uri. I know that we have Uri uri, but there is no reason that the string has to be a URL :)

Unless it is very specifically HTTP/HTTPS only in which case should the API be called AddExternalHttpService(...)? /cc @DamianEdwards

It does, we validate it.

IEvangelist · 2025-07-24T18:25:35Z


    [System.Diagnostics.CodeAnalysis.Experimental("ASPIREPUBLISHERS001", UrlFormat = "https://aka.ms/aspire/diagnostics/{0}")]
-    public partial interface IPublishingActivityProgressReporter
+    public partial interface IPublishingActivityReporter


I think a better name would be IPipelineActivityReporter, as this isn't specific to "publishing" and it's already used in a "deploying" context as well. Ideally, pipeline could be used here as its agnostic to both publishing and deploying.

I think just IActivityReporter.

That seems too generic.

Pipeline doesn't mean anything yet. IOperationActivityReporter 😄

Pipeline doesn't mean anything yet.

Sure it does! It's the line we draw between a user on the CLI calling publish or deploy and the output on their screen. 😝 That's where this is used.

IOperationActivityReporter

Too generic.

Pipeline doesn’t mean much

I think Operation makes sense - because we have publish and run operations - and we'll probably want to add prompting support for run as well.

I suppose that if we make it clear that Operation represents Steps and child Tasks—which are distinct to non-run ops.

IEvangelist · 2025-07-24T18:26:21Z

-    public partial interface IPublishingActivityProgressReporter
+    public partial interface IPublishingActivityReporter
+    {
+        System.Threading.Tasks.Task CompletePublishAsync(string? completionMessage = null, CompletionState? completionState = null, bool isDeploy = false, System.Threading.CancellationToken cancellationToken = default);


Instead, consider CompletePipelineAsync as this API is used in deploying as well.

Should just be CompleteAsync

Don't feel like it;s for 9.4, this API is experimental

I think renaming it to CompleteAsync makes the isDeploy parameter even more awkward.

Can the IPublishingActivityReporter know ambiently if it is a deploy operation or not?

IMO, CompleteAsync is too vague considering there are 3 distinct concepts that can be completed here (the publish/deploy itself, steps, and tasks).

Can the IPublishingActivityReporter know ambiently if it is a deploy operation or not?

Nope, we'd have to modify this API to take PublishingOptions as input if we wanted to determine this without having an isDeploy argument.

There should be no isDeploy parameter. It should jsut take a message.

IEvangelist · 2025-07-24T18:27:04Z

+    }
+
+    [System.Diagnostics.CodeAnalysis.Experimental("ASPIREPUBLISHERS001", UrlFormat = "https://aka.ms/aspire/diagnostics/{0}")]
+    public partial interface IPublishingStep : System.IAsyncDisposable


Consider renaming this to IPipelineStep, as it's used in both publish and deploy.

IEvangelist · 2025-07-24T18:27:18Z

+    }
+
+    [System.Diagnostics.CodeAnalysis.Experimental("ASPIREPUBLISHERS001", UrlFormat = "https://aka.ms/aspire/diagnostics/{0}")]
+    public partial interface IPublishingTask : System.IAsyncDisposable


Consider renaming this to IPipelineTask, as it's used in both publish and deploy.

davidfowl · 2025-07-30T16:32:35Z

@joperezr can we merge this

joperezr · 2025-07-30T19:47:18Z

On it, just need to rerun real quick

joperezr · 2025-07-30T21:20:37Z

Merged with end state as of release 9.4.0. Thanks everyone!

github-actions Bot added the NO-MERGE The PR is not ready for merge yet (see discussion for detailed reasons) label May 16, 2025

github-actions Bot requested review from eerhardt, radical and sebastienros as code owners May 16, 2025 16:18

github-actions Bot added the NO-MERGE The PR is not ready for merge yet (see discussion for detailed reasons) label May 16, 2025

dotnet-policy-service Bot added the Closed Github-Action PR label May 16, 2025

dotnet-policy-service Bot closed this May 16, 2025

dotnet-policy-service Bot added Re-opened Github-Action PR and removed Closed Github-Action PR labels May 16, 2025

dotnet-policy-service Bot reopened this May 16, 2025

github-actions Bot force-pushed the update-api-diffs branch from 36e4703 to ab59e2a Compare May 17, 2025 16:17

github-actions Bot force-pushed the update-api-diffs branch from ab59e2a to 64b1917 Compare May 18, 2025 16:17

github-actions Bot force-pushed the update-api-diffs branch 2 times, most recently from a009283 to 112736d Compare May 20, 2025 16:18

davidfowl reviewed May 20, 2025

View reviewed changes

Comment thread src/Aspire.Hosting/api/Aspire.Hosting.cs Outdated

davidfowl reviewed May 21, 2025

View reviewed changes

Comment thread src/Aspire.Hosting.Milvus/api/Aspire.Hosting.Milvus.cs

github-actions Bot force-pushed the update-api-diffs branch 7 times, most recently from b50c898 to e4b32b6 Compare May 28, 2025 16:18

davidfowl reviewed May 29, 2025

View reviewed changes

Comment thread src/Aspire.Hosting.Azure.AppConfiguration/api/Aspire.Hosting.Azure.AppConfiguration.cs

github-actions Bot force-pushed the update-api-diffs branch 3 times, most recently from 6429680 to 8d86d5b Compare May 31, 2025 16:17

github-actions Bot force-pushed the update-api-diffs branch 2 times, most recently from 1e8fa0b to f2c4a2c Compare July 2, 2025 16:19

eerhardt mentioned this pull request Jul 3, 2025

Refactor Azure Storage API #10241

Merged

16 tasks

github-actions Bot force-pushed the update-api-diffs branch 7 times, most recently from 49666f5 to c97ed34 Compare July 10, 2025 16:19

github-actions Bot force-pushed the update-api-diffs branch 7 times, most recently from e7648e6 to 9c42e4e Compare July 16, 2025 23:56

mitchdenny reviewed Jul 18, 2025

View reviewed changes

Comment thread src/Aspire.Hosting/api/Aspire.Hosting.cs

mitchdenny reviewed Jul 18, 2025

View reviewed changes

Comment thread src/Aspire.Hosting/api/Aspire.Hosting.cs

IEvangelist reviewed Jul 24, 2025

View reviewed changes

[Automated] Update API Surface Area

fd2c343

joperezr approved these changes Jul 30, 2025

View reviewed changes

Conversation

github-actions Bot commented May 16, 2025

Uh oh!

davidfowl commented May 17, 2025

Uh oh!

eerhardt commented May 19, 2025

Uh oh!

Uh oh!

joperezr commented May 20, 2025

Uh oh!

Uh oh!

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!

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!

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!

IEvangelist Jul 27, 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!

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!

davidfowl commented Jul 30, 2025

Uh oh!

joperezr commented Jul 30, 2025

Uh oh!

joperezr commented Jul 30, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

IEvangelist Jul 27, 2025 •

edited

Loading