Skip to content

Commit d950619

Browse files
committed
Add warning about version development breakages
1 parent 5ff5ec7 commit d950619

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,16 @@
44

55
[Workflow Description Language](http://www.openwdl.org) is way to describe tasks and workflows in a "_human readable and writable way_". It was initially developed and offered by [Broad Institute](https://software.broadinstitute.org/) to be paired with their workflow engine [Cromwell](https://cromwell.readthedocs.io/en/stable/), however it has since been made open source with other engines such as [Toil](http://toil.readthedocs.io/en/3.14.0/running/wdl.html) and [DNAnexus\*](https://github.com/dnanexus/dxWDL).
66

7-
It's based almost exclusively off the version [1.0 Workflow Description Language specification](https://github.com/openwdl/wdl/blob/master/versions/1.0/SPEC.md#task-inputs).
7+
8+
### WARNING
9+
10+
This module now only generates developmental WDL, this includes Directories and wrapping all inputs in an input block.
11+
To use this generated WDL, you must use a version of Cromwell higher than 37.
12+
13+
This module automatically includes `version development` in the Workflow and Task outputs.
14+
The guides below may not reflect the current version of this repository, but will be updated soon.
15+
16+
This syntax is based on the [Developmental Workflow Description Language specification](https://github.com/openwdl/wdl/blob/master/versions/development/SPEC.md).
817

918
## Motiviation
1019

0 commit comments

Comments
 (0)