GitHub Action SCP 项目使用教程-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00657/article/details/147347584

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/: 存放 GitHub Actions 工作流文件的目录。
- workflows/: 工作流文件所在的子目录。
dist/: 可能包含编译后的代码或生产环境下的文件。
lib/: 存放项目库文件的目录。
src/: 存放项目源代码的目录。
.gitignore: 指定 Git 忽略的文件和目录。
.node-version: 指定项目使用的 Node.js 版本。
.prettierignore: 指定 Prettier 忽略的文件和目录。
.prettierrc.json: Prettier 的配置文件。
LICENSE: 项目使用的许可证文件。
action.yml: GitHub Action 的配置文件。
package-lock.json: 包版本锁定文件。
package.json: 项目包管理配置文件。
readme.md: 项目说明文件。
result.png: 可能是项目示例或结果的图片文件。
tsconfig.json: TypeScript 的配置文件。

2. 项目的启动文件介绍

项目的启动主要通过 GitHub Actions 进行，因此并没有传统意义上的启动文件。action.yml 文件是定义 GitHub Action 的主要配置文件，它描述了 Action 的输入、输出、秘密和环境变量等。

3. 项目的配置文件介绍

项目的配置主要通过 GitHub Actions 的工作流文件（.github/workflows 目录下的 YAML 文件）以及 GitHub 仓库的设置中的秘密（Secrets）进行。

工作流配置：在 .github/workflows 目录下的 YAML 文件中，可以定义工作流的触发条件、步骤等。以下是一个示例配置，它定义了一个在 Push 事件发生时自动执行的工作流：

name: Example Workflow

on: [push]

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v2

      - name: Set up Node.js
        uses: actions/setup-node@v2
        with:
          node-version: '14'

      - name: Copy folder to remote
        uses: garygrossgarten/github-action-scp@release
        with:
          local: 'path/to/local/folder'
          remote: 'path/to/remote/directory'
          host: '${{ secrets.HOST }}'
          username: '${{ secrets.SSH_USER }}'
          password: '${{ secrets.PASSWORD }}'