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>
docs: improve CLI messaging and error clarity for users
2025-09-10 11:39:48 +08:00 · 2025-03-29 00:29:34 +08:00 · 2025-03-29 00:27:32 +08:00 · 2025-03-29 00:25:15 +08:00 · 2025-03-15 15:01:18 +08:00 · 2025-03-15 14:57:10 +08:00
6 changed files with 84 additions and 108 deletions
--- a/.github/workflows/stable.yml
+++ b/.github/workflows/stable.yml
@@ -31,7 +31,7 @@ jobs:
          sleep 2

      - name: ssh by username and password
-        uses: appleboy/ssh-action@v1.2.2
+        uses: appleboy/ssh-action@v1
        with:
          host: ${{ env.REMOTE_HOST }}
          username: linuxserver.io
@@ -43,7 +43,7 @@ jobs:
            whoami

      - name: ssh commands from a file
-        uses: appleboy/ssh-action@v1.2.2
+        uses: appleboy/ssh-action@v1
        with:
          host: ${{ env.REMOTE_HOST }}
          username: linuxserver.io
@@ -95,7 +95,7 @@ jobs:
          sleep 2

      - name: ssh by private key
-        uses: appleboy/ssh-action@v1.2.2
+        uses: appleboy/ssh-action@v1
        with:
          host: ${{ env.REMOTE_HOST }}
          username: linuxserver.io
@@ -104,7 +104,7 @@ jobs:
          script: whoami

      - name: wrong password but correct key
-        uses: appleboy/ssh-action@v1.2.2
+        uses: appleboy/ssh-action@v1
        with:
          host: ${{ env.REMOTE_HOST }}
          username: linuxserver.io
@@ -114,7 +114,7 @@ jobs:
          script: whoami

      - name: correct password but wrong key
-        uses: appleboy/ssh-action@v1.2.2
+        uses: appleboy/ssh-action@v1
        with:
          host: ${{ env.REMOTE_HOST }}
          username: linuxserver.io
@@ -167,7 +167,7 @@ jobs:
          sleep 2

      - name: ssh key passphrase
-        uses: appleboy/ssh-action@v1.2.2
+        uses: appleboy/ssh-action@v1
        with:
          host: ${{ env.REMOTE_HOST }}
          username: linuxserver.io
@@ -179,7 +179,7 @@ jobs:
            ls -al

      - name: missing ssh key passphrase
-        uses: appleboy/ssh-action@v1.2.2
+        uses: appleboy/ssh-action@v1
        continue-on-error: true
        with:
          host: ${{ env.REMOTE_HOST }}
@@ -192,7 +192,7 @@ jobs:

      # https://github.com/appleboy/ssh-action/issues/75#issuecomment-668314271
      - name: Multiline SSH commands interpreted as single lines
-        uses: appleboy/ssh-action@v1.2.2
+        uses: appleboy/ssh-action@v1
        with:
          host: ${{ env.REMOTE_HOST }}
          username: linuxserver.io
@@ -269,7 +269,7 @@ jobs:

      # https://github.com/appleboy/ssh-action/issues/85
      - name: Deployment to multiple hosts with different ports
-        uses: appleboy/ssh-action@v1.2.2
+        uses: appleboy/ssh-action@v1
        with:
          host: "${{ env.REMOTE_HOST_01 }}:2222,${{ env.REMOTE_HOST_02 }}:2222"
          username: linuxserver.io
@@ -322,7 +322,7 @@ jobs:
          sleep 2

      - name: testing id_ed25519 key
-        uses: appleboy/ssh-action@v1.2.2
+        uses: appleboy/ssh-action@v1
        with:
          host: ${{ env.REMOTE_HOST }}
          username: linuxserver.io
@@ -375,7 +375,7 @@ jobs:
          sleep 2

      - name: testing id_ed25519 key
-        uses: appleboy/ssh-action@v1.2.2
+        uses: appleboy/ssh-action@v1
        with:
          host: ${{ env.REMOTE_HOST }}
          username: linuxserver.io
@@ -386,7 +386,7 @@ jobs:
            ls -al

      - name: pass environment
