GitHub Action SCP 安装与配置指南

GitHub Action SCP 安装与配置指南

github-action-scp ⬆️ Copy a folder to a remote server using SSH 项目地址: https://gitcode.com/gh_mirrors/gi/github-action-scp

1. 项目基础介绍

github-action-scp 是一个简单的 GitHub Action，用于通过 SSH 将文件夹或单个文件从本地复制到远程服务器。这个项目可以与 GitHub Actions 工作流集成，使得自动化部署变得更加便捷。

该项目主要使用 JavaScript 和 TypeScript 编程语言。

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

• GitHub Actions：GitHub 提供的持续集成和持续部署服务。
• ssh2：一个纯 JavaScript 实现的 SSH2 客户端，通过 node-ssh 包使用。
• TypeScript：JavaScript 的一个超集，添加了静态类型选项。

3. 项目安装和配置准备工作

在开始安装和配置之前，请确保您已经具备以下条件：

• GitHub 帐户和相应的仓库。
• 对 GitHub Actions 有基本的了解。
• 具备基本的 SSH 连接和文件传输知识。
• 已在远程服务器上创建好 SSH 用户和对应的权限。

详细安装步骤

步骤 1：添加 Action 到您的项目

首先，在您的 GitHub 仓库中创建一个新的 GitHub Actions 工作流文件（例如 .github/workflows/copy-files.yml），或者在现有的工作流文件中添加以下步骤：

name: Copy Files to Remote

on: [push]  # 触发工作流的条件

jobs:
  copy:
    runs-on: ubuntu-latest  # 运行工作的虚拟机环境
    steps:
      - name: Checkout code
        uses: actions/checkout@v2

      - name: Copy folder content recursively to remote
        uses: garygrossgarten/github-action-scp@release
        with:
          local: './path/to/your/local/folder'  # 本地文件夹路径
          remote: 'path/to/remote/directory'  # 远程服务器目录路径
          host: '${{ secrets.REMOTE_HOST }}'  # 服务器地址
          username: '${{ secrets.REMOTE_USER }}'  # 服务器用户名
          password: '${{ secrets.REMOTE_PASSWORD }}'  # 服务器密码
          recursive: true  # 是否递归复制

步骤 2：设置秘密（Secrets）

在您的 GitHub 仓库的设置中，进入 Secrets 部分，并添加以下秘密：

• REMOTE_HOST：远程服务器的 IP 地址或域名。
• REMOTE_USER：用于连接远程服务器的用户名。
• REMOTE_PASSWORD：用于连接远程服务器的密码。

步骤 3：推送到仓库触发工作流

在完成工作流文件的编写和秘密的设置后，将更改推送到 GitHub 仓库。这将触发工作流，并自动执行文件复制任务。

确保您的工作流配置正确，否则可能会遇到连接问题或权限问题。如果出现错误，请检查工作流日志以获取更多信息，并根据需要进行调整。

以上就是 github-action-scp 的安装和配置指南。遵循上述步骤，您应该能够顺利地将本地文件通过 SSH 复制到远程服务器上。

github-action-scp ⬆️ Copy a folder to a remote server using SSH 项目地址: https://gitcode.com/gh_mirrors/gi/github-action-scp