action-upterm 项目使用教程

1. 项目目录结构及介绍

action-upterm 项目的主要目录结构如下：

• .github/：存放与 GitHub Actions 相关的配置文件。
• lib/：包含项目的库文件。
• scripts/：存放项目相关的脚本文件。
• src/：源代码目录，包含项目的核心功能代码。
• .gitignore：定义 Git 忽略的文件列表。
• LICENSE：项目使用的许可证文件。
• README.md：项目的说明文档。
• action.yml：GitHub Action 的配置文件。
• babel.config.js：Babel 的配置文件。
• jest.config.js：Jest 测试框架的配置文件。
• package.json：项目依赖和脚本配置文件。

2. 项目的启动文件介绍

项目的启动主要是通过 GitHub Actions 来完成的，其中主要的启动文件是 .github/workflows 目录下的 YAML 文件。以下是启动文件的基本结构：

name: CI

on:
  push:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Setup upterm session
        uses: lhotari/action-upterm@v1

这个 YAML 文件定义了一个 GitHub Actions 工作流，它会在代码 push 时触发。工作流包含一个名为 build 的任务，该任务会在最新的 Ubuntu 虚拟环境上运行。任务中包含两个步骤，第一步是使用 actions/checkout@v2 来检出代码，第二步是设置 upterm 会话。

3. 项目的配置文件介绍

项目的配置文件主要是 action.yml，该文件定义了 GitHub Action 的具体配置。以下是一个配置文件的示例：

name: 'CI'

on: [push]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: lhotari/action-upterm@v1
        with:
          limit-access-to-actor: true
          upterm-server: 'wss://YOUR_HEROKU_APP_URL'
          wait-timeout-minutes: 5

在这个配置文件中：

• name 定义了工作流的名称。
• on 指定了触发工作流的条件，这里是在 push 操作时触发。
• jobs 定义了要执行的作业列表，这里有一个名为 build 的作业。
• build 作业中的 runs-on 指定了运行作业的虚拟机环境。
• steps 列表定义了作业中的步骤，包括检出代码和使用 action-upterm。

配置文件允许你自定义很多选项，如限制 SSH 访问、指定 Upterm 服务器地址以及设置超时时间等。