allenevans/github-self-hosted-runner

GitHub自托管Actions Runner

Docker化的GitHub自托管Runner，允许在本地自管理的Docker容器中运行GitHub Actions流水线。

核心功能

• 控制构建环境依赖（例如使用特定版本的Terraform）
• 不消耗GitHub构建分钟数
• 适用于长时间运行的流程

注意事项

• 运行之间工作区可能未清理，旧工件可能干扰构建
• 当前需通过UI配置令牌（可参考生成Runner令牌的API）
• 生成的API令牌可能不总是正确，若Runner无法连接，需停止Runner并重新生成令牌尝试

快速开始

最快启动自托管Runner的方式是使用Docker Hub镜像：

shell
export GITHUB_TOKEN=<你的GitHub令牌>; 
export REPOSITORY=<你的组织/仓库>;

docker run -it --rm -e GITHUB_TOKEN=${GITHUB_TOKEN} -e REPOSITORY=${REPOSITORY} allenevans/github-self-hosted-runner:latest

启动后，可访问https://github.com/<你的组织/仓库>/settings/actions验证Runner注册状态。

环境变量

NPM脚本

构建
本地构建Docker镜像

shell
npm run build

启动
以detached模式运行Runner容器

shell
GITHUB_TOKEN=... REPOSITORY=... npm start

日志
查看容器日志

shell
npm run logs

停止
终止Runner容器

shell
npm run stop

工作区清理

本地Runner需手动清理工作区（GitHub托管Runner无需此操作），可在流水线中添加以下步骤：

steps:
  # 清理工作区（仅自托管Runner）
  - name: 清理工作区
    run: rm -rf $RUNNER_WORK_DIRECTORY/* || true

  # 清除遗留标签并更新代码
  - name: 清理检出
    run: |
      for tag in `git tag -l`; do git tag -d $tag; done
      git fetch && git fetch -t && git checkout ${{github.head_ref}}