Added 'dir' attribute for steps on workflow #847 #853
Conversation
There was a problem hiding this comment.
thanks a lot for working on this @RicardoHE97!
sorry, I think I didn't explain well the purpose of this new dir attribute. The goal is basically to only change the working_dir option for container. So workspace_dir should still be mounted to /workspace.
Everything else looks great!
docs/sections/cn_workflows.md
Outdated
| @@ -188,6 +190,21 @@ cd /path/to | |||
| popper run -f wf.yml | |||
| ``` | |||
|
|
|||
| To specify a workspace directory for a step you can adding `dir` in the | |||
There was a problem hiding this comment.
since this is distinct to the workspace, maybe we can have this as a subsection titled Changing the working directory, and explain that this is only changing the working directory where the specified command is being executed from.
And we can also add a note that reminds the reader that if the directory is outside the workspace, then anything that gets written to it won't be persisted.
There was a problem hiding this comment.
Got it! I'll change it.
|
oh, also, can you please rebase master? there were some changes that were added recently that are conflicting with the changes in this PR |
docs/sections/cn_workflows.md
Outdated
| ### Changing the working directory | ||
|
|
||
| To specify a working directory for a step you can use the `dir` attribute | ||
| in the workflow. This will only going to change where the specified |
There was a problem hiding this comment.
"this changes where..." or "this is going to change where..."
docs/sections/cn_workflows.md
Outdated
| in the workflow. This will only going to change where the specified | ||
| command is executed. | ||
|
|
||
| For example, adding `dir` to a workflow would looks like the following: |
There was a problem hiding this comment.
this can be ".. to a workflow would look like the following:" or "to a workflow results in the following:"
docs/sections/cn_workflows.md
Outdated
| dir: /path/to/dir/ | ||
| ``` | ||
|
|
||
| It is worth mentioning that if the directory specified is outside the workspace, |
There was a problem hiding this comment.
we can make it more explicit: "is specified outside the /workspace folder, then..."
docs/sections/cn_workflows.md
Outdated
| ``` | ||
|
|
||
| It is worth mentioning that if the directory specified is outside the workspace, | ||
| then anything that gets written to it won't persist. |
There was a problem hiding this comment.
"won't persist (see below for more)."
There was a problem hiding this comment.
This would have a link to section "Filesystem namespaces and persistence" or is this not necessary?
There was a problem hiding this comment.
since this is referring to the next section (so it's literally below), it's OK to not put a link.
There was a problem hiding this comment.
Got it! Thanks for the clarification.
|
thanks a lot @RicardoHE97 , really appreciated 🙏 |
closes #847