Skip to content

Commit ff257a0

Browse files
Iacopo ColonnelliIacopo Colonnelli
authored andcommitted
Merged cwl-v1.3 into cwltool
1 parent b828a75 commit ff257a0

24 files changed

+4566
-581
lines changed

cwltool/schemas/v1.3.0-dev1/Base.yml

Lines changed: 498 additions & 0 deletions
Large diffs are not rendered by default.

cwltool/schemas/v1.3.0-dev1/CITATION

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
To cite the Common Workflow Language standards in a publication, please use:
2+
3+
Amstutz, Peter; Crusoe, Michael R; Tijanić, Nebojša; Chapman, Brad;
4+
Chilton, John; Heuer, Michael; Kartashov, Andrey; Kern, John; Leehr, Dan;
5+
Ménager, Hervé; Nedeljkovich, Maya; Scales, Matt; Soiland-Reyes, Stian;
6+
Stojanovic, Luka (2016): Common Workflow Language, v1.0. Standards,
7+
Common Workflow Language working group. https://w3id.org/cwl/v1.0/
8+
https://doi.org/10.6084/m9.figshare.3115156.v2
9+
10+
@data{cwl,
11+
doi = {10.6084/m9.figshare.3115156.v2},
12+
url = {https://doi.org/10.6084/m9.figshare.3115156.v2},
13+
author = {Peter Amstutz; Michael R. Crusoe; Nebojša Tijanić; Brad Chapman;
14+
John Chilton; Michael Heuer; Andrey Kartashov; John Kern; Dan Leehr;
15+
Hervé Ménager; Maya Nedeljkovich; Matt Scales; Stian Soiland-Reyes;
16+
Luka Stojanovic
17+
},
18+
publisher = {Figshare},
19+
institution = {Common Workflow Language working group},
20+
title = {Common Workflow Language, v1.0},
21+
year = {2016}
22+
}
23+
24+
# Are you editing this file?
25+
# Synchronize any changes made with
26+
# README.md
27+
# and
28+
# https://github.com/common-workflow-language/user_guide/blob/gh-pages/CITATION

cwltool/schemas/v1.3.0-dev1/CODE_OF_CONDUCT.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,6 @@ As a stop gap measure until a more formal governance structure is adopted, the
102102
following individuals make up the leadership of the CWL Project: Peter Amstutz,
103103
John Chilton, Michael R. Crusoe, and Nebojša Tijanić.
104104

105-
To report an issue with anyone on the team you can escalate to Ward Vandewege
106-
(Curoverse) ward@curoverse.com, Anton Nekrutenko (Galaxy)
105+
To report an issue with anyone on the team you can escalate to Anton Nekrutenko (Galaxy)
107106
anton AT bx DOT psu DOT edu, C. Titus Brown (UC Davis) ctbrown@ucdavis.edu, or
108107
Brandi Davis-Dusenbery (Seven Bridges Genomics) brandi@sbgenomics.com.

cwltool/schemas/v1.3.0-dev1/CONFORMANCE_TESTS.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ We will use this single entry to explain the format
144144
Must include one or more of the following tags: `command_line_tool`, `expression_tool` or `workflow`.
145145
If the test does not test any optional features, the tag `required` is required.
146146

147-
Because `conformance_tests.yaml` is a `schema-salad` processed document, [`$import`](https://www.commonwl.org/v1.2/SchemaSalad.html#Import)
147+
Because `conformance_tests.yaml` is a `schema-salad` processed document, [`$import`](https://www.commonwl.org/v1.3/SchemaSalad.html#Import)
148148
can be used to organize the tests into separate files.
149149

150150
Currently, the main file is too big (over 3400 lines); we are slowly re-organizing it.
@@ -166,7 +166,7 @@ At any level, if there is an extra field, then that will be considered an error.
166166
An exception to this is `class: File` and `class: Directory` objects, the `cwl-runner` under test can add additional fields here without causing a test to fail.
167167
Likewise, if you don't want to test some aspect of a `class: File` or `class: Directory` object (like `nameext`) you can just omit it.
168168

169-
[According to the CWL standards](https://www.commonwl.org/v1.2/CommandLineTool.html#File), the format of the `location` field in
169+
[According to the CWL standards](https://www.commonwl.org/v1.3/CommandLineTool.html#File), the format of the `location` field in
170170
`class: File` and `class: Directory` is implementation specific and we should not be testing them.
171171
Please remember to use `location: Any` for them.
172172

@@ -181,17 +181,19 @@ Likewise, please do not test the `path` for `class: File` and `class: Directory`
181181

182182
To add a new conformance test:
183183
1. Ensure the CWL document you have tests the desired feature or aspect.
184-
2. All `CommandLineTool`s need a software container (via `DockerRequirement`) for better reproducibility, preferably under `hints`.
184+
2. The `cwlVersion` should be the latest version (`cwlVersion: v1.2`), unless
185+
testing the mixing of versions as in the `tests/mixed-versions` directory.
186+
3. All `CommandLineTool`s need a software container (via `DockerRequirement`) for better reproducibility, preferably under `hints`.
185187
Please limit your container usage to the following:
186188
- `dockerPull: docker.io/alpine:latest`
187189
- `dockerPull: docker.io/bash:4.4`
188190
- `dockerPull: docker.io/debian:stable-slim`
189191
- `dockerPull: docker.io/python:3-slim`
190192
4. Run your test using the CWL reference runner (`cwltool`) or another CWL runner
191193
that shows the correct behavior to collect the output, or confirm that validation/execution fails as expected
192-
3. Add the CWL document and output object to the subdirectory `tests` in this repository.
193-
4. Fill out a new entry in [conformance_tests.yaml](conformance_tests.yaml) following the [format of the conformance test file](#format-of-the-conformance-test-file)
194-
5. Send a pull request to [current staging branch for the next revision of the CWL standards](https://github.com/common-workflow-language/cwl-v1.2/tree/1.2.1_proposed)
194+
5. Add the CWL document and output object to the subdirectory `tests` in this repository.
195+
6. Fill out a new entry in [conformance_tests.yaml](conformance_tests.yaml) following the [format of the conformance test file](#format-of-the-conformance-test-file)
196+
7. Send a pull request to [current staging branch for the next revision of the CWL standards](https://github.com/common-workflow-language/cwl-v1.2/tree/1.2.1_proposed)
195197
with your changes
196198

197199
## Tags for conformance tests

cwltool/schemas/v1.3.0-dev1/CommandLineTool.yml

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
saladVersion: v1.1
1+
saladVersion: v1.3
22
$base: "https://w3id.org/cwl/cwl#"
33

44
$namespaces:
@@ -42,14 +42,20 @@ $graph:
4242
This specification represents the latest development version from the
4343
CWL group.
4444
45-
## Changelog
45+
Documents should use `cwlVersion: v1.3.0-dev1` to make use of new
46+
syntax and features introduced in v1.3.0-dev1. Existing v1.2 documents
47+
should be trivially updatable by changing `cwlVersion`, however
48+
CWL documents that relied on previously undefined or
49+
underspecified behavior may have slightly different behavior in
50+
v1.3.0-dev1.
4651
52+
## Changelog for v1.3.0-dev1
4753
4854
See also the [CWL Workflow Description, v1.3.0-dev1 changelog](Workflow.html#Changelog).
4955
For other changes since CWL v1.0, see the
5056
[CWL Command Line Tool Description, v1.1 changelog](https://www.commonwl.org/v1.1/CommandLineTool.html#Changelog)
5157
and
52-
[CWL Command Line Tool Description, v1.2 changelog](https://www.commonwl.org/v1.2/CommandLineTool.html#Changelog).
58+
[CWL Command Line Tool Description, v1.2.1 changelog](https://www.commonwl.org/v1.2/CommandLineTool.html#Changelog).
5359
5460
## Purpose
5561
@@ -483,7 +489,7 @@ $graph:
483489
type: File
484490
streamable: true
485491
486-
stdin: ${inputs.an_input_name.path}
492+
stdin: $(inputs.an_input_name.path)
487493
```
488494
489495
- name: stdout
@@ -1081,7 +1087,7 @@ $graph:
10811087
Modify the behavior of CommandLineTool to generate a single string
10821088
containing a shell command line. Each item in the `arguments` list must
10831089
be joined into a string separated by single spaces and quoted to prevent
1084-
intepretation by the shell, unless `CommandLineBinding` for that argument
1090+
interpretation by the shell, unless `CommandLineBinding` for that argument
10851091
contains `shellQuote: false`. If `shellQuote: false` is specified, the
10861092
argument is joined into the command string without quoting, which allows
10871093
the use of shell metacharacters such as `|` for pipes.
@@ -1159,7 +1165,7 @@ $graph:
11591165
do not exceed the capacity of the node.
11601166
11611167
Processes sharing a core must have the same level of isolation
1162-
(typically a container or VM) that they would normally.
1168+
(typically a container or VM) that they would normally have.
11631169
11641170
The reported number of CPU cores reserved for the process,
11651171
which is available to expressions on the CommandLineTool as

cwltool/schemas/v1.3.0-dev1/CommonWorkflowLanguage.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
saladVersion: v1.1
1+
saladVersion: v1.3
22
$base: "https://w3id.org/cwl/cwl#"
33

44
$namespaces:

cwltool/schemas/v1.3.0-dev1/Operation.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
saladVersion: v1.1
1+
saladVersion: v1.3
22
$base: "https://w3id.org/cwl/cwl#"
33

44
$namespaces:

0 commit comments

Comments
 (0)