Skip to content

Commit 4cd571c

Browse files
committed
Update CWL documentation to include container information...
... to demonstrate and so the linting now passes.
1 parent a4e6958 commit 4cd571c

File tree

3 files changed

+11
-8
lines changed

3 files changed

+11
-8
lines changed

docs/_writing_cwl_intro.rst

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,8 @@ tool is generated.
6262
--name 'Convert to FASTA (seqtk)' \
6363
--example_command 'seqtk seq -a 2.fastq > 2.fasta' \
6464
--example_input 2.fastq \
65-
--example_output 2.fasta
65+
--example_output 2.fasta \
66+
--container 'dukegcb/seqtk' \
6667
--help_from_command 'seqtk seq'
6768

6869
This command generates the following CWL YAML file.
@@ -82,16 +83,14 @@ This command generates the following CWL YAML file.
8283
.. CHECK: Tool defines an id [seqtk_seq_v3].
8384
Applying linter cwl_validation... CHECK
8485
.. INFO: CWL appears to be valid.
85-
Applying linter docker_image... WARNING
86-
.. WARNING: Tool does not specify a DockerPull source.
86+
Applying linter docker_image... CHECK
87+
.. INFO: Tool will run in Docker image [dukegcb/seqtk].
8788
Applying linter new_draft... CHECK
8889
.. INFO: Modern CWL version [cwl:draft-3]
89-
Failed linting
9090

91-
Here the linting failed because we have not yet defined a Docker image for the
92-
the tool. A later revision of this document will cover specifying a Docker image
93-
for this tool with the ``--container`` argument and discuss defining more
94-
parameters for this tool.
91+
A later revision of this document ill discuss defining more
92+
parameters for this tool and include information on generating and
93+
running tests with planemo for CWL tools.
9594

9695
For more information on the Common Workflow Language check out the Draft 3
9796
`User Guide`_ and Specification_.

docs/writing/gen.sh

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,5 +42,6 @@ planemo tool_init --force \
4242
--example_command 'seqtk seq -a 2.fastq > 2.fasta' \
4343
--example_input 2.fastq \
4444
--example_output 2.fasta \
45+
--container 'dukegcb/seqtk' \
4546
--help_from_command 'seqtk seq'
4647
mv seqtk_seq.cwl seqtk_seq_v3.cwl

docs/writing/seqtk_seq_v3.cwl

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ cwlVersion: 'cwl:draft-3'
33
class: CommandLineTool
44
id: "seqtk_seq"
55
label: "Convert to FASTA (seqtk)"
6+
requirements:
7+
- class: DockerRequirement
8+
dockerPull: dukegcb/seqtk
69
inputs:
710
- id: input1
811
type: File

0 commit comments

Comments
 (0)