actions/ssh-action
1
0
Fork 0
mirror of https://github.com/appleboy/ssh-action.git synced 2025-04-07 19:21:59 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Compare commits

base: actions:v1
Branches Tags
actions:master
actions:346
actions:testing
actions:v1.2.2
actions:v1
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:master
Branches Tags
actions:master
actions:346
actions:testing
actions:v1.2.2
actions:v1
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

7 commits
v1 ... master

Author SHA1 Message Date
appleboy
9ca1cd2174
docs: document the new curl_insecure configuration option 
- Add `curl_insecure` option to README.md
- Add `curl_insecure` option to README.zh-cn.md
- Add `curl_insecure` option to README.zh-tw.md

Signed-off-by: appleboy <appleboy.tw@gmail.com>
 2025-03-29 12:46:43 +08:00
appleboy
20d5c5bbc9
feat: add configurable curl insecure flag to GitHub action 
- Add input parameter `curl_insecure` to `action.yml` with a default value of false
- Pass `curl_insecure` input to the action's environment in `action.yml`
- Modify `entrypoint.sh` to conditionally add the `--insecure` option to curl if `INPUT_CURL_INSECURE` is true

Signed-off-by: appleboy <appleboy.tw@gmail.com>
 2025-03-29 12:43:09 +08:00
appleboy
b27b9f8968
chore: refactor system to improve efficiency and update API usage 
- Update changelog order value from `4` to `5`

Signed-off-by: appleboy <appleboy.tw@gmail.com>
 2025-03-29 00:29:34 +08:00
appleboy
689de3cf64
docs: improve CLI messaging and error clarity for users 
- Clarify error message for unsupported platforms
- Clarify error message for unsupported architectures
- Change download message to indicate ongoing action
- Expand CLI version header for clarity

Signed-off-by: appleboy <appleboy.tw@gmail.com>
 2025-03-29 00:27:32 +08:00
