[Automated] Update API Surface Area #715
Merged
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
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
github-actions
bot
force-pushed
the
update-api-diffs
branch
2 times, most recently
from
9f6121b to
70a4875
Compare
github-actions
bot
force-pushed
the
update-api-diffs
branch
2 times, most recently
from
2bf7e2b to
f639789
Compare
github-actions
bot
force-pushed
the
update-api-diffs
branch
from
f639789 to
abe71a6
Compare
github-actions
bot
force-pushed
the
update-api-diffs
branch
3 times, most recently
from
5c1bf72 to
2005439
Compare
github-actions
bot
force-pushed
the
update-api-diffs
branch
from
2005439 to
c54e007
Compare
Alirexaa
reviewed
Jun 27, 2025
| @@ -10,7 +10,7 @@ namespace Aspire.Hosting | |||
| { | |||
| public static partial class GolangAppHostingExtension | |||
| { | |||
| public static ApplicationModel.IResourceBuilder<ApplicationModel.GolangAppExecutableResource> AddGolangApp(this IDistributedApplicationBuilder builder, string name, string workingDirectory, string[]? args = null) { throw null; } | |||
There was a problem hiding this comment.
This is a breaking change.
To avoid this, we can add a new overload:
public static ApplicationModel.IResourceBuilder<ApplicationModel.GolangAppExecutableResource> AddGolangApp(this IDistributedApplicationBuilder builder, string name, string workingDirectory, string[]? args = null, string[]? buildTags = null) { throw null; }And make the args parameter for the old API required.
public static ApplicationModel.IResourceBuilder<ApplicationModel.GolangAppExecutableResource> AddGolangApp(this IDistributedApplicationBuilder builder, string name, string workingDirectory,
string[] args) { throw null; }| { | ||
| public static partial class MinioBuilderExtensions | ||
| { | ||
| public static ApplicationModel.IResourceBuilder<ApplicationModel.MinioContainerResource> AddMinioContainer(this IDistributedApplicationBuilder builder, string name, ApplicationModel.IResourceBuilder<ApplicationModel.ParameterResource>? rootUser = null, ApplicationModel.IResourceBuilder<ApplicationModel.ParameterResource>? rootPassword = null, int? port = null) { throw null; } |
There was a problem hiding this comment.
This should be AddMinio, not AddMinioContainer, to be consistent with other resources like AddPostgres or AddOllama
|
|
||
| public EndpointReference PrimaryEndpoint { get { throw null; } } | ||
|
|
||
| public ParameterResource RootUser { get { throw null; } set { } } |
There was a problem hiding this comment.
I don't like the Root part for RootUser. Is there a reason for this?
Comment on lines
+19
to
+24
| public static ApplicationModel.IResourceBuilder<NodeAppResource> WithNpmPackageInstallation(this ApplicationModel.IResourceBuilder<NodeAppResource> resource, bool useCI = false, System.Action<ApplicationModel.IResourceBuilder<ApplicationModel.NpmInstallerResource>>? configureInstaller = null) { throw null; } | ||
|
|
||
| public static ApplicationModel.IResourceBuilder<NodeAppResource> WithPnpmPackageInstallation(this ApplicationModel.IResourceBuilder<NodeAppResource> resource, string[]? args = null) { throw null; } | ||
| public static ApplicationModel.IResourceBuilder<NodeAppResource> WithPnpmPackageInstallation(this ApplicationModel.IResourceBuilder<NodeAppResource> resource, System.Action<ApplicationModel.IResourceBuilder<ApplicationModel.PnpmInstallerResource>>? configureInstaller = null) { throw null; } | ||
|
|
||
| public static ApplicationModel.IResourceBuilder<NodeAppResource> WithYarnPackageInstallation(this ApplicationModel.IResourceBuilder<NodeAppResource> resource, string[]? args = null) { throw null; } | ||
| public static ApplicationModel.IResourceBuilder<NodeAppResource> WithYarnPackageInstallation(this ApplicationModel.IResourceBuilder<NodeAppResource> resource, System.Action<ApplicationModel.IResourceBuilder<ApplicationModel.YarnInstallerResource>>? configureInstaller = null) { throw null; } | ||
| } |
There was a problem hiding this comment.
This is a breaking change. We should add a new API instead of changing the surfaces. We can deprecate the old ones.
There was a problem hiding this comment.
Fundamentally, the whole install pipeline here is a breaking change as it's moving to using a resource that shows in the dashboard. Since the configureInstaller is a nullable additional argument, the likelihood of it impacting someone is pretty minimal, since they'd have to be invoking the method in a non-standard way.
Although the diff is showing a bit confusing as the args array wasn't present in 9.5 (https://github.com/CommunityToolkit/Aspire/blob/v9.5.0/src/CommunityToolkit.Aspire.Hosting.NodeJS.Extensions/api/CommunityToolkit.Aspire.Hosting.NodeJS.Extensions.cs#L19-L23), it was my first iteration on this change, which I merged, but then moved to using a callback for flexibility.
github-actions
bot
force-pushed
the
update-api-diffs
branch
2 times, most recently
from
b6e7960 to
e6c87e4
Compare
aaronpowell
temporarily deployed
to
azure-artifacts
GitHub Actions
Inactive
github-actions
bot
force-pushed
the
update-api-diffs
branch
from
ad77c37 to
f628d41
Compare
github-actions
bot
force-pushed
the
update-api-diffs
branch
from
f628d41 to
f630d6c
Compare
aaronpowell
approved these changes
Jul 10, 2025
aaronpowell
temporarily deployed
to
azure-artifacts
GitHub Actions
Inactive
Minimum allowed line rate is |
aaronpowell
temporarily deployed
to
azure-artifacts
GitHub Actions
Inactive
This was referenced Aug 5, 2025
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.
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.