document adding a new draft

Author: mr-c

doc/add-new-draft.md

@@ -0,0 +1,21 @@
+How to make a new draft version of the CWL spec
+
+1. Duplicate prior draft-n directory to draft-n+1 in a branch
+2. Update references to the new draft name.
+3. Pull in the latest metaschema
+     
+     git subtree add -P draft-4/salad schema_salad_repo/master
+
+4. In the reference implementation (cwltool): make a new branch, and update the
+   subtree checkout of the spec:
+   
+     git subtree merge -P cwltool/schemas/ cwl_repo/draft-4
+   
+   Where `cwl_repo` is the remote repository for the CWL specifications.
+4. In the reference implementation, teach it about the new draft version:
+
+  a. Edit `cwltool/update.py`: append a new entry to the updates dictionary and
+     change the previous last version to point to an update function
+  b. Edit `cwltool/process.py`: update `get_schema` to look in the new
+     directory
+  c. Edit `setup.py` to include the new schemas in the `package_data` stanza

draft-4/CommandLineTool.yml

@@ -36,22 +36,10 @@ $graph:
     - {$include: intro.md}
 
     - |
-      ## Introduction to draft 3
-
-      This specification represents the third milestone of the CWL group.  Since
-      draft-2, this draft introduces the following major changes and additions:
-
-        * Greatly simplified naming within a document with scoped identifiers, as
-          described in the [Schema Salad specification](SchemaSalad.html).
-        * The draft-2 concept of pluggable expression engines has been replaced
-          by a [streamlined expression syntax](#Parameter_references)
-          and standardization on [Javascript](#Expressions).
-        * [File](#File) objects can now include a `format` field to indicate
-          the file type.
-        * The addition of [ShellCommandRequirement](#ShellCommandRequirement).
-        * The addition of [ResourceRequirement](#ResourceRequirement).
-        * The separation of CommandLineTool and Workflow components into
-          separate specifications.
+      ## Introduction to draft 4
+
+      This specification represents the third milestone of the CWL group.
+      Since draft-3, this draft introduces the following major changes and additions:
 
       ## Purpose
 

draft-4/Process.yml

@@ -6,7 +6,7 @@ $namespaces:
 
 $graph:
 
-- name: "Common Workflow Language, Draft 3"
+- name: "Common Workflow Language, Draft 4"
   type: documentation
   doc: {$include: concepts.md}
 

draft-4/Workflow.yml

@@ -9,7 +9,7 @@ $graph:
   type: documentation
   doc:
     - |
-      # Common Workflow Language (CWL) Workflow Description, draft 3
+      # Common Workflow Language (CWL) Workflow Description, draft 4
 
       This version:
         * https://w3id.org/cwl/draft-4/
@@ -32,22 +32,10 @@ $graph:
 
     - |
 
-      ## Introduction to draft 3
+      ## Introduction to draft 4
 
-      This specification represents the third milestone of the CWL group.  Since
-      draft-2, this draft introduces the following changes and additions:
-
-        * Greatly simplified naming within a document with scoped identifiers, as
-          described in the [Schema Salad specification](SchemaSalad.html).
-        * The draft-2 concept of pluggable expression engines has been replaced
-          by a [streamlined expression syntax)[#Parameter_references]
-          and standardization on [Javascript](#Expressions).
-        * [File](#File) objects can now include a `format` field to indicate
-          the file type.
-        * The addition of [MultipleInputFeatureRequirement](#MultipleInputFeatureRequirement).
-        * The addition of [StepInputExpressionRequirement](#StepInputExpressionRequirement).
-        * The separation of Workflow and CommandLineTool components into
-          separate specifications.
+      This specification represents the third milestone of the CWL group. Since
+      draft-3, this draft introduces the following changes and additions:
 
       ## Purpose
 
@@ -470,4 +458,4 @@ $graph:
   extends: "#ProcessRequirement"
   doc: |
     Indicate that the workflow platform must support the `valueFrom` field
-    of [WorkflowStepInput](#WorkflowStepInput).
+    of [WorkflowStepInput](#WorkflowStepInput).