Bo-Yi Wu
b6690ee817
refactor: improve error handling and code readability across scripts (#374) 
- Add `log_error` function for error handling
- Simplify the detection of client platform and architecture
- Use `log_error` for unsupported platform or architecture handling
- Use consistent quoting for variable expansions
- Improve readability for `curl` and `chmod` commands
- Simplify the commands for running and capturing stdout

Signed-off-by: appleboy <appleboy.tw@gmail.com>
 2025-03-29 00:25:15 +08:00
Bo-Yi Wu
52a1840ca6
docs: update SSH action version to v1 in all README files (#372) 
- Update 'appleboy/ssh-action' version from 'v1.2.2' to 'v1' in various locations in the README.md file
- Update 'appleboy/ssh-action' version from 'v1.2.2' to 'v1' in various locations in README.zh-cn.md
- Update 'appleboy/ssh-action' version from 'v1.2.2' to 'v1' in various locations in README.zh-tw.md

Signed-off-by: appleboy <appleboy.tw@gmail.com>
 2025-03-15 15:01:18 +08:00
appleboy
2b3c6504b3
ci: unify and enhance GitHub workflow configurations 
- Update appleboy/ssh-action to use the generic v1 version instead of v1.2.2 for multiple steps within the workflow

Signed-off-by: appleboy <appleboy.tw@gmail.com>
 2025-03-15 14:57:10 +08:00
7 changed files with 98 additions and 110 deletions
Show stats Expand all files Collapse all files

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.2 uses: appleboy/ssh-action@v1
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.2 uses: appleboy/ssh-action@v1
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.2 uses: appleboy/ssh-action@v1
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.2 uses: appleboy/ssh-action@v1
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.2 uses: appleboy/ssh-action@v1
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.2 uses: appleboy/ssh-action@v1
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.2 uses: appleboy/ssh-action@v1
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.2 uses: appleboy/ssh-action@v1
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.2 uses: appleboy/ssh-action@v1
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.2 uses: appleboy/ssh-action@v1
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.2 uses: appleboy/ssh-action@v1
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.2 uses: appleboy/ssh-action@v1
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.2 uses: appleboy/ssh-action@v1
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.2 uses: appleboy/ssh-action@v1
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.2 uses: appleboy/ssh-action@v1
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.2 uses: appleboy/ssh-action@v1
with: with:
host: ${{ env.REMOTE_HOST }} host: ${{ env.REMOTE_HOST }}
username: linuxserver.io username: linuxserver.io

2
.goreleaser.yaml
View file

@ -24,5 +24,5 @@ changelog:
order: 4 order: 4
- title: "Documentation updates" - title: "Documentation updates"
regexp: ^.*?docs?(\(.+\))??!?:.+$ regexp: ^.*?docs?(\(.+\))??!?:.+$
order: 4 order: 5
- title: Others - title: Others

25
README.md
View file

@ -49,6 +49,7 @@ Refer to [action.yml](./action.yml) for more detailed information.
| debug | Enable debug mode | false | | debug | Enable debug mode | false |
| allenvs | Pass the environment variables with prefix value of `GITHUB_` and `INPUT_` to the script | false | | allenvs | Pass the environment variables with prefix value of `GITHUB_` and `INPUT_` to the script | false |
| request_pty | Request a pseudo-terminal from the server | false | | request_pty | Request a pseudo-terminal from the server | false |
| curl_insecure | Allow curl to connect to SSL sites without certificates | false |
**Note:** Users can add `set -e` in their shell script to achieve similar functionality to the removed `script_stop` option. **Note:** Users can add `set -e` in their shell script to achieve similar functionality to the removed `script_stop` option.
@ -65,7 +66,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.2 uses: appleboy/ssh-action@v1
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: linuxserver.io username: linuxserver.io
@ -183,7 +184,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.2 uses: appleboy/ssh-action@v1
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
@ -196,7 +197,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.2 uses: appleboy/ssh-action@v1
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
@ -209,7 +210,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.2 uses: appleboy/ssh-action@v1
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
@ -226,7 +227,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.2 uses: appleboy/ssh-action@v1
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
@ -239,7 +240,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.2 uses: appleboy/ssh-action@v1
with: with:
- host: "foo.com" - host: "foo.com"
+ host: "foo.com,bar.com" + host: "foo.com,bar.com"
@ -257,7 +258,7 @@ The default value of `port` is `22`.
```diff ```diff
- name: multiple host - name: multiple host
uses: appleboy/ssh-action@v1.2.2 uses: appleboy/ssh-action@v1
with: with:
- host: "foo.com" - host: "foo.com"
+ host: "foo.com:1234,bar.com:5678" + host: "foo.com:1234,bar.com:5678"
@ -272,7 +273,7 @@ The default value of `port` is `22`.
```diff ```diff
- name: multiple host - name: multiple host
uses: appleboy/ssh-action@v1.2.2 uses: appleboy/ssh-action@v1
with: with:
host: "foo.com,bar.com" host: "foo.com,bar.com"
+ sync: true + sync: true
@ -288,7 +289,7 @@ The default value of `port` is `22`.
```diff ```diff
- name: pass environment - name: pass environment
uses: appleboy/ssh-action@v1.2.2 uses: appleboy/ssh-action@v1
+ env: + env:
+ FOO: "BAR" + FOO: "BAR"
+ BAR: "FOO" + BAR: "FOO"
@ -335,7 +336,7 @@ Host FooServer
```diff ```diff
- name: ssh proxy command - name: ssh proxy command
uses: appleboy/ssh-action@v1.2.2 uses: appleboy/ssh-action@v1
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
@ -358,7 +359,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.2 uses: appleboy/ssh-action@v1
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
@ -384,7 +385,7 @@ Now you can adjust you config:
```diff ```diff
- name: ssh key passphrase - name: ssh key passphrase
uses: appleboy/ssh-action@v1.2.2 uses: appleboy/ssh-action@v1
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}

25
README.zh-cn.md
View file

@ -49,6 +49,7 @@
| debug | 启用调试模式 | false | | debug | 启用调试模式 | false |
| allenvs | 将带有 `GITHUB_` 和 `INPUT_` 前缀的环境变量传递给脚本 | false | | allenvs | 将带有 `GITHUB_` 和 `INPUT_` 前缀的环境变量传递给脚本 | false |
| request_pty | 请求伪终端 | false | | request_pty | 请求伪终端 | false |
| curl_insecure | 在 curl 中使用不安全的证书验证 | false |
**注意：** 用户可以在他们的 shell 脚本中添加 `set -e` 以实现类似于已删除的 `script_stop` 选项的功能。 **注意：** 用户可以在他们的 shell 脚本中添加 `set -e` 以实现类似于已删除的 `script_stop` 选项的功能。
@ -65,7 +66,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.2 uses: appleboy/ssh-action@v1
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: linuxserver.io username: linuxserver.io
@ -183,7 +184,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.2 uses: appleboy/ssh-action@v1
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
@ -196,7 +197,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.2 uses: appleboy/ssh-action@v1
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
@ -209,7 +210,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.2 uses: appleboy/ssh-action@v1
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
@ -226,7 +227,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.2 uses: appleboy/ssh-action@v1
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
@ -239,7 +240,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.2 uses: appleboy/ssh-action@v1
with: with:
- host: "foo.com" - host: "foo.com"
+ host: "foo.com,bar.com" + host: "foo.com,bar.com"
@ -257,7 +258,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.2 uses: appleboy/ssh-action@v1
with: with:
- host: "foo.com" - host: "foo.com"
+ host: "foo.com:1234,bar.com:5678" + host: "foo.com:1234,bar.com:5678"
@ -272,7 +273,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.2 uses: appleboy/ssh-action@v1
with: with:
host: "foo.com,bar.com" host: "foo.com,bar.com"
+ sync: true + sync: true
@ -288,7 +289,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.2 uses: appleboy/ssh-action@v1
+ env: + env:
+ FOO: "BAR" + FOO: "BAR"
+ BAR: "FOO" + BAR: "FOO"
@ -335,7 +336,7 @@ Host FooServer
```diff ```diff
- name: ssh proxy command - name: ssh proxy command
uses: appleboy/ssh-action@v1.2.2 uses: appleboy/ssh-action@v1
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
@ -356,7 +357,7 @@ Host FooServer
```diff ```diff
- name: ssh key passphrase - name: ssh key passphrase
uses: appleboy/ssh-action@v1.2.2 uses: appleboy/ssh-action@v1
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
@ -382,7 +383,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.2 uses: appleboy/ssh-action@v1
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}

