Skip to content
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 new requirements section, deprecate runtime #540

Closed
jdidion opened this issue Mar 23, 2023 · 6 comments
Closed

Add new requirements section, deprecate runtime #540

jdidion opened this issue Mar 23, 2023 · 6 comments
Assignees
Milestone

Comments

@jdidion
Copy link
Collaborator

jdidion commented Mar 23, 2023

In the 3/10/23 governance call we decided that, rather than backport the changes to runtime that currently appear in the development version, we will instead deprecate the runtime section and add a new requirements section that will have the semantics of the development runtime section.

@jdidion
Copy link
Collaborator Author

jdidion commented Mar 23, 2023

Also see #484

@DavyCats
Copy link
Contributor

Changing from runtime to requirements would constitute a breaking change, so this would have to be part of 2.0, right? Unless requirements gets added as a synonym in 1.2 while runtime remains available as well.

@jdidion
Copy link
Collaborator Author

jdidion commented Mar 24, 2023

Yes, sorry, should have added more details. runtime will be deprecated but still supported in 1.2. It will be removed in 2.0.

@jdidion jdidion self-assigned this Mar 28, 2023
@patmagee
Copy link
Member

@DavyCats as @jdidion mentioned, we are not going to be breaking the spec here but will introduce an explicit deprecation of the runtime block in favour of the requirements section.

They will co-exist up until the 2.0 release. requirements provide a stricter vocabulary hopefully helping with portability

@vsmalladi
Copy link
Contributor

Im not sure this is necessary. This seems unnecessary to move from runtime to requirements what is the value we are getting by doing this?

@jdidion
Copy link
Collaborator Author

jdidion commented Feb 2, 2024

Originally, we had planned in WDL 2.0 to change the semantics of runtime (in a breaking way) to only allow specific attributes. All optional attributes were to move to hints.

We then decided to implement this change in WDL 1.2, but since we cannot introduce a breaking change, we decided instead to deprecate runtime in favor of requirements and hints. The name requirements is also more clear than runtime regarding the intent of that section, and it also matches the term used in CWL.

@jdidion jdidion closed this as completed Feb 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

No branches or pull requests

4 participants