SSH Deploy 项目使用教程

1. 项目目录结构及介绍

ssh-deploy/
├── .github/
│   └── workflows/
│       └── e2e.yml
├── dist/
├── docs/
├── src/
│   ├── index.js
│   ├── deploy.js
│   └── utils.js
├── test/
│   └── deploy.test.js
├── .editorconfig
├── .eslintrc.js
├── .gitignore
├── .releaserc
├── LICENSE
├── README.md
├── action.yml
├── package-lock.json
└── package.json

目录结构说明

• .github/workflows/: 包含GitHub Actions的工作流配置文件，例如e2e.yml用于端到端测试。
• dist/: 编译后的文件存放目录。
• docs/: 项目文档存放目录。
• src/: 源代码目录，包含主要的JavaScript文件。
• test/: 测试文件存放目录，包含单元测试和集成测试文件。
• .editorconfig: 编辑器配置文件，用于统一代码风格。
• .eslintrc.js: ESLint配置文件，用于代码检查。
• .gitignore: Git忽略文件配置。
• .releaserc: 发布配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• action.yml: GitHub Actions的配置文件，定义了Action的输入、输出和运行步骤。
• package-lock.json: 锁定依赖版本的文件。
• package.json: 项目依赖和脚本配置文件。

2. 项目启动文件介绍

src/index.js

这是项目的入口文件，负责初始化配置和启动部署流程。主要功能包括：

• 读取环境变量配置。
• 初始化SSH连接。
• 执行rsync命令进行文件同步。
• 执行远程脚本（可选）。

src/deploy.js

这个文件包含了实际的部署逻辑，主要功能包括：

• 处理rsync命令的参数。
• 执行rsync命令。
• 处理远程脚本的执行。

src/utils.js

这个文件包含了项目中使用的工具函数，例如：

• 处理SSH连接的工具函数。
• 处理环境变量的工具函数。

3. 项目的配置文件介绍

action.yml

这是GitHub Actions的配置文件，定义了Action的输入、输出和运行步骤。主要配置项包括：

• inputs: 定义了Action的输入参数，例如SSH_PRIVATE_KEY、REMOTE_HOST等。
• runs: 定义了Action的运行步骤，通常包括安装依赖、执行部署脚本等。

package.json

这是Node.js项目的配置文件，包含了项目的依赖、脚本和元数据。主要配置项包括：

• scripts: 定义了项目的脚本命令，例如build、test等。
• dependencies: 定义了项目依赖的npm包。
• devDependencies: 定义了开发依赖的npm包。

.github/workflows/e2e.yml

这是GitHub Actions的工作流配置文件，用于端到端测试。主要配置项包括：

• on: 定义了触发工作流的事件，例如push、pull_request等。
• jobs: 定义了工作流的任务，例如build、test等。

通过以上配置文件和目录结构，您可以快速了解并使用ssh-deploy项目进行代码的部署。