Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The SSH Run Script Action is used to run scripts on an SSH server. The action can either run an entire script or a list of commands. All output is written to the build log as it is received from the host. 

Note
titleNote:

The action cannot supply user inputs to commands run on the host.

SSH Run Script

Name

A friendly name for this action (will be displayed in the actions workflow area).

...

The commands option allows for running of a sequence of commands in the action. The action will open a channel once connected and proceed to call each command in sequence waiting for the previous command to complete. Once all commands have been run, the channel and connection will be closed and the action will completed, returning the exitCode exit code of the last run command.

Script

...

Authentication

Username

The username of the user under which all the commands will be run. The user will only be logged in for the lifetime of the action.

...

If this is ticked, a non-zero ExitCode exit code would cause it to fail.  

Ignore ExitCodesExit Codes

The list of ExitCodes exit codes to ignore (Comma-delimited).

ExitCode Exit Code Variable

Select the name of the The build variable to set with store the last exit code received from the script or commands that were run. All commands are run through an SSH channel. On completion of running all the commands supplied, the channel returns its exit status.

from this command. Expression variables which cannot be modified are not listed.

...

If this is ticked, the next command would continue to run on failure.

ExitCode Variable

The variable to store the last exit code received from the script or commands that were run. All commands are run through an SSH channel. On completion of running all the commands supplied, the channel returns its exit status.

Script timeout

The time in milliseconds to wait before the action should timeout waiting for a response from the host. 

...

If this is ticked, any warnings logged will not mark the action with a warning status.

Image Removed

...

titleNote:

...

.