-        uses: appleboy/ssh-action@v1.2.2
+        uses: appleboy/ssh-action@v1
        env:
          FOO: "BAR"
        with:
@@ -400,7 +400,7 @@ jobs:
            echo "I am $BAR, thanks"

      - name: pass multiple environment
-        uses: appleboy/ssh-action@v1.2.2
+        uses: appleboy/ssh-action@v1
        env:
          FOO: "BAR"
          BAR: "FOO"
@@ -419,7 +419,7 @@ jobs:
            echo "port: $PORT"

      - name: custom envs format
-        uses: appleboy/ssh-action@v1.2.2
+        uses: appleboy/ssh-action@v1
        env:
          FOO: "BAR"
          AAA: "BBB"
@@ -437,7 +437,7 @@ jobs:
            echo "I am $TEST_AAA, thanks"

      - name: pass all ENV variables to script
-        uses: appleboy/ssh-action@v1.2.2
+        uses: appleboy/ssh-action@v1
        env:
          INPUT_FOO: "BAR"
          INPUT_AAA: "BBB"
@@ -454,7 +454,7 @@ jobs:
            echo "$GITHUB_REF"

      - name: switch to root user
-        uses: appleboy/ssh-action@v1.2.2
+        uses: appleboy/ssh-action@v1
        with:
          host: ${{ env.REMOTE_HOST }}
          username: linuxserver.io
--- a/.goreleaser.yaml
+++ b/.goreleaser.yaml
@@ -24,5 +24,5 @@ changelog:
      order: 4
    - title: "Documentation updates"
      regexp: ^.*?docs?(\(.+\))??!?:.+$
-      order: 4
+      order: 5
    - title: Others
--- a/README.md
+++ b/README.md
@@ -65,7 +65,7 @@ jobs:
    runs-on: ubuntu-latest
    steps:
      - name: executing remote ssh commands using password
-        uses: appleboy/ssh-action@v1.2.2
+        uses: appleboy/ssh-action@v1
        with:
          host: ${{ secrets.HOST }}
          username: linuxserver.io
@@ -183,7 +183,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"

 ```yaml
 - name: executing remote ssh commands using password
-  uses: appleboy/ssh-action@v1.2.2
+  uses: appleboy/ssh-action@v1
  with:
    host: ${{ secrets.HOST }}
    username: ${{ secrets.USERNAME }}
@@ -196,7 +196,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"

 ```yaml
 - name: executing remote ssh commands using ssh key
-  uses: appleboy/ssh-action@v1.2.2
+  uses: appleboy/ssh-action@v1
  with:
    host: ${{ secrets.HOST }}
    username: ${{ secrets.USERNAME }}
@@ -209,7 +209,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"

 ```yaml
 - name: multiple command
-  uses: appleboy/ssh-action@v1.2.2
+  uses: appleboy/ssh-action@v1
  with:
    host: ${{ secrets.HOST }}
    username: ${{ secrets.USERNAME }}
@@ -226,7 +226,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"

 ```yaml
 - name: file commands
-  uses: appleboy/ssh-action@v1.2.2
+  uses: appleboy/ssh-action@v1
  with:
    host: ${{ secrets.HOST }}
    username: ${{ secrets.USERNAME }}
@@ -239,7 +239,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"

 ```diff
  - name: multiple host
-    uses: appleboy/ssh-action@v1.2.2
+    uses: appleboy/ssh-action@v1
    with:
 -     host: "foo.com"
 +     host: "foo.com,bar.com"
@@ -257,7 +257,7 @@ The default value of `port` is `22`.

 ```diff
  - name: multiple host
-    uses: appleboy/ssh-action@v1.2.2
+    uses: appleboy/ssh-action@v1
    with:
 -     host: "foo.com"
 +     host: "foo.com:1234,bar.com:5678"
@@ -272,7 +272,7 @@ The default value of `port` is `22`.

 ```diff
  - name: multiple host
-    uses: appleboy/ssh-action@v1.2.2
+    uses: appleboy/ssh-action@v1
    with:
      host: "foo.com,bar.com"
 +     sync: true
@@ -288,7 +288,7 @@ The default value of `port` is `22`.

 ```diff
  - name: pass environment
