GitHub Runner 自定义部署教程

GitHub Runner 自定义部署教程

github-runner项目地址:https://gitcode.com/gh_mirrors/gi/github-runner

项目概述

GitHub Runner 是一个用于在自定义环境执行GitHub Actions的工作器。通过本项目 https://github.com/SanderKnape/github-runner，您可以设置自己的运行环境来执行自动化任务。本教程将引导您了解其核心目录结构、启动机制以及配置方式。

---

1. 项目目录结构及介绍

GitHub Runner 的目录结构组织得清晰有序，便于管理和自定义：

github-runner/
│
├── config  
│   └── runner.config.json     <- 配置文件，定义Runner的行为和属性。
├── scripts
│   ├── entrypoint.sh          <- 入口脚本，启动时执行。
│   └── run-action.sh          <- 运行Action的主要脚本。
├── external-modules           <- 可选，存放外部依赖或自定义模块。
├── runner                     <- 核心二进制文件所在目录。
│   └── config.toml.example    <- 示例配置文件，了解配置项。
├── README.md                  <- 项目说明文档。
├── install.sh                 <- 用于部署Runner的安装脚本。
└── ...

• config: 包含Runner的具体配置文件，其中runner.config.json是关键，定义了如何与GitHub进行交互等核心参数。
• scripts: 存放启动和执行流程中的脚本，比如自定义逻辑可以在这里集成。
• external-modules: 提供扩展功能的位置，非必需。
• runner: 包含Runner应用程序的核心部分，包括可执行文件及其示例配置。

---

2. 项目的启动文件介绍

主要的启动逻辑由install.sh脚本处理，它负责初始化环境并准备Runner。不过，实际的运行控制是通过entrypoint.sh脚本实现的。简而言之：

• install.sh: 是部署步骤的向导，自动下载必要的组件并完成初步的设置工作。
• entrypoint.sh: 系统级入口脚本，确保环境准备无误后调用GitHub Action的工作流执行程序。它是衔接系统和Runner内核的关键。

---

3. 项目的配置文件介绍

3.1 runner.config.json

这是自定义Runner行为的核心，其中可以设置以下重要属性：

{
  "name": "Your-Runner-Name",
  "workDirectory": "/path/to/work",
  "labels": ["label1", "label2"],
  " consequat": "Environment specific settings...",
}

• name: 跑步者的名字，便于识别。
• workDirectory: 指定工作的根目录，Action在此目录下执行。
• labels: 分配给Runner的标签，用于筛选匹配特定标签的Actions。

3.2 config.toml.example

虽然直接修改这个文件不是推荐的做法（应使用runner.config.json），但config.toml.example提供了配置GitHub Runner的详细示例，涵盖了从认证到运行策略的各种选项，对于深入理解Runner内部运作非常有帮助。

---

通过以上指导，您可以有效地理解和配置您的GitHub Runner，从而根据需求定制执行环境，以适应不同的自动化场景。记得根据实际情况调整配置，确保与GitHub仓库中的Actions兼容。

github-runner项目地址:https://gitcode.com/gh_mirrors/gi/github-runner