Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[release/8.0] Rename WithContainerRunArgs to WithContainerRuntimeArgs to reduce potential confusion #3952

Merged
merged 13 commits into from
Apr 26, 2024

Conversation

danegsta
Copy link
Member

@danegsta danegsta commented Apr 25, 2024

Backport of #3950 to release/8.0

Customer Impact

Original API name for WithContainerRunArgs was causing user confusion. We received a request to rename in order to clarify that this is for providing arguments to the container host when running a container, not additional commands to run inside the container at startup. This is a breaking change, but this is an advanced API intended to be used only in specific scenarios.

Testing

Aspire unit tests

Risk

Low

Regression

No

Microsoft Reviewers: Open in CodeFlow

@dotnet-issue-labeler dotnet-issue-labeler bot added the area-app-model Issues pertaining to the APIs in Aspire.Hosting, e.g. DistributedApplication label Apr 25, 2024
@dotnet-policy-service dotnet-policy-service bot added the Servicing-consider Issue for next servicing release review label Apr 25, 2024
@danegsta danegsta changed the title [release/8.0] Rename WithContainerRunArgs to WithContainerHostRunArgs to reduce potential confusion [release/8.0] Rename WithContainerRunArgs to WithContainerRuntimeArgs to reduce potential confusion Apr 25, 2024
@danmoseley danmoseley added Servicing-approved Approved for servicing release and removed Servicing-consider Issue for next servicing release review labels Apr 25, 2024
Copy link
Member

@DamianEdwards DamianEdwards left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we make the small tweaks to the wording in the comments please?

@dotnet-policy-service dotnet-policy-service bot added the needs-author-action An issue or pull request that requires more info or actions from the author. label Apr 25, 2024
@danegsta
Copy link
Member Author

Doc comments have been updated

@dotnet-policy-service dotnet-policy-service bot removed the needs-author-action An issue or pull request that requires more info or actions from the author. label Apr 26, 2024
@davidfowl davidfowl merged commit 6b10cff into dotnet:release/8.0 Apr 26, 2024
8 checks passed
@eerhardt
Copy link
Member

Doc comments have been updated

Can these be ported to main?

@eerhardt eerhardt added the breaking-change Issue or PR that represents a breaking API or functional change over a prerelease. label Apr 26, 2024
@github-actions github-actions bot locked and limited conversation to collaborators May 27, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-app-model Issues pertaining to the APIs in Aspire.Hosting, e.g. DistributedApplication breaking-change Issue or PR that represents a breaking API or functional change over a prerelease. Servicing-approved Approved for servicing release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants