actions/ssh-action
1
0
Fork 0
mirror of https://github.com/appleboy/ssh-action.git synced 2025-09-10 19:48:11 +08:00
Code Issues Packages Projects Releases Wiki Activity

Compare commits

base: actions:039c9e07bb37b35054415f27cdbfd7645237832d
Branches Tags
actions:master actions:346 actions:testing
actions:v1 actions:v1.2.2 actions:v1.2.1 actions:v1.2.0 actions:v1.1.0 actions:v1.0.3 actions:v1.0.2 actions:v1.0.1 actions:v1.0.0 actions:v0.1.10 actions:v0.1.9 actions:v0.1.8 actions:v0.1.7 actions:v0.1.6 actions:v0.1.5 actions:v0.1.4 actions:v0.1.3 actions:v0.1.2 actions:v0.1.1 actions:v0.1.0 actions:v0.0.9 actions:v0.0.8 actions:v0.0.7 actions:v0.0.6 actions:v0.0.5 actions:v0.0.4 actions:v0.0.3 actions:v0.0.2 actions:v0.0.1
...
compare: actions:2ead5e36573f08b82fbfce1504f1a4b05a647c6f
Branches Tags
actions:master actions:346 actions:testing
actions:v1 actions:v1.2.2 actions:v1.2.1 actions:v1.2.0 actions:v1.1.0 actions:v1.0.3 actions:v1.0.2 actions:v1.0.1 actions:v1.0.0 actions:v0.1.10 actions:v0.1.9 actions:v0.1.8 actions:v0.1.7 actions:v0.1.6 actions:v0.1.5 actions:v0.1.4 actions:v0.1.3 actions:v0.1.2 actions:v0.1.1 actions:v0.1.0 actions:v0.0.9 actions:v0.0.8 actions:v0.0.7 actions:v0.0.6 actions:v0.0.5 actions:v0.0.4 actions:v0.0.3 actions:v0.0.2 actions:v0.0.1

3 Commits
039c9e07bb ... 2ead5e3657

Author SHA1 Message Date
appleboy
2ead5e3657 chore: update action version across workflows and documentation 
- Update the version of `appleboy/ssh-action` from `v1.2.1` to `v1.2.2` in multiple files
- Modify the bug report template to reflect the updated action version
- Change the action version in the stable workflow file
- Adjust the action version in the README files for consistency across documentation
- Ensure the action version is updated in both Chinese language README files

Signed-off-by: appleboy <appleboy.tw@gmail.com>
 2025-03-09 22:08:40 +08:00
appleboy
a0a0326939 docs: clarify parameter descriptions for improved documentation 
- Update descriptions for various input parameters to provide clearer guidance on their usage.
- Enhance the description for the `capture_stdout` parameter to specify its effect on action output.
- Modify the description for the `stdout` output to clarify its relation to the `capture_stdout` setting.

Signed-off-by: appleboy <appleboy.tw@gmail.com>
 2025-03-09 22:02:08 +08:00
appleboy
b0a8f324e1 chore: bump DRONE_SSH version to 1.8.1 
- Update the default version of DRONE_SSH from 1.8.0 to 1.8.1

Signed-off-by: appleboy <appleboy.tw@gmail.com>
 2025-03-09 21:54:21 +08:00
7 changed files with 91 additions and 91 deletions
Expand all files Collapse all files

2
.github/ISSUE_TEMPLATE/bug_report.md vendored
View File

@@ -23,7 +23,7 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: executing remote ssh commands using password - name: executing remote ssh commands using password
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}

32
.github/workflows/stable.yml vendored
View File

@@ -31,7 +31,7 @@ jobs:
sleep 2 sleep 2
- name: ssh by username and password - name: ssh by username and password
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
host: ${{ env.REMOTE_HOST }} host: ${{ env.REMOTE_HOST }}
username: linuxserver.io username: linuxserver.io
@@ -43,7 +43,7 @@ jobs:
whoami whoami
- name: ssh commands from a file - name: ssh commands from a file
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
host: ${{ env.REMOTE_HOST }} host: ${{ env.REMOTE_HOST }}
username: linuxserver.io username: linuxserver.io
@@ -95,7 +95,7 @@ jobs:
sleep 2 sleep 2
- name: ssh by private key - name: ssh by private key
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
host: ${{ env.REMOTE_HOST }} host: ${{ env.REMOTE_HOST }}
username: linuxserver.io username: linuxserver.io
@@ -104,7 +104,7 @@ jobs:
script: whoami script: whoami
- name: wrong password but correct key - name: wrong password but correct key
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
host: ${{ env.REMOTE_HOST }} host: ${{ env.REMOTE_HOST }}
username: linuxserver.io username: linuxserver.io
@@ -114,7 +114,7 @@ jobs:
script: whoami script: whoami
- name: correct password but wrong key - name: correct password but wrong key
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
host: ${{ env.REMOTE_HOST }} host: ${{ env.REMOTE_HOST }}
username: linuxserver.io username: linuxserver.io
@@ -167,7 +167,7 @@ jobs:
sleep 2 sleep 2
- name: ssh key passphrase - name: ssh key passphrase
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
host: ${{ env.REMOTE_HOST }} host: ${{ env.REMOTE_HOST }}
username: linuxserver.io username: linuxserver.io
@@ -179,7 +179,7 @@ jobs:
ls -al ls -al
- name: missing ssh key passphrase - name: missing ssh key passphrase
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
continue-on-error: true continue-on-error: true
with: with:
host: ${{ env.REMOTE_HOST }} host: ${{ env.REMOTE_HOST }}
@@ -192,7 +192,7 @@ jobs:
# https://github.com/appleboy/ssh-action/issues/75#issuecomment-668314271 # https://github.com/appleboy/ssh-action/issues/75#issuecomment-668314271
- name: Multiline SSH commands interpreted as single lines - name: Multiline SSH commands interpreted as single lines
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
host: ${{ env.REMOTE_HOST }} host: ${{ env.REMOTE_HOST }}
username: linuxserver.io username: linuxserver.io
@@ -269,7 +269,7 @@ jobs:
# https://github.com/appleboy/ssh-action/issues/85 # https://github.com/appleboy/ssh-action/issues/85
- name: Deployment to multiple hosts with different ports - name: Deployment to multiple hosts with different ports
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
host: "${{ env.REMOTE_HOST_01 }}:2222,${{ env.REMOTE_HOST_02 }}:2222" host: "${{ env.REMOTE_HOST_01 }}:2222,${{ env.REMOTE_HOST_02 }}:2222"
username: linuxserver.io username: linuxserver.io
@@ -322,7 +322,7 @@ jobs:
sleep 2 sleep 2
- name: testing id_ed25519 key - name: testing id_ed25519 key
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
host: ${{ env.REMOTE_HOST }} host: ${{ env.REMOTE_HOST }}
username: linuxserver.io username: linuxserver.io
@@ -375,7 +375,7 @@ jobs:
sleep 2 sleep 2
- name: testing id_ed25519 key - name: testing id_ed25519 key
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
host: ${{ env.REMOTE_HOST }} host: ${{ env.REMOTE_HOST }}
username: linuxserver.io username: linuxserver.io
@@ -386,7 +386,7 @@ jobs:
ls -al ls -al
- name: pass environment - name: pass environment
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
env: env:
FOO: "BAR" FOO: "BAR"
with: with:
@@ -400,7 +400,7 @@ jobs:
echo "I am $BAR, thanks" echo "I am $BAR, thanks"
- name: pass multiple environment - name: pass multiple environment
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
env: env:
FOO: "BAR" FOO: "BAR"
BAR: "FOO" BAR: "FOO"
@@ -419,7 +419,7 @@ jobs:
echo "port: $PORT" echo "port: $PORT"
- name: custom envs format - name: custom envs format
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
env: env:
FOO: "BAR" FOO: "BAR"
AAA: "BBB" AAA: "BBB"
@@ -437,7 +437,7 @@ jobs:
echo "I am $TEST_AAA, thanks" echo "I am $TEST_AAA, thanks"
- name: pass all ENV variables to script - name: pass all ENV variables to script
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
env: env:
INPUT_FOO: "BAR" INPUT_FOO: "BAR"
INPUT_AAA: "BBB" INPUT_AAA: "BBB"
@@ -454,7 +454,7 @@ jobs:
echo "$GITHUB_REF" echo "$GITHUB_REF"
- name: switch to root user - name: switch to root user
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
host: ${{ env.REMOTE_HOST }} host: ${{ env.REMOTE_HOST }}
username: linuxserver.io username: linuxserver.io

24
README.md
View File

@@ -65,7 +65,7 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: executing remote ssh commands using password - name: executing remote ssh commands using password
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: linuxserver.io username: linuxserver.io
@@ -183,7 +183,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
```yaml ```yaml
- name: executing remote ssh commands using password - name: executing remote ssh commands using password
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
@@ -196,7 +196,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
```yaml ```yaml
- name: executing remote ssh commands using ssh key - name: executing remote ssh commands using ssh key
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
@@ -209,7 +209,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
```yaml ```yaml
- name: multiple command - name: multiple command
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
@@ -226,7 +226,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
```yaml ```yaml
- name: file commands - name: file commands
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
@@ -239,7 +239,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
```diff ```diff
- name: multiple host - name: multiple host
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
- host: "foo.com" - host: "foo.com"
+ host: "foo.com,bar.com" + host: "foo.com,bar.com"
@@ -257,7 +257,7 @@ The default value of `port` is `22`.
```diff ```diff
- name: multiple host - name: multiple host
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
- host: "foo.com" - host: "foo.com"
+ host: "foo.com:1234,bar.com:5678" + host: "foo.com:1234,bar.com:5678"
@@ -272,7 +272,7 @@ The default value of `port` is `22`.
```diff ```diff
- name: multiple host - name: multiple host
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
host: "foo.com,bar.com" host: "foo.com,bar.com"
+ sync: true + sync: true
@@ -288,7 +288,7 @@ The default value of `port` is `22`.
```diff ```diff
- name: pass environment - name: pass environment
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
+ env: + env:
+ FOO: "BAR" + FOO: "BAR"
+ BAR: "FOO" + BAR: "FOO"
@@ -335,7 +335,7 @@ Host FooServer
```diff ```diff
- name: ssh proxy command - name: ssh proxy command
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
@@ -358,7 +358,7 @@ It is not uncommon for files to leak from backups or decommissioned hardware, an
```diff ```diff
- name: ssh key passphrase - name: ssh key passphrase
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
@@ -384,7 +384,7 @@ Now you can adjust you config:
```diff ```diff
- name: ssh key passphrase - name: ssh key passphrase
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}

24
README.zh-cn.md
View File

@@ -65,7 +65,7 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: executing remote ssh commands using password - name: executing remote ssh commands using password
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: linuxserver.io username: linuxserver.io
@@ -183,7 +183,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
```yaml ```yaml
- name: executing remote ssh commands using password - name: executing remote ssh commands using password
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
@@ -196,7 +196,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
```yaml ```yaml
- name: executing remote ssh commands using ssh key - name: executing remote ssh commands using ssh key
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
@@ -209,7 +209,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
```yaml ```yaml
- name: multiple command - name: multiple command
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
@@ -226,7 +226,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
```yaml ```yaml
- name: file commands - name: file commands
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
@@ -239,7 +239,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
```diff ```diff
- name: multiple host - name: multiple host
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
- host: "foo.com" - host: "foo.com"
+ host: "foo.com,bar.com" + host: "foo.com,bar.com"
@@ -257,7 +257,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
```diff ```diff
- name: multiple host - name: multiple host
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
- host: "foo.com" - host: "foo.com"
+ host: "foo.com:1234,bar.com:5678" + host: "foo.com:1234,bar.com:5678"
@@ -272,7 +272,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
```diff ```diff
- name: multiple host - name: multiple host
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
host: "foo.com,bar.com" host: "foo.com,bar.com"
+ sync: true + sync: true
@@ -288,7 +288,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
```diff ```diff
- name: pass environment - name: pass environment
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
+ env: + env:
+ FOO: "BAR" + FOO: "BAR"
+ BAR: "FOO" + BAR: "FOO"
@@ -335,7 +335,7 @@ Host FooServer
```diff ```diff
- name: ssh proxy command - name: ssh proxy command
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
@@ -356,7 +356,7 @@ Host FooServer
```diff ```diff
- name: ssh key passphrase - name: ssh key passphrase
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
@@ -382,7 +382,7 @@ ssh example.com ssh-keygen -l -f /etc/ssh/ssh_host_ed25519_key.pub | cut -d ' '
```diff ```diff
- name: ssh key passphrase - name: ssh key passphrase
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}

24
README.zh-tw.md
View File

@@ -65,7 +65,7 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: executing remote ssh commands using password - name: executing remote ssh commands using password
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: linuxserver.io username: linuxserver.io
@@ -181,7 +181,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
```yaml ```yaml
- name: executing remote ssh commands using password - name: executing remote ssh commands using password
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
@@ -194,7 +194,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
```yaml ```yaml
- name: executing remote ssh commands using ssh key - name: executing remote ssh commands using ssh key
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
@@ -207,7 +207,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
```yaml ```yaml
- name: multiple command - name: multiple command
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
@@ -224,7 +224,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
```yaml ```yaml
- name: file commands - name: file commands
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
@@ -237,7 +237,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
```diff ```diff
- name: multiple host - name: multiple host
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
- host: "foo.com" - host: "foo.com"
+ host: "foo.com,bar.com" + host: "foo.com,bar.com"
@@ -253,7 +253,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
```diff ```diff
- name: multiple host - name: multiple host
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
- host: "foo.com" - host: "foo.com"
+ host: "foo.com:1234,bar.com:5678" + host: "foo.com:1234,bar.com:5678"
@@ -268,7 +268,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
```diff ```diff
- name: multiple host - name: multiple host
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
host: "foo.com,bar.com" host: "foo.com,bar.com"
+ sync: true + sync: true
@@ -284,7 +284,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"
```diff ```diff
- name: pass environment - name: pass environment
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
+ env: + env:
+ FOO: "BAR" + FOO: "BAR"
+ BAR: "FOO" + BAR: "FOO"
@@ -331,7 +331,7 @@ Host FooServer
```diff ```diff
- name: ssh proxy command - name: ssh proxy command
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
@@ -352,7 +352,7 @@ Host FooServer
```diff ```diff
- name: ssh key passphrase - name: ssh key passphrase
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
@@ -378,7 +378,7 @@ ssh example.com ssh-keygen -l -f /etc/ssh/ssh_host_ed25519_key.pub | cut -d ' '
```diff ```diff
- name: ssh key passphrase - name: ssh key passphrase
uses: appleboy/ssh-action@v1.2.1 uses: appleboy/ssh-action@v1.2.2
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}

70
action.yml
View File

@@ -3,85 +3,85 @@ description: "Executing remote ssh commands"
author: "Bo-Yi Wu" author: "Bo-Yi Wu"
inputs: inputs:
host: host:
description: "SSH host address." description: "SSH host address or IP to connect to."
port: port:
description: "SSH port number." description: "SSH port number for the connection."
default: "22" default: "22"
passphrase: passphrase:
description: "Passphrase for the SSH key." description: "Passphrase to decrypt the SSH private key if protected."
username: username:
description: "SSH username." description: "SSH username for authentication on the remote server."
password: password:
description: "SSH password." description: "SSH password for authentication (use secrets for sensitive data)."
protocol: protocol:
description: 'The IP protocol to use. Valid values are "tcp". "tcp4" or "tcp6". Default to tcp.' description: 'IP protocol version to use. Options: "tcp" (default), "tcp4" (IPv4 only), or "tcp6" (IPv6 only).'
default: "tcp" default: "tcp"
sync: sync:
description: "Enable synchronous execution if multiple hosts are involved." description: "When true, executes commands synchronously across multiple hosts (one after another)."
use_insecure_cipher: use_insecure_cipher:
description: "Include more ciphers by using insecure ciphers." description: "Enable additional legacy ciphers that might be less secure but more compatible with older systems."
cipher: cipher:
description: "Allowed cipher algorithms. If unspecified, a sensible default is used." description: "Specify custom cipher algorithms for encryption. Leave empty to use secure defaults."
timeout: timeout:
description: "Timeout duration for establishing SSH connection to the host." description: "Maximum time to wait when establishing the SSH connection, e.g., '30s', '1m'."
default: "30s" default: "30s"
command_timeout: command_timeout:
description: "Timeout duration for SSH commands execution." description: "Maximum execution time for the remote commands before terminating, e.g., '10m', '1h'."
default: "10m" default: "10m"
key: key:
description: "Content of the SSH private key. For example, the raw content of ~/.ssh/id_rsa." description: "Raw content of the SSH private key for authentication (use secrets for sensitive data)."
key_path: key_path:
description: "Path to the SSH private key file." description: "Path to the SSH private key file on the runner."
fingerprint: fingerprint:
description: "SHA256 fingerprint of the host public key." description: "SHA256 fingerprint of the host public key for verification to prevent MITM attacks."
proxy_host: proxy_host:
description: "SSH proxy host address." description: "Proxy server hostname or IP if connecting through an SSH jump host."
proxy_port: proxy_port:
description: "SSH proxy port number." description: "SSH port number for the proxy connection."
default: "22" default: "22"
proxy_username: proxy_username:
description: "SSH proxy username." description: "Username for authentication on the proxy server."
proxy_password: proxy_password:
description: "SSH proxy password." description: "Password for authentication on the proxy server (use secrets for sensitive data)."
proxy_protocol: proxy_protocol:
description: 'The IP protocol to use. Valid values are "tcp". "tcp4" or "tcp6". Default to tcp.' description: 'IP protocol version for proxy. Options: "tcp" (default), "tcp4" (IPv4 only), or "tcp6" (IPv6 only).'
default: "tcp" default: "tcp"
proxy_passphrase: proxy_passphrase:
description: "SSH proxy key passphrase." description: "Passphrase to decrypt the proxy SSH private key if protected."
proxy_timeout: proxy_timeout:
description: "Timeout duration for establishing SSH connection to the proxy host." description: "Maximum time to wait when establishing the proxy SSH connection, e.g., '30s', '1m'."
default: "30s" default: "30s"
proxy_key: proxy_key:
description: "Content of the SSH proxy private key. For example, the raw content of ~/.ssh/id_rsa." description: "Raw content of the SSH proxy private key for authentication (use secrets for sensitive data)."
proxy_key_path: proxy_key_path:
description: "Path to the SSH proxy private key file." description: "Path to the SSH proxy private key file on the runner."
proxy_fingerprint: proxy_fingerprint:
description: "SHA256 fingerprint of the proxy host public key." description: "SHA256 fingerprint of the proxy host public key for verification."
proxy_cipher: proxy_cipher:
description: "Allowed cipher algorithms for the proxy. If unspecified, a sensible default is used." description: "Specify custom cipher algorithms for proxy connection encryption."
proxy_use_insecure_cipher: proxy_use_insecure_cipher:
description: "Include more ciphers for the proxy by using insecure ciphers." description: "Enable additional legacy ciphers for proxy connections (less secure but more compatible)."
script: script:
description: "Commands to be executed." description: "Commands to execute on the remote server (inline script string)."
script_path: script_path:
description: "Path to the file containing commands to be executed." description: "Path to a local file containing commands to execute on the remote server."
envs: envs:
description: "Environment variables to be passed to the shell script." description: "Environment variables to expose to the remote script, format: key=value,key2=value2."
envs_format: envs_format:
description: "Flexible configuration for environment value transfer." description: "Format specification for environment variable transfer (for advanced usage)."
debug: debug:
description: "Enable debug mode." description: "Set to true to enable verbose logging for troubleshooting connection issues."
allenvs: allenvs:
description: "pass all environment variable to shell script." description: "When true, passes all GitHub Actions environment variables to the remote script."
request_pty: request_pty:
description: "Request a pseudo-terminal from the server." description: "Request a pseudo-terminal from the server (required for interactive commands or sudo)."
capture_stdout: capture_stdout:
description: "Capture the stdout of the commands." description: "When true, captures and returns standard output from the commands as action output."
default: "false" default: "false"
outputs: outputs:
stdout: stdout:
description: 'Standard output of the executed commands.' description: "Standard output of the executed commands when capture_stdout is enabled."
value: ${{ steps.entrypoint.outputs.stdout }} value: ${{ steps.entrypoint.outputs.stdout }}
runs: runs:

2
entrypoint.sh
View File

@@ -8,7 +8,7 @@ export GITHUB="true"
GITHUB_ACTION_PATH="${GITHUB_ACTION_PATH%/}" GITHUB_ACTION_PATH="${GITHUB_ACTION_PATH%/}"
DRONE_SSH_RELEASE_URL="${DRONE_SSH_RELEASE_URL:-https://github.com/appleboy/drone-ssh/releases/download}" DRONE_SSH_RELEASE_URL="${DRONE_SSH_RELEASE_URL:-https://github.com/appleboy/drone-ssh/releases/download}"
DRONE_SSH_VERSION="${DRONE_SSH_VERSION:-1.8.0}" DRONE_SSH_VERSION="${DRONE_SSH_VERSION:-1.8.1}"
function detect_client_info() { function detect_client_info() {
if [ -n "${SSH_CLIENT_OS-}" ]; then if [ -n "${SSH_CLIENT_OS-}" ]; then