Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
terminal

GitHub Action

ssh-job

v1.0.2

ssh-job

terminal

ssh-job

Execute any script through ssh

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: ssh-job

              
  uses: nekiro/ssh-job@v1.0.2
Learn more about this action in nekiro/ssh-job

Choose a version

test-build

ssh-job

Execute any command on target machine easily

Options

Param default required description
host n/a true Host to connect to
port 22 false Port to connect to
key n/a true Private key used for authorization
user n/a true User used for authorization
password n/a false Password used for authorization
envs n/a false Json serialized secrets exported to shell
ignoredEnvs n/a false List of comma separated envs to ignore when exporting to shell
command n/a true Command/s or script to execute
exportActionOptions false true Export action options, this is handy when you want to access HOST, USER or any other options in shell script

Examples

Authorize with ssh private key and execute some commands

- name: create-directory
  uses: nekiro/ssh-job@v1.0.0
  with:
    host: ${{ secrets.HOST }}
    key: ${{ secrets.KEY }}
    user: ${{ secrets.USER }}
    command: |
      ls
      mkdir dir

It's possible to automatically pass github secrets to the shell script, it allows you to use provided secrets directly in the bash script.

In this example, we have few secrets for example DIRECTORY, we want to pass all of them to shell script, so we simply add envs: ${{ toJson(secrets) }} and use it as regular bash variable

Keep in mind action options are not exported by default, so you wont be able to access HOST, KEY etc.

- name: create-directory
  uses: nekiro/ssh-job@v1.0.0
  with:
    host: ${{ secrets.HOST }}
    key: ${{ secrets.KEY }}
    user: ${{ secrets.USER }}
    envs: ${{ toJson(secrets) }}
    command: mkdir $DIRECTORY