Skip to content

Commit 76a24a0

Browse files
committed
Deprecate boilerplate feature requirements and update changelog
Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <[email protected]>
1 parent 0563d7b commit 76a24a0

File tree

2 files changed

+45
-23
lines changed

2 files changed

+45
-23
lines changed

CommandLineTool.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,20 @@ $graph:
5252
## Changelog for v1.3.0-dev1
5353
5454
See also the [CWL Workflow Description, v1.3.0-dev1 changelog](Workflow.html#Changelog).
55+
56+
* New field `networkAccess` on
57+
[CommandLineTool](#CommandLineTool). This supercedes the
58+
[NetworkAccess](#NetworkAccess) requirement, which is now
59+
deprecated.
60+
* New field `envDef` on [CommandLineTool](#CommandLineTool).
61+
This supercedes the [EnvVarRequirement](#EnvVarRequirement)
62+
requirement, which is now deprecated.
63+
* New field `initialWorkDir` on
64+
[CommandLineTool](#CommandLineTool). This supercedes the
65+
[InitialWorkDirRequirement](#InitialWorkDirRequirement)
66+
requirement, which is now deprecated.
67+
68+
5569
For other changes since CWL v1.0, see the
5670
[CWL Command Line Tool Description, v1.1 changelog](https://www.commonwl.org/v1.1/CommandLineTool.html#Changelog)
5771
and

Workflow.yml

Lines changed: 31 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,17 @@ $graph:
4141
4242
## Changelog
4343
See also the [CWL Command Line Tool Description, v1.3.0-dev1 changelog](CommandLineTool.html#Changelog).
44+
45+
* Workflow steps may now specify iterative execution. See
46+
[LoopWorkflowStep](#LoopWorkflowStep)
47+
* Including
48+
[StepInputExpressionRequirement](#StepInputExpressionRequirement),
49+
[MultipleInputFeatureRequirement](#MultipleInputFeatureRequirement),
50+
[ScatterFeatureRequirement](#ScatterFeatureRequirement) and
51+
[SubworkflowFeatureRequirement](#SubworkflowFeatureRequirement)
52+
in `requirements` is no longer necessary to use the associated
53+
feature. These core features are now always available.
54+
4455
For other changes since CWL v1.0, see the
4556
[CWL Workflow Description, v1.1 changelog](https://www.commonwl.org/v1.1/Workflow.html#Changelog)
4657
and
@@ -296,10 +307,6 @@ $graph:
296307
297308
# Merging multiple inbound data links
298309
299-
To merge multiple inbound data links,
300-
[MultipleInputFeatureRequirement](#MultipleInputFeatureRequirement) must be specified
301-
in the workflow or workflow step requirements.
302-
303310
If the sink parameter is an array, or named in a [workflow
304311
scatter](#ScatterWorkflowStep) operation, there may be multiple inbound
305312
data links listed in the `source` field. The values from the
@@ -404,9 +411,6 @@ $graph:
404411
- Expression
405412
jsonldPredicate: "cwl:valueFrom"
406413
doc: |
407-
To use valueFrom, [StepInputExpressionRequirement](#StepInputExpressionRequirement) must
408-
be specified in the workflow or workflow step requirements.
409-
410414
If `valueFrom` is a constant string value, use this as the value for
411415
this input parameter.
412416
@@ -464,9 +468,6 @@ $graph:
464468
- Expression
465469
jsonldPredicate: "cwl:valueFrom"
466470
doc: |
467-
To use valueFrom, [StepInputExpressionRequirement](#StepInputExpressionRequirement) must
468-
be specified in the workflow or workflow step requirements.
469-
470471
If `valueFrom` is a constant string value, use this as the value for
471472
this input parameter.
472473
@@ -532,10 +533,6 @@ $graph:
532533
533534
# Subworkflows
534535
535-
To specify a nested workflow as part of a workflow step,
536-
[SubworkflowFeatureRequirement](#SubworkflowFeatureRequirement) must be
537-
specified in the workflow or workflow step requirements.
538-
539536
It is a fatal error if a workflow directly or indirectly invokes itself as
540537
a subworkflow (recursive workflows are not allowed).
541538
@@ -617,10 +614,6 @@ $graph:
617614
extends: AbstractWorkflowStep
618615
docParent: "#Workflow"
619616
doc: |
620-
To use scatter/gather,
621-
[ScatterFeatureRequirement](#ScatterFeatureRequirement) must be specified
622-
in the workflow or workflow step requirements.
623-
624617
A "scatter" operation specifies that the associated workflow step or
625618
subworkflow should execute separately over a list of input elements. Each
626619
job making up a scatter operation is independent and may be executed
@@ -806,12 +799,11 @@ $graph:
806799
* If all workflow steps are executed and complete with `success`, then the
807800
workflow status is `success`.
808801
809-
# Extensions
802+
# Complex steps
810803
811-
[ScatterFeatureRequirement](#ScatterFeatureRequirement) and
812-
[SubworkflowFeatureRequirement](#SubworkflowFeatureRequirement) are
813-
available as standard [extensions](#Extensions_and_Metadata) to core
814-
workflow semantics.
804+
Individual workflow steps may specify complex behavior. Currently
805+
this consists scatter/gather, conditional execution, iterative
806+
execution (loops), or executing other workflows.
815807
816808
fields:
817809
- name: "class"
@@ -840,6 +832,10 @@ $graph:
840832
name: SubworkflowFeatureRequirement
841833
extends: ProcessRequirement
842834
doc: |
835+
**Deprecated as of v1.3** This feature is available by default,
836+
workflows that use it do not need to declare it. Including this
837+
requirement is a no-op.
838+
843839
Indicates that the workflow platform must support nested workflows in
844840
the `run` field of [AbstractWorkflowStep](#AbstractWorkflowStep).
845841
fields:
@@ -858,6 +854,10 @@ $graph:
858854
type: record
859855
extends: ProcessRequirement
860856
doc: |
857+
**Deprecated as of v1.3** This feature is available by default,
858+
workflows that use it do not need to declare it. Including this
859+
requirement is a no-op.
860+
861861
Indicates that the workflow platform must support the `scatter` and
862862
`scatterMethod` fields of [ScatterWorkflowStep](#ScatterWorkflowStep).
863863
fields:
@@ -876,6 +876,10 @@ $graph:
876876
type: record
877877
extends: ProcessRequirement
878878
doc: |
879+
**Deprecated as of v1.3** This feature is available by default,
880+
workflows that use it do not need to declare it. Including this
881+
requirement is a no-op.
882+
879883
Indicates that the workflow platform must support multiple inbound data links
880884
listed in the `source` field of [WorkflowStepInput](#WorkflowStepInput).
881885
fields:
@@ -894,6 +898,10 @@ $graph:
894898
name: StepInputExpressionRequirement
895899
extends: ProcessRequirement
896900
doc: |
901+
**Deprecated as of v1.3** This feature is available by default,
902+
workflows that use it do not need to declare it. Including this
903+
requirement is a no-op.
904+
897905
Indicate that the workflow platform must support the `valueFrom` field
898906
of [WorkflowStepInput](#WorkflowStepInput).
899907
fields:

0 commit comments

Comments
 (0)