优化GitHub Actions中SSH连接的重复配置问题

在持续集成/持续部署(CI/CD)流程中，使用SSH连接到远程服务器执行命令是一个常见需求。通过appleboy/ssh-action这个GitHub Action，我们可以方便地在工作流中执行SSH操作。然而，当需要在同一工作流中多次连接到同一服务器执行不同命令时，会出现配置重复的问题。

问题背景

在实际工作流中，我们经常需要将部署过程分解为多个步骤，例如：

1. 停止服务
2. 部署新版本
3. 启动服务
4. 运行测试

每个步骤都需要SSH连接到同一台服务器，但为了能够精确追踪哪个步骤失败，我们需要将它们分成独立的Action步骤。这导致了SSH连接配置（主机、用户名、密钥等）在每个步骤中重复出现，使得工作流文件冗长且难以维护。

解决方案

方法一：合并脚本内容

最简单直接的解决方案是将所有需要在远程服务器上执行的命令合并到一个脚本文件中。通过在脚本开头添加set -e指令，可以确保当任何命令失败时，脚本会立即退出，从而保留错误现场。

- uses: actions/appleboy/ssh-action@v1.0.3
  with:
    host: ${{ env.SSH_HOST }}
    username: ${{ env.SSH_USER }}
    key: ${{ secrets.TESTHOST_SSH_KEY }}
    script: |
      set -e
      ./step1.sh
      ./step3.sh
      ./step4.sh

这种方法减少了SSH连接次数，简化了工作流配置，同时通过set -e保证了错误处理能力。

方法二：使用script_file参数

当脚本内容较多时，可以将其保存为单独的文件，然后通过script_file参数引用：

- uses: actions/appleboy/ssh-action@v1.0.3
  with:
    host: ${{ env.SSH_HOST }}
    username: ${{ env.SSH_USER }}
    key: ${{ secrets.TESTHOST_SSH_KEY }}
    script_file: deploy_script.sh

这种方法使工作流文件更加清晰，同时便于脚本的版本控制和复用。

进阶建议

1. 错误处理增强：在合并的脚本中，除了使用set -e外，还可以添加错误处理和日志记录机制，便于问题排查。

2. 环境变量管理：将SSH连接参数存储在GitHub的环境变量或加密的Secrets中，提高安全性并便于统一管理。

3. 脚本模块化：对于复杂的部署流程，可以将不同功能的脚本分开维护，然后在主脚本中调用，保持代码的模块化和可维护性。

4. 连接复用：虽然appleboy/ssh-action目前不支持连接池或连接复用，但可以通过合并脚本减少连接次数来提高效率。

总结