dysnix/github-actions-runner

github-actions-runner

镜像概述

github-actions-runner 是一个容器化的 GitHub Actions Runner 镜像，基于 https://github.com/actions/runner 构建。该镜像旨在提供容器化的运行环境，以便在 Docker 中部署和使用 GitHub Actions Runner，同时复用 GitHub 托管 runner 项目中的安装脚本，简化环境配置流程。

核心功能与特性

• 复用官方安装脚本：支持使用 https://github.com/actions/virtual-environments 中的安装器脚本（位于 https://github.com/actions/virtual-environments/tree/main/images/linux/scripts/installers），减少环境配置工作量。
• 动态配置支持：通过环境变量动态配置 Runner，环境变量以 ACTIONS_RUNNER_INPUT_ 为前缀，覆盖 Runner 的核心配置参数。
• 包安装能力：提供 install-from-virtual-env 命令，可直接运行官方安装器脚本安装所需软件包。
• 容器化适配：针对 Docker 容器环境优化，规避部分在真实 VM 中适用但容器中不兼容的操作（如 snap 包安装）。

使用场景

• 需在 Docker 环境中运行 GitHub Actions 工作流的 CI/CD 场景。
• 需要自定义 Runner 环境（如安装特定版本软件包）的自动化流程。
• 希望复用 GitHub 官方虚拟环境配置，减少环境差异的场景。

配置说明

环境变量配置

Runner 支持通过环境变量动态配置，变量名以 ACTIONS_RUNNER_INPUT_ 为前缀，对应 Runner 的配置参数：

示例：设置自定义标签

bash
export ACTIONS_RUNNER_INPUT_LABELS="foobar,1234"

安装软件包

通过 install-from-virtual-env 命令可运行官方安装器脚本安装软件包，语法为：

bash
install-from-virtual-env <installer-file-name>

示例：安装 Node.js（对应安装器脚本 https://github.com/actions/virtual-environments/blob/main/images/linux/scripts/installers/nodejs.sh）

bash
install-from-virtual-env nodejs

使用方法

Docker 运行示例

通过 docker run 命令启动容器化 Runner，需指定仓库 URL 和注册令牌（可从 GitHub 仓库的「Settings > Actions > Runners」获取）：

bash
docker run -d \
  -e ACTIONS_RUNNER_INPUT_URL="https://github.com/your-username/your-repo" \
  -e ACTIONS_RUNNER_INPUT_TOKEN="your-registration-token" \
  -e ACTIONS_RUNNER_INPUT_LABELS="custom-label,linux-x64" \
  docker.xuanyuan.run/dysnix/github-actions-runner

自定义安装包示例

如需在启动时预装软件包，可通过 Dockerfile 扩展基础镜像：

dockerfile
FROM docker.xuanyuan.run/dysnix/github-actions-runner

# 安装 Node.js 和 Python
RUN install-from-virtual-env nodejs && \
    install-from-virtual-env python

构建并运行自定义镜像：

bash
docker build -t custom-github-runner .
docker run -d \
  -e ACTIONS_RUNNER_INPUT_URL="https://github.com/your-username/your-repo" \
  -e ACTIONS_RUNNER_INPUT_TOKEN="your-registration-token" \
  docker.xuanyuan.run/custom-github-runner

注意事项

• 部分官方安装器脚本（如涉及 snap 包安装）可能因 Docker 环境限制而失败，需手动排查或替换为容器兼容的安装方式。
• 注册令牌（--token）具有时效性，需从 GitHub 仓库实时获取并更新。
• 运行容器时建议挂载持久化卷以保留工作目录数据，避免容器重启后数据丢失。