Clarify differences between AddDockerfile and WithDockerfile methods #4050
+28
−2
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.
The "Add Dockerfiles to your .NET app model" documentation previously mentioned both
AddDockerfile()
andWithDockerfile()
methods without explaining their differences, when to use each, or whether they create Dockerfile files.This PR adds clear explanations that address the confusion:
Key improvements:
Clear definitions in introduction: Added explanations that
AddDockerfile
creates new container resources whileWithDockerfile
customizes existing onesNew "When to use" section: Provides specific guidance on choosing the appropriate method:
AddDockerfile
for custom containerized servicesWithDockerfile
to customize existing .NET Aspire componentsClarifies Dockerfile expectations: Explicitly states that neither method creates Dockerfile files - both expect existing Dockerfiles in the specified context path
Enhanced examples: Improved the PostgreSQL example with comments explaining the customization behavior
Before:
After:
The changes are minimal (28 lines added, 2 modified) and maintain the existing document structure while directly addressing the user's confusion.
Fixes #1824.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.
Internal previews