-    uses: appleboy/ssh-action@v1.2.2
+    uses: appleboy/ssh-action@v1
 +   env:
 +     FOO: "BAR"
 +     BAR: "FOO"
@@ -335,7 +335,7 @@ Host FooServer

 ```diff
  - name: ssh proxy command
-    uses: appleboy/ssh-action@v1.2.2
+    uses: appleboy/ssh-action@v1
    with:
      host: ${{ secrets.HOST }}
      username: ${{ secrets.USERNAME }}
@@ -358,7 +358,7 @@ It is not uncommon for files to leak from backups or decommissioned hardware, an

 ```diff
  - name: ssh key passphrase
-    uses: appleboy/ssh-action@v1.2.2
+    uses: appleboy/ssh-action@v1
    with:
      host: ${{ secrets.HOST }}
      username: ${{ secrets.USERNAME }}
@@ -384,7 +384,7 @@ Now you can adjust you config:

 ```diff
  - name: ssh key passphrase
-    uses: appleboy/ssh-action@v1.2.2
+    uses: appleboy/ssh-action@v1
    with:
      host: ${{ secrets.HOST }}
      username: ${{ secrets.USERNAME }}
--- a/README.zh-cn.md
+++ b/README.zh-cn.md
@@ -65,7 +65,7 @@ jobs:
    runs-on: ubuntu-latest
    steps:
      - name: executing remote ssh commands using password
-        uses: appleboy/ssh-action@v1.2.2
+        uses: appleboy/ssh-action@v1
        with:
          host: ${{ secrets.HOST }}
          username: linuxserver.io
@@ -183,7 +183,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"

 ```yaml
 - name: executing remote ssh commands using password
-  uses: appleboy/ssh-action@v1.2.2
+  uses: appleboy/ssh-action@v1
  with:
    host: ${{ secrets.HOST }}
    username: ${{ secrets.USERNAME }}
@@ -196,7 +196,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"

 ```yaml
 - name: executing remote ssh commands using ssh key
-  uses: appleboy/ssh-action@v1.2.2
+  uses: appleboy/ssh-action@v1
  with:
    host: ${{ secrets.HOST }}
    username: ${{ secrets.USERNAME }}
@@ -209,7 +209,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"

 ```yaml
 - name: multiple command
-  uses: appleboy/ssh-action@v1.2.2
+  uses: appleboy/ssh-action@v1
  with:
    host: ${{ secrets.HOST }}
    username: ${{ secrets.USERNAME }}
@@ -226,7 +226,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"

 ```yaml
 - name: file commands
-  uses: appleboy/ssh-action@v1.2.2
+  uses: appleboy/ssh-action@v1
  with:
    host: ${{ secrets.HOST }}
    username: ${{ secrets.USERNAME }}
@@ -239,7 +239,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"

 ```diff
  - name: multiple host
-    uses: appleboy/ssh-action@v1.2.2
+    uses: appleboy/ssh-action@v1
    with:
 -     host: "foo.com"
 +     host: "foo.com,bar.com"
@@ -257,7 +257,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"

 ```diff
  - name: multiple host
-    uses: appleboy/ssh-action@v1.2.2
+    uses: appleboy/ssh-action@v1
    with:
 -     host: "foo.com"
 +     host: "foo.com:1234,bar.com:5678"
@@ -272,7 +272,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"

 ```diff
  - name: multiple host
-    uses: appleboy/ssh-action@v1.2.2
+    uses: appleboy/ssh-action@v1
    with:
      host: "foo.com,bar.com"
 +     sync: true
@@ -288,7 +288,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"

 ```diff
  - name: pass environment
-    uses: appleboy/ssh-action@v1.2.2
+    uses: appleboy/ssh-action@v1
 +   env:
 +     FOO: "BAR"
 +     BAR: "FOO"
@@ -335,7 +335,7 @@ Host FooServer

 ```diff
  - name: ssh proxy command
-    uses: appleboy/ssh-action@v1.2.2
+    uses: appleboy/ssh-action@v1
    with:
      host: ${{ secrets.HOST }}
      username: ${{ secrets.USERNAME }}
