-
Notifications
You must be signed in to change notification settings - Fork 237
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add supported workflow language versions to README #4923
Conversation
This will fix #4896.
programming. It supports running workflows written in either Common Workflow Language (`CWL`_) or | ||
Workflow Description Language (`WDL`_), as well as having its own rich Python API for writing workflows against. | ||
programming. It supports running workflows written in either Common Workflow Language (`CWL`_) 1.0-1.2 or | ||
Workflow Description Language (`WDL`_) 1.0-1.1, as well as having its own rich Python API for writing workflows against. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
WDL or OpenWDL? They are different things..
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My understanding is that "OpenWDL" is an organization, and that "WDL" is a language, with "WDL 1.0" and "WDL 1.1" being language specifications published by OpenWDL.
Is there another "WDL 1.0" that isn't the same as the one OpenWDL wrote a spec for?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My understanding is that WDL draft 2, WDL 1.0, and "WDL development" is what Cromwell implements. OpenWDL 1.0 is different from (Cromwell) WDL 1.0. Cromwell doesn't support OpenWDL 1.1.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
On Cromwell's page about language support they link to OpenWDL's spec for Draft 2. Or at least where it would be if it was still where they link to.
So I don't think Cromwell's WDL version number series is genuinely intended to be a different language or set of language versions.
Now, "WDL 1.0 as implemented by Cromwell" is not 100% identical to "WDL 1.0 as specified by OpenWDL". But I don't think that that means Cromwell thinks they have implemented the "real" WDL 1.0, it just means the spec and one of the popular implementations don't 100% match. And I haven't seen anyone on the OpenWDL side calling the language OpenWDL.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that having the versions in there vs. not having them is an improvement. If the terminology of WDL vs. OpenWDL is ambiguous, we can always change it in the future, but I think that this makes sense to me now.
This will fix #4896. Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
This will fix #4896. Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
This will fix #4896. Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
This will fix #4896.
Changelog Entry
To be copied to the draft changelog by merger:
Reviewer Checklist
issues/XXXX-fix-the-thing
in the Toil repo, or from an external repo.camelCase
that want to be insnake_case
.docs/running/{cliOptions,cwl,wdl}.rst
Merger Checklist