From cfe9c45db6ad7057eb626776de79ed7300203407 Mon Sep 17 00:00:00 2001 From: Alexey Kleandrov Date: Thu, 30 Jan 2020 17:40:33 +0300 Subject: [PATCH] docs: sync parameter (#25) --- README.md | 17 +++++++++++++++++ action.yml | 3 +++ 2 files changed, 20 insertions(+) diff --git a/README.md b/README.md index 0685fa6..88f2765 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,7 @@ See [action.yml](./action.yml) for more detailed information. * username - ssh username * password - ssh password * passphrase - the passphrase is usually to encrypt the private key +* sync - synchronous execution if multiple hosts, default is false * timeout - timeout for ssh to remote host, default is `30s` * command_timeout - timeout for ssh command, default is `10m` * key - content of ssh private key. ex raw content of ~/.ssh/id_rsa @@ -131,6 +132,22 @@ Multiple Hosts ls -al ``` +Synchronous execution on multiple hosts + +```diff + - name: multiple host + uses: appleboy/ssh-action@master + with: + host: "foo.com,bar.com" ++ sync: true + username: ${{ secrets.USERNAME }} + key: ${{ secrets.KEY }} + port: ${{ secrets.PORT }} + script: | + whoami + ls -al +``` + Pass environment variable to shell script ```diff diff --git a/action.yml b/action.yml index f5f425f..588dab2 100644 --- a/action.yml +++ b/action.yml @@ -13,6 +13,9 @@ inputs: description: 'ssh username' password: description: 'ssh password' + sync: + description: 'synchronous execution if multiple hosts' + default: false timeout: description: 'timeout for ssh to remote host' default: "30s"