Skip to content

Commit 885b990

Browse files
authored
Improve storeDir docs (#5651) [ci skip]
Signed-off-by: Ben Sherman <bentshermann@gmail.com>
1 parent b5d43ad commit 885b990

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/reference/process.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1593,11 +1593,11 @@ process formatBlastDatabases {
15931593
```
15941594

15951595
:::{warning}
1596-
The `storeDir` directive is meant for long-term process caching and should not be used to publish output files or organize outputs into a semantic directory structure. In those cases, use the [publishDir](#publishdir) directive instead.
1596+
If a process uses `storeDir` and all of its outputs are optional, the process will always be skipped, even if the store directory is empty. This issue can be avoided by specifying at least one required file output.
15971597
:::
15981598

1599-
:::{note}
1600-
The use of AWS S3 paths is supported, however it requires the installation of the [AWS CLI](https://aws.amazon.com/cli/) (i.e. `aws`) in the target compute node.
1599+
:::{warning}
1600+
The `storeDir` directive should not be used to publish workflow outputs. Use the [publishDir](#publishdir) directive or the {ref}`workflow output definition <workflow-output-def>` instead.
16011601
:::
16021602

16031603
(process-tag)=

0 commit comments

Comments
 (0)