docs: Add note on constraints for defaultPath#8658
Merged
vikram-dagger merged 3 commits intoNov 5, 2024
Merged
Conversation
marcosnils
reviewed
Oct 9, 2024
helderco
reviewed
Oct 14, 2024
| - resolution always starts from the directory containing a `dagger.json` file. | ||
|
|
||
| :::important | ||
| For security reasons, it is not possible to retrieve files or directories outside the default context's root directory. |
Contributor
There was a problem hiding this comment.
This is conflating a few terms. To clarify:
- default path: a path within the context directory, to load a directory/file as a default value
- context directory: repo root if in a git repo, or the root directory otherwise
- root directory: the directory where
dagger.jsonis - source directory: the sub-directory within the root directory, used by the SDK (
sourcefield indagger.json)
So there's no "default context". This is more correct:
Suggested change
| For security reasons, it is not possible to retrieve files or directories outside the default context's root directory. | |
| For security reasons, it is not possible to retrieve files or directories outside the context directory. |
But the terminology may be a leaking implementation detail if there's a simpler way to explain this (without conflicting with current terminology).
Contributor
Author
There was a problem hiding this comment.
I've modified this entire section using the terms "context directory" and "default path". I've not mentioned "source directory" as it did not seem relevant to this section, but let me know in case I got that wrong. I've also updated the example table. Let me know if this version is clearer.
vikram-dagger
force-pushed
the
docs-351-default-context-constraints
branch
from
5a3f174 to
e2bb6ae
Compare
TomChv
approved these changes
Oct 24, 2024
Member
TomChv
left a comment
TomChv
left a comment
There was a problem hiding this comment.
Left only 1 comment, otherwise it's much more clear! Thanks for these changes
| | `.` | `dagger call -m my-module read-dir --source=public` | `./public` | | ||
| | `..` | `dagger call -m my-module read-dir --source=public` | `./public` | | ||
|
|
||
| :::tip |
vikram-dagger
force-pushed
the
docs-351-default-context-constraints
branch
from
e2bb6ae to
d81b9d8
Compare
helderco
reviewed
Oct 24, 2024
TomChv
reviewed
Oct 25, 2024
Member
TomChv
left a comment
TomChv
left a comment
There was a problem hiding this comment.
Answered the question, please fix the table ;)
added 2 commits
November 5, 2024 14:52
Signed-off-by: Vikram Vaswani <vikram@dagger.io>
vikram-dagger
force-pushed
the
docs-351-default-context-constraints
branch
from
d81b9d8 to
43d7359
Compare
Signed-off-by: Vikram Vaswani <vikram@dagger.io>
TomChv
approved these changes
Nov 5, 2024
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
4 participants
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.
No description provided.