@@ -356,7 +356,7 @@ Host FooServer

 ```diff
  - name: ssh key passphrase
-    uses: appleboy/ssh-action@v1.2.2
+    uses: appleboy/ssh-action@v1
    with:
      host: ${{ secrets.HOST }}
      username: ${{ secrets.USERNAME }}
@@ -382,7 +382,7 @@ ssh example.com ssh-keygen -l -f /etc/ssh/ssh_host_ed25519_key.pub | cut -d ' '

 ```diff
  - name: ssh key passphrase
-    uses: appleboy/ssh-action@v1.2.2
+    uses: appleboy/ssh-action@v1
    with:
      host: ${{ secrets.HOST }}
      username: ${{ secrets.USERNAME }}
--- a/README.zh-tw.md
+++ b/README.zh-tw.md
@@ -65,7 +65,7 @@ jobs:
    runs-on: ubuntu-latest
    steps:
      - name: executing remote ssh commands using password
-        uses: appleboy/ssh-action@v1.2.2
+        uses: appleboy/ssh-action@v1
        with:
          host: ${{ secrets.HOST }}
          username: linuxserver.io
@@ -181,7 +181,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"

 ```yaml
 - name: executing remote ssh commands using password
-  uses: appleboy/ssh-action@v1.2.2
+  uses: appleboy/ssh-action@v1
  with:
    host: ${{ secrets.HOST }}
    username: ${{ secrets.USERNAME }}
@@ -194,7 +194,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"

 ```yaml
 - name: executing remote ssh commands using ssh key
-  uses: appleboy/ssh-action@v1.2.2
+  uses: appleboy/ssh-action@v1
  with:
    host: ${{ secrets.HOST }}
    username: ${{ secrets.USERNAME }}
@@ -207,7 +207,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"

 ```yaml
 - name: multiple command
-  uses: appleboy/ssh-action@v1.2.2
+  uses: appleboy/ssh-action@v1
  with:
    host: ${{ secrets.HOST }}
    username: ${{ secrets.USERNAME }}
@@ -224,7 +224,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"

 ```yaml
 - name: file commands
-  uses: appleboy/ssh-action@v1.2.2
+  uses: appleboy/ssh-action@v1
  with:
    host: ${{ secrets.HOST }}
    username: ${{ secrets.USERNAME }}
@@ -237,7 +237,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"

 ```diff
  - name: multiple host
-    uses: appleboy/ssh-action@v1.2.2
+    uses: appleboy/ssh-action@v1
    with:
 -     host: "foo.com"
 +     host: "foo.com,bar.com"
@@ -253,7 +253,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"

 ```diff
  - name: multiple host
-    uses: appleboy/ssh-action@v1.2.2
+    uses: appleboy/ssh-action@v1
    with:
 -     host: "foo.com"
 +     host: "foo.com:1234,bar.com:5678"
@@ -268,7 +268,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"

 ```diff
  - name: multiple host
-    uses: appleboy/ssh-action@v1.2.2
+    uses: appleboy/ssh-action@v1
    with:
      host: "foo.com,bar.com"
 +     sync: true
@@ -284,7 +284,7 @@ ssh-keygen -t ed25519 -a 200 -C "your_email@example.com"

 ```diff
  - name: pass environment
-    uses: appleboy/ssh-action@v1.2.2
+    uses: appleboy/ssh-action@v1
 +   env:
 +     FOO: "BAR"
 +     BAR: "FOO"
@@ -331,7 +331,7 @@ Host FooServer

 ```diff
  - name: ssh proxy command
-    uses: appleboy/ssh-action@v1.2.2
+    uses: appleboy/ssh-action@v1
    with:
      host: ${{ secrets.HOST }}
      username: ${{ secrets.USERNAME }}
@@ -352,7 +352,7 @@ Host FooServer

 ```diff
  - name: ssh key passphrase
-    uses: appleboy/ssh-action@v1.2.2
+    uses: appleboy/ssh-action@v1
    with:
      host: ${{ secrets.HOST }}
      username: ${{ secrets.USERNAME }}
