在myoung34/docker-github-actions-runner中配置支持Docker和Node.js的自托管Runner

背景介绍

myoung34/docker-github-actions-runner是一个用于创建GitHub自托管运行器的Docker镜像项目。自托管运行器允许开发者在自己的基础设施上执行GitHub Actions工作流，这对于需要特定环境或有特殊安全需求的项目非常有用。

常见配置问题

许多开发者在配置自托管运行器时会遇到两个主要问题：

1. Docker守护进程未运行
2. Node.js/npm命令未找到

这些问题通常是由于基础镜像配置不足或启动参数不正确导致的。

解决方案

Docker守护进程支持

要使自托管运行器支持Docker操作，需要以下配置：

1. 在运行容器时添加--privileged标志，这允许容器访问主机设备并运行Docker守护进程
2. 设置环境变量START_DOCKER_SERVICE=true，这会自动启动容器内的Docker服务

示例Docker运行命令：

docker run -d --privileged -e START_DOCKER_SERVICE=true myoung34/github-runner:latest

Node.js/npm支持

基础镜像默认不包含Node.js环境，可以通过以下方式添加：

1. 在Dockerfile中使用nvm安装Node.js：

RUN curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.0/install.sh | bash \
    && export NVM_DIR="$HOME/.nvm" \
    && [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" \
    && nvm install 20 \
    && npm i -g npm@8

2. 或者在工作流中使用actions/setup-node动作临时安装Node.js：

steps:
  - uses: actions/setup-node@v4
    with:
      node-version: 18

最佳实践建议

1. 使用官方镜像：建议直接使用myoung34/github-runner:latest作为基础镜像，而不是从base镜像开始构建，除非有特殊需求。

2. 分层构建：如果需要定制化环境，建议创建自己的Dockerfile，基于官方镜像添加所需工具。

3. 最小化安装：只安装工作流真正需要的工具，保持镜像轻量。

4. 日志检查：遇到问题时，首先检查容器日志，通常能快速定位问题原因。

验证方法

可以通过以下工作流验证配置是否正确：

jobs:
  test-docker:
    runs-on: self-hosted
    steps:
      - uses: gruntwork-io/terragrunt-action@v2
        with:
          tf_version: 1.5.0

  test-node:
    runs-on: self-hosted
    steps:
      - uses: actions/setup-node@v4
        with:
          node-version: 18
      - uses: creyD/prettier_action@v4.3

如果这两个工作流都能正常运行，说明自托管运行器已正确配置Docker和Node.js环境。

总结

配置支持Docker和Node.js的GitHub自托管运行器需要注意几个关键点：特权模式运行容器、正确设置Docker服务启动环境变量、以及合理安装Node.js环境。遵循这些实践可以确保自托管运行器能够顺利执行各种GitHub Actions工作流。