[JIRA] (JENKINS-60156) sshGet documentation should be more explanatory about arguments behavior

[jielpe-cblv38@protonmail.com (JIRA)]

jlpinardon created an issue

Jenkins / JENKINS-60156 sshGet documentation should be more explanatory about arguments behavior Issue Type: Improvement Assignee: Unassigned Components: ssh-plugin Created: 2019-11-13 14:06 Environment: [ssh plugin documentation|https://jenkins.io/doc/pipeline/steps/ssh-steps/#sshget-ssh-steps-sshget-get-a-filedirectory-from-remote-node] and github project README file Priority: Major Reporter: jlpinardon Neither the step documentation nor the SSH Step README file (_referenced as more detailed in the former doc !!) github project explains clearly the behavior controled by each arguments where it is relevant. Specifically it is impossible to understand from the documentation how the override argument of sshGet change the step behavior. It would be really user friendly to explain that when override is set to false not only the local file is preserved (which is awaited, but also an exception is surprisingly raised (IllegalArgumentException... which I do not really understand... but let's admit that) with an additional error message and advice . As this exception is not really awaited, it can lead to unexpected try/catch behavior if the exact exception and its message is not checked to decide if it is a possibly awaited error (the file already exists and won't be erased) or something else more critical. Add Comment

This message was sent by Atlassian Jira (v7.13.6#713006-sha1:cc4451f)

[jielpe-cblv38@protonmail.com (JIRA)]

jlpinardon updated an issue

Jenkins / JENKINS-60156 sshGet documentation should be more explanatory about arguments behavior

Change By: jlpinardon

Environment: [ ssh plugin documentation |https://jenkins.io/doc/pipeline/steps/ssh-steps/#sshget-ssh-steps-sshget-get-a-filedirectory-from-remote-node] and github project README file

Add Comment

[jielpe-cblv38@protonmail.com (JIRA)]

jlpinardon updated an issue

Jenkins / JENKINS-60156 sshGet documentation should be more explanatory about arguments behavior Change By: jlpinardon

Neither the [ssh step plugin documentation |https://jenkins.io/doc/pipeline/steps/ssh-steps/#sshget-ssh-steps-sshget-get-a-filedirectory-from-remote-node] nor the [ SSH Step README |https://github.com/jenkinsci/ssh-steps-plugin] file (_referenced as more detailed in the former doc !!) github project explains clearly the behavior controled by each arguments where it is relevant.

Specifically it is impossible to understand from the documentation how the override argument of sshGet change the step behavior. It would be really user friendly to explain that when override is set to false not only the local file is preserved (which is awaited, but also an exception is surprisingly raised (IllegalArgumentException... which I do not really understand... but let's admit that) with an additional error message and advice . As this exception is not really awaited, it can lead to unexpected try/catch behavior if the exact exception and its message is not checked to decide if it is a possibly awaited error (the file already exists and won't be erased) or something else more critical.

Add Comment

[jielpe-cblv38@protonmail.com (JIRA)]

_Also, the default value should be given._

Add Comment

[jielpe-cblv38@protonmail.com (JIRA)]

jlpinardon updated an issue

Jenkins / JENKINS-60156 sshGet documentation should be more explanatory about arguments behavior

Change By: jlpinardon Component/s: ssh-steps-plugin Component/s: ssh-plugin

Add Comment