myoung34/github-runner

Docker GitHub Actions Runner

此镜像用于运行https://help.github.com/en/actions/automating-your-workflow-with-github-actions/hosting-your-own-runners%EF%BC%8C%E6%94%AF%E6%8C%81Docker-in-Docker%E5%8A%9F%E8%83%BD%EF%BC%8C%E5%8F%AF%E5%9C%A8%E8%87%AA%E5%AE%9A%E4%B9%89%E5%9F%BA%E7%A1%80%E8%AE%BE%E6%96%BD%E4%B8%8A%E6%89%A7%E8%A1%8CGitHub Actions工作流，提供灵活的配置选项和多平台支持。

快速开始（示例与用法）

详细使用说明请参见https://github.com/myoung34/docker-github-actions-runner/wiki/Usage%E3%80%82 贡献前请阅读https://github.com/myoung34/docker-github-actions-runner/blob/master/CONTRIBUTING.md%E3%80%82

包含的软件与配置

尽管本项目与上游软件并非完全一致，但包含的软件包等信息可在https://github.com/myoung34/docker-github-actions-runner/blob/master/build/config.json%E6%9F%A5%E7%9C%8B%E3%80%82%E7%9B%B8%E5%85%B3%E6%96%87%E6%A1%A3%E8%AF%B7%E5%8F%82%E8%A7%81https://github.com/myoung34/docker-github-actions-runner/wiki/Usage#modifications%E3%80%82

注意事项

安全性

已知环境变量存在被窃取的风险。如果使用此Runner，请确保所有工作流变更都通过验证流程（在Actions设置中）进行管控，以防止***PR窃取这些变量。

Docker支持

请注意，尽管此Runner安装并允许使用Docker，但GitHub Actions本身尚不支持在自托管Runner中使用Docker。更多信息：

• https://github.com/actions/runner/issues/406
• https://github.com/actions/runner/issues/367

此外，部分GitHub Actions工作流功能（如https://docs.github.com/en/actions/guides/about-service-containers%EF%BC%89%E6%97%A0%E6%B3%95%E4%BD%BF%E7%94%A8%EF%BC%8Chttps://github.com/myoung34/docker-github-actions-runner/issues/61%E3%80%82

Containerd支持

当前Runnerhttps://github.com/actions/runner/issues/1265。

Docker制品

这些容器通过GitHub Actions构建，https://github.com/myoung34/docker-github-actions-runner/blob/master/.github/workflows/deploy.yml#L47%E5%B9%B6%E4%BF%AE%E6%94%B9%60FROM%60%E6%8C%87%E4%BB%A4%E4%BB%A5%E7%AE%80%E5%8C%96%E6%9E%84%E5%BB%BA%E8%BF%87%E7%A8%8B%E3%80%82

环境变量

测试

测试使用https://github.com/goss-org/goss/%E7%BC%96%E5%86%99%E9%80%9A%E7%94%A8%E6%96%AD%E8%A8%80%E3%80%82%E6%89%80%E6%9C%89%E6%8B%89%E5%8F%96%E8%AF%B7%E6%B1%82%E9%9C%80%E5%8C%85%E5%90%AB%E7%9B%B8%E5%85%B3%E6%96%AD%E8%A8%80%E6%89%8D%E8%83%BD%E5%90%88%E5%B9%B6%E3%80%82

前提条件：确保已安装docker、goss和dgoss。注意：虽然本地测试可行，但GitHub Actions会测试所有操作系统变体和支持的架构。

测试文件期望待测试镜像通过环境变量GH_RUNNER_IMAGE指定，以辅助CI。

测试步骤：

bash
$ # 需设置goss测试插值的最小变量
$ echo "os: ubuntu" >goss_vars.yaml
$ echo "oscodename: focal" >>goss_vars.yaml
$ echo "arch: x86_64" >>goss_vars.yaml
$ docker build -t my-base-test -f Dockerfile.base .
$ # 在最终镜像中使用基础镜像
$ sed -i.bak 's/^FROM.*/FROM my-base-test/g' Dockerfile
$ docker build -t my-full-test -f Dockerfile .
$ # 在当前git HEAD上测试Dockerfile.base的完整测试
$ GOSS_VARS=goss_vars.yaml GOSS_FILE=goss_full.yaml GOSS_SLEEP=1 dgoss run --entrypoint /usr/bin/sleep \
  -e DEBUG_ONLY=true \
  -e RUNNER_NAME=huzzah \
  -e REPO_URL=https://github.com/myoung34/docker-github-actions-runner \
  -e RUN_AS_ROOT=true \
  -e RUNNER_NAME_PREFIX=asdf \
  -e ACCESS_TOKEN=1234 \
  -e APP_ID=5678 \
  -e APP_PRIVATE_KEY=2345 \
  -e APP_LOGIN=SOMETHING \
  -e RUNNER_SCOPE=org \
  -e ORG_NAME=myoung34 \
  -e ENTERPRISE_NAME=emyoung34 \
  -e LABELS=blue,green \
  -e RUNNER_TOKEN=3456 \
  -e RUNNER_WORKDIR=/tmp/a \
  -e RUNNER_GROUP=wat \
  -e GITHUB_HOST=github.example.com \
  -e DISABLE_AUTOMATIC_DEREGISTRATION=true \
  -e EPHEMERAL=true \
  -e DISABLE_AUTO_UPDATE=true \
  my-full-test 10