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

Clarification needed in "Network Access" #396

Open
zoe-translates opened this issue May 25, 2023 · 1 comment
Open

Clarification needed in "Network Access" #396

zoe-translates opened this issue May 25, 2023 · 1 comment

Comments

@zoe-translates
Copy link
Contributor

zoe-translates commented May 25, 2023

https://github.com/common-workflow-language/user_guide/blob/7b71012f6d286fbea44e052a54a1d5977eb9f3ca/src/topics/command-line-tool.md?plain=1#LL70C1-L71C40

If a command-line tool is written manually in CWL v1.1+, there is a need to specify when network access is required.

Here is it actually relevant whether "a command-line tool... in CWL v1.1+" is written "manually" (as opposed to output by code-generation)?

Based on what I know (not much), this may mean to say

"For a command-line tool written de novo following the CWL spec v1.1 or above, it is necessary to explicitly specify the network access requirement when applicable. For CWL tools originally targeting v1.0, when 'upgraded' (by a code-generation tool? please illuminate), network access requirement is automatically added to them“,

or

"... when 'upgraded' (i.e. when a CWL file specifying 1.0 as version is being executed by a higher-versioned cwl runner), network access requirement is implicitly added at runtime, no matter whether actual access is going to be made by the tool."

Is one of my understandings accurate?

Asking because it's difficult to translate correctly without further clarity.

@mr-c
Copy link
Member

mr-c commented Jul 5, 2023

"For a command-line tool written de novo following the CWL spec v1.1 or above, it is necessary to explicitly specify the network access requirement when applicable. For CWL tools originally targeting v1.0, when 'upgraded' (by a code-generation tool? please illuminate), network access requirement is automatically added to them“,

This is correct. cwltool and engines that use it can auto-upgrade. There is also a standalone upgrader that also adds the network access requirement automatically.

https://pypi.org/project/cwl-upgrader/

Can you open a pull request to improve the English wording?

(Many thanks!)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants