docs: clarify WORKDIR tilde path behavior#6937
Open
devendrakushwah80 wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
This PR clarifies Dockerfile WORKDIR behavior in BuildKit’s documentation by explicitly noting that WORKDIR does not do shell-style tilde expansion, preventing users from assuming ~/~username resolve to home directories.
Changes:
- Add a documentation note that
WORKDIRdoes not perform shell expansion. - Clarify that
~and~usernameare treated as literal directory names (not home directories).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
devendrakushwah80
force-pushed
the
docs/workdir-tilde-note
branch
from
3811dd8 to
0951e1c
Compare
This was referenced Jul 7, 2026
tonistiigi
approved these changes
Jul 7, 2026
Signed-off-by: Devendra Kushwah <[email protected]>
devendrakushwah80
force-pushed
the
docs/workdir-tilde-note
branch
from
0951e1c to
74d3c62
Compare
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
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.
Description
Adds a note clarifying that
WORKDIRdoes not perform shell expansion.Paths beginning with
~or~usernameare treated as literal directory names and are not resolved to a user's home directory.Related issues
References docker/docs#25512