【亲测免费】 action-tmate 项目教程

1. 项目的目录结构及介绍

action-tmate 项目的目录结构如下：

action-tmate/
├── docs/
│   └── ...
├── lib/
│   └── ...
├── src/
│   └── ...
├── .gitignore
├── LICENSE
├── README.md
├── RELEASE.md
├── _config.yml
├── action.yml
├── babel.config.js
├── jest.config.js
├── package-lock.json
└── package.json

目录结构介绍

• docs/: 存放项目的文档文件。
• lib/: 存放编译后的 JavaScript 文件。
• src/: 存放项目的源代码文件。
• .gitignore: 指定 Git 版本控制系统忽略的文件和目录。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍和使用说明。
• RELEASE.md: 项目的发布说明。
• _config.yml: 项目的配置文件。
• action.yml: GitHub Actions 的工作流配置文件。
• babel.config.js: Babel 的配置文件，用于 JavaScript 的编译。
• jest.config.js: Jest 测试框架的配置文件。
• package-lock.json: 锁定项目依赖的版本。
• package.json: 项目的依赖和脚本配置文件。

2. 项目的启动文件介绍

action-tmate 项目的启动文件是 action.yml，它定义了 GitHub Actions 的工作流配置。以下是 action.yml 的主要内容：

name: CI
on: [push]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Setup tmate session
        uses: mxschmitt/action-tmate@v3

启动文件介绍

• name: 定义工作流的名称。
• on: 定义触发工作流的事件，这里是 push 事件。
• jobs: 定义工作流中的任务。
  • build: 任务的名称。
    • runs-on: 指定任务运行的操作系统，这里是 ubuntu-latest。
    • steps: 定义任务中的步骤。
      • uses: 使用 actions/checkout@v4 动作来检出代码。
      • name: 步骤的名称。
      • uses: 使用 mxschmitt/action-tmate@v3 动作来设置 tmate 会话。

3. 项目的配置文件介绍

action-tmate 项目的主要配置文件包括 action.yml 和 package.json。

action.yml

action.yml 是 GitHub Actions 的工作流配置文件，定义了如何启动和配置 tmate 会话。以下是 action.yml 的主要配置项：

name: CI
on: [push]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Setup tmate session
        uses: mxschmitt/action-tmate@v3
        with:
          detached: true
          sudo: false
          timeout-minutes: 15

配置项介绍

• detached: 是否启用分离模式，即在启动 tmate 会话后继续执行后续步骤。
• sudo: 是否使用 sudo 权限安装依赖。
• timeout-minutes: tmate 会话的超时时间，单位为分钟。

package.json

package.json 是 Node.js 项目的配置文件，定义了项目的依赖和脚本。以下是 package.json 的主要内容：

{
  "name": "action-tmate",
  "version": "3.0.0",
  "description": "Debug your GitHub Actions via SSH by using tmate to get access to the runner system itself",
  "main": "lib/index.js",
  "scripts": {
    "build": "tsc",
    "test": "jest"
  },
  "dependencies": {
    "@actions/core": "^1.2.6",
    "tmate": "^2.4.0"
  },
  "devDependencies": {
    "@types/jest": "^26.0.15",
    "jest": "^26.6.3",
    "typescript": "^4.0.5"
  }
}

配置项介绍

• name: 项目的名称。
• version: 项目的版本号。
• description: 项目的描述。
• main: 项目的入口文件。
• scripts: 定义项目的脚本命令。
  • build: 使用 TypeScript 编译项目。
  • test: 使用 Jest 运行测试。
• dependencies: 项目的生产环境依赖。
• devDependencies: 项目的开发环境依赖。