25
README.zh-tw.md
View file

@ -49,6 +49,7 @@
| debug | 啟用調試模式 | false | | debug | 啟用調試模式 | false |
| allenvs | 將帶有 `GITHUB_` 和 `INPUT_` 前綴的環境變數傳遞給腳本 | false | | allenvs | 將帶有 `GITHUB_` 和 `INPUT_` 前綴的環境變數傳遞給腳本 | false |
| request_pty | 從伺服器請求偽終端 | false | | request_pty | 從伺服器請求偽終端 | false |
| curl_insecure | 在 curl 命令中使用不安全的 SSL 證書驗證 | false |
**注意：** 用戶可以在他們的 shell 腳本中添加 `set -e` 以實現類似於已刪除的 `script_stop` 選項的功能。 **注意：** 用戶可以在他們的 shell 腳本中添加 `set -e` 以實現類似於已刪除的 `script_stop` 選項的功能。
@ -65,7 +66,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.2 uses: appleboy/ssh-action@v1
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: linuxserver.io username: linuxserver.io
@ -181,7 +182,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.2 uses: appleboy/ssh-action@v1
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
@ -194,7 +195,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.2 uses: appleboy/ssh-action@v1
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
@ -207,7 +208,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.2 uses: appleboy/ssh-action@v1
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
@ -224,7 +225,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.2 uses: appleboy/ssh-action@v1
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
@ -237,7 +238,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.2 uses: appleboy/ssh-action@v1
with: with:
- host: "foo.com" - host: "foo.com"
+ host: "foo.com,bar.com" + host: "foo.com,bar.com"
@ -253,7 +254,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.2 uses: appleboy/ssh-action@v1
with: with:
- host: "foo.com" - host: "foo.com"
+ host: "foo.com:1234,bar.com:5678" + host: "foo.com:1234,bar.com:5678"
@ -268,7 +269,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.2 uses: appleboy/ssh-action@v1
with: with:
host: "foo.com,bar.com" host: "foo.com,bar.com"
+ sync: true + sync: true
@ -284,7 +285,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.2 uses: appleboy/ssh-action@v1
+ env: + env:
+ FOO: "BAR" + FOO: "BAR"
+ BAR: "FOO" + BAR: "FOO"
@ -331,7 +332,7 @@ Host FooServer
```diff ```diff
- name: ssh proxy command - name: ssh proxy command
uses: appleboy/ssh-action@v1.2.2 uses: appleboy/ssh-action@v1
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
@ -352,7 +353,7 @@ Host FooServer
```diff ```diff
- name: ssh key passphrase - name: ssh key passphrase
uses: appleboy/ssh-action@v1.2.2 uses: appleboy/ssh-action@v1
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}
@ -378,7 +379,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.2 uses: appleboy/ssh-action@v1
with: with:
host: ${{ secrets.HOST }} host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }} username: ${{ secrets.USERNAME }}

