github-action-ssh 的安装和配置教程

项目的基础介绍和主要的编程语言

github-action-ssh 是一个简单的 GitHub Action，用于通过 SSH 在远程服务器上运行命令。这个项目允许你在持续集成/持续部署 (CI/CD) 流程中自动化执行远程服务器上的任务。它使用的是 TypeScript 语言编写，同时也使用了 JavaScript。

项目使用的关键技术和框架

本项目使用以下技术和框架：

• GitHub Actions: GitHub 提供的自动化您的软件开发工作流程的工具。
• ssh2: 一个纯 JavaScript 实现的 SSH2 客户端模块。
• node-ssh: 一个基于 ssh2 的简单封装，使得通过 SSH 连接执行命令更加方便。

项目安装和配置的准备工作和详细的安装步骤

准备工作

在开始之前，请确保您已经满足以下条件：

1. 您有一个 GitHub 帐户。
2. 您熟悉基本的 Git 操作。
3. 您有一个远程服务器，并且可以访问它的 SSH。

安装步骤

1. 创建新的仓库或使用现有仓库

   首先，您需要在 GitHub 上创建一个新的仓库，或者使用现有的仓库。

2. 添加 GitHub Action 到您的仓库

   在您的仓库中，创建或修改 .github/workflows 目录下的一个 YAML 文件，用于定义您的 CI/CD 工作流。

   例如，创建一个名为 ssh.yml 的文件，内容如下：

   name: Run SSH Command
   
   on: [push]
   
   jobs:
     ssh-job:
       runs-on: ubuntu-latest
       steps:
         - name: Checkout code
           uses: actions/checkout@v2
   
         - name: Run SSH command
           uses: garygrossgarten/github-action-ssh@release
           with:
             command: 'ls -a'
             host: ${{ secrets.HOST }}
             username: ${{ secrets.USERNAME }}
             sshKey: ${{ secrets.SSH_KEY }}
   

3. 设置秘密

   为了安全地存储敏感信息，如服务器的 SSH 密钥，您需要在仓库的设置中添加秘密。

   • 转到您的 GitHub 仓库，点击 “Settings” > “Secrets”。
   • 点击 “Add a new secret”。
   • 添加以下秘密：
     • HOST: 远程服务器的 IP 或域名。
     • USERNAME: 用于 SSH 连接的用户名。
     • SSH_KEY: 您的 SSH 密钥。

4. 提交工作流文件

   将您创建的 ssh.yml 文件提交到 .github/workflows 目录，并推送到 GitHub 仓库。

   git add .github/workflows/ssh.yml
   git commit -m "Add SSH workflow"
   git push origin main
   

   请根据您的分支名称替换 main。

完成以上步骤后，每当您向仓库推送代码时，GitHub Actions 都会自动执行定义在 ssh.yml 文件中的工作流，通过 SSH 连接到您的远程服务器，并执行指定的命令。

请注意，上述步骤是一个简化的过程，实际部署时可能需要根据您的具体需求进行调整。