@@ -378,7 +378,7 @@ ssh example.com ssh-keygen -l -f /etc/ssh/ssh_host_ed25519_key.pub | cut -d ' '

 ```diff
  - name: ssh key passphrase
-    uses: appleboy/ssh-action@v1.2.2
+    uses: appleboy/ssh-action@v1
    with:
      host: ${{ secrets.HOST }}
      username: ${{ secrets.USERNAME }}
--- a/entrypoint.sh
+++ b/entrypoint.sh
@@ -10,68 +10,44 @@ GITHUB_ACTION_PATH="${GITHUB_ACTION_PATH%/}"
 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}"

-function detect_client_info() {
-  if [ -n "${SSH_CLIENT_OS-}" ]; then
-    CLIENT_PLATFORM="${SSH_CLIENT_OS}"
-  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
+function log_error() {
+  echo "$1" >&2
+  exit "$2"
+}

-  if [ -n "${SSH_CLIENT_ARCH-}" ]; then
-    CLIENT_ARCH="${SSH_CLIENT_ARCH}"
-  else
-    local machine
-    machine="$(uname -m)"
-    case "${machine}" in
-    x86_64* | i?86_64* | amd64*)
-      CLIENT_ARCH="amd64"
-      ;;
-    aarch64* | arm64*)
-      CLIENT_ARCH="arm64"
-      ;;
-    *)
-      echo "Unknown, unsupported architecture (${machine})." >&2
-      echo "Supported architectures x86_64, i686, arm64." >&2
-      echo "Bailing out." >&2
-      exit 3
-      ;;
-    esac
-  fi
+function detect_client_info() {
+  CLIENT_PLATFORM="${SSH_CLIENT_OS:-$(uname -s | tr '[:upper:]' '[:lower:]')}"
+  CLIENT_ARCH="${SSH_CLIENT_ARCH:-$(uname -m)}"
+
+  case "${CLIENT_PLATFORM}" in
+  darwin | linux | windows) ;;
+  *) log_error "Unknown or unsupported platform: ${CLIENT_PLATFORM}. Supported platforms are Linux, Darwin, and Windows." 2 ;;
+  esac
+
+  case "${CLIENT_ARCH}" in
+  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 ;;
+  esac
 }

 detect_client_info
 DOWNLOAD_URL_PREFIX="${DRONE_SSH_RELEASE_URL}/v${DRONE_SSH_VERSION}"
 CLIENT_BINARY="drone-ssh-${DRONE_SSH_VERSION}-${CLIENT_PLATFORM}-${CLIENT_ARCH}"
 TARGET="${GITHUB_ACTION_PATH}/${CLIENT_BINARY}"
-echo "Will download ${CLIENT_BINARY} from ${DOWNLOAD_URL_PREFIX}"
-curl -fsSL --retry 5 --keepalive-time 2 "${DOWNLOAD_URL_PREFIX}/${CLIENT_BINARY}" -o ${TARGET}
-chmod +x ${TARGET}
+echo "Downloading ${CLIENT_BINARY} from ${DOWNLOAD_URL_PREFIX}"
+curl -fsSL --retry 5 --keepalive-time 2 "${DOWNLOAD_URL_PREFIX}/${CLIENT_BINARY}" -o "${TARGET}"
+chmod +x "${TARGET}"

-echo "======= CLI Version ======="
-sh -c "${TARGET} --version" # print version
-echo "==========================="
-if [[ "$INPUT_CAPTURE_STDOUT" == 'true' ]]; then
-  echo 'stdout<<EOF' >>$GITHUB_OUTPUT          # use heredoc for multiline output
-  sh -c "${TARGET} $*" | tee -a $GITHUB_OUTPUT # run the command
-  echo 'EOF' >>$GITHUB_OUTPUT
+echo "======= CLI Version Information ======="
+"${TARGET}" --version
+echo "======================================="
+if [[ "${INPUT_CAPTURE_STDOUT}" == 'true' ]]; then
+  {
+    echo 'stdout<<EOF'
+    "${TARGET}" "$@" | tee -a "${GITHUB_OUTPUT}"
+    echo 'EOF'
+  } >>"${GITHUB_OUTPUT}"
 else
-  sh -c "${TARGET} $*" # run the command
+  "${TARGET}" "$@"
 fi
Author	SHA1	Message	Date
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