4
action.yml
View file

@ -75,6 +75,9 @@ inputs:
description: "When true, passes all GitHub Actions environment variables to the remote 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 (required for interactive commands or sudo)." description: "Request a pseudo-terminal from the server (required for interactive commands or sudo)."
curl_insecure:
description: "When true, uses the --insecure option with curl for insecure downloads."
default: "false"
capture_stdout: capture_stdout:
description: "When true, captures and returns standard output from the commands as action output." description: "When true, captures and returns standard output from the commands as action output."
default: "false" default: "false"
@ -131,6 +134,7 @@ runs:
INPUT_PROXY_CIPHER: ${{ inputs.proxy_cipher }} INPUT_PROXY_CIPHER: ${{ inputs.proxy_cipher }}
INPUT_SYNC: ${{ inputs.sync }} INPUT_SYNC: ${{ inputs.sync }}
INPUT_CAPTURE_STDOUT: ${{ inputs.capture_stdout }} INPUT_CAPTURE_STDOUT: ${{ inputs.capture_stdout }}
INPUT_CURL_INSECURE: ${{ inputs.curl_insecure }}
branding: branding:
icon: "terminal" icon: "terminal"

95
entrypoint.sh
View file

@ -10,68 +10,49 @@ 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.1}" DRONE_SSH_VERSION="${DRONE_SSH_VERSION:-1.8.1}"
function detect_client_info() { function log_error() {
if [ -n "${SSH_CLIENT_OS-}" ]; then echo "$1" >&2
CLIENT_PLATFORM="${SSH_CLIENT_OS}" exit "$2"
else }
local kernel
kernel="$(uname -s)"
case "${kernel}" in
Darwin)
CLIENT_PLATFORM="darwin"
;;
Linux)
CLIENT_PLATFORM="linux"
;;
Windows)
CLIENT_PLATFORM="windows"
;;
*)
echo "Unknown, unsupported platform: ${kernel}." >&2
echo "Supported platforms: Linux, Darwin and Windows." >&2
echo "Bailing out." >&2
exit 2
;;
esac
fi
if [ -n "${SSH_CLIENT_ARCH-}" ]; then function detect_client_info() {
CLIENT_ARCH="${SSH_CLIENT_ARCH}" CLIENT_PLATFORM="${SSH_CLIENT_OS:-$(uname -s | tr '[:upper:]' '[:lower:]')}"
else CLIENT_ARCH="${SSH_CLIENT_ARCH:-$(uname -m)}"
local machine
machine="$(uname -m)" case "${CLIENT_PLATFORM}" in
case "${machine}" in darwin | linux | windows) ;;
x86_64* | i?86_64* | amd64*) *) log_error "Unknown or unsupported platform: ${CLIENT_PLATFORM}. Supported platforms are Linux, Darwin, and Windows." 2 ;;
CLIENT_ARCH="amd64" esac
;;
aarch64* | arm64*) case "${CLIENT_ARCH}" in
CLIENT_ARCH="arm64" x86_64* | i?86_64* | amd64*) CLIENT_ARCH="amd64" ;;
;; aarch64* | arm64*) CLIENT_ARCH="arm64" ;;
*) *) log_error "Unknown or unsupported architecture: ${CLIENT_ARCH}. Supported architectures are x86_64, i686, and arm64." 3 ;;
echo "Unknown, unsupported architecture (${machine})." >&2 esac
echo "Supported architectures x86_64, i686, arm64." >&2
echo "Bailing out." >&2
exit 3
;;
esac
fi
} }
detect_client_info detect_client_info
DOWNLOAD_URL_PREFIX="${DRONE_SSH_RELEASE_URL}/v${DRONE_SSH_VERSION}" DOWNLOAD_URL_PREFIX="${DRONE_SSH_RELEASE_URL}/v${DRONE_SSH_VERSION}"
CLIENT_BINARY="drone-ssh-${DRONE_SSH_VERSION}-${CLIENT_PLATFORM}-${CLIENT_ARCH}" CLIENT_BINARY="drone-ssh-${DRONE_SSH_VERSION}-${CLIENT_PLATFORM}-${CLIENT_ARCH}"
TARGET="${GITHUB_ACTION_PATH}/${CLIENT_BINARY}" TARGET="${GITHUB_ACTION_PATH}/${CLIENT_BINARY}"
echo "Will download ${CLIENT_BINARY} from ${DOWNLOAD_URL_PREFIX}" echo "Downloading ${CLIENT_BINARY} from ${DOWNLOAD_URL_PREFIX}"
curl -fsSL --retry 5 --keepalive-time 2 "${DOWNLOAD_URL_PREFIX}/${CLIENT_BINARY}" -o ${TARGET} INSECURE_OPTION=""
chmod +x ${TARGET} if [[ "${INPUT_CURL_INSECURE}" == 'true' ]]; then
INSECURE_OPTION="--insecure"
echo "======= CLI Version =======" fi
sh -c "${TARGET} --version" # print version
echo "===========================" curl -fsSL --retry 5 --keepalive-time 2 ${INSECURE_OPTION} "${DOWNLOAD_URL_PREFIX}/${CLIENT_BINARY}" -o "${TARGET}"
if [[ "$INPUT_CAPTURE_STDOUT" == 'true' ]]; then chmod +x "${TARGET}"
echo 'stdout<<EOF' >>$GITHUB_OUTPUT # use heredoc for multiline output
sh -c "${TARGET} $*" | tee -a $GITHUB_OUTPUT # run the command echo "======= CLI Version Information ======="
echo 'EOF' >>$GITHUB_OUTPUT "${TARGET}" --version
else echo "======================================="
sh -c "${TARGET} $*" # run the command if [[ "${INPUT_CAPTURE_STDOUT}" == 'true' ]]; then
{
echo 'stdout<<EOF'
"${TARGET}" "$@" | tee -a "${GITHUB_OUTPUT}"
echo 'EOF'
} >>"${GITHUB_OUTPUT}"
else
"${TARGET}" "$@"
fi fi