msyea/github-actions-runner

GitHub Actions Runner

基于 ubuntu:20.04 构建，配置为无root权限的Docker-in-Docker（dind）环境。本镜像实现离不开@kenichi-shibata、@sidick的宝贵建议以及@msyea的开发工作。

灵感来源

• https://github.com/cruizba/ubuntu-dind 展示了在Ubuntu上实现dind的可能性
• https://github.com/myoung34/docker-github-actions-runner 展示了Docker外运行GitHub Actions Runner的实现，启发了API设计并部分参考了其文档
• https://github.com/docker-library/docker/tree/master/20.10/dind-rootless 的杰出无root dind实现

相关镜像

• https://hub.docker.com/repository/docker/msyea/ubuntu-docker
• https://hub.docker.com/repository/docker/msyea/ubuntu-dind
• https://hub.docker.com/repository/docker/msyea/github-actions-runner

Docker GitHub Actions Runner

本镜像用于运行https://help.github.com/en/actions/automating-your-workflow-with-github-actions/hosting-your-own-runners。

环境变量

使用方法

手动运行

组织级运行器

shell
docker run -d --restart always --name github-runner \
  -e RUNNER_NAME_PREFIX="myrunner" \
  -e ACCESS_TOKEN="footoken" \
  -e RUNNER_WORKDIR="/tmp/github-runner-your-repo" \
  -e RUNNER_GROUP="my-group" \
  -e ORG_RUNNER="true" \
  -e ORG_NAME="octokode" \
  -e LABELS="my-label,other-label" \
  docker.xuanyuan.run/msyea/github-actions-runner:latest

仓库级运行器

shell
docker run -d --restart always --name github-runner \
  -e REPO_URL="https://github.com/msyea/repo" \
  -e RUNNER_NAME="foo-runner" \
  -e RUNNER_TOKEN="footoken" \
  -e RUNNER_WORKDIR="/tmp/github-runner-your-repo" \
  -e RUNNER_GROUP="my-group" \
  docker.xuanyuan.run/msyea/github-actions-runner:latest

Shell包装函数

shell
function github-runner {
    name=github-runner-${1//\//-}
    org=$(dirname $1)
    repo=$(basename $1)
    tag=${3:-latest}
    docker rm -f $name
    docker run -d --restart=always \
        -e REPO_URL="https://github.com/${org}/${repo}" \
        -e RUNNER_TOKEN="$2" \
        -e RUNNER_NAME="linux-${repo}" \
        -e RUNNER_WORKDIR="/tmp/github-runner-${repo}" \
        -e RUNNER_GROUP="my-group" \
        -e LABELS="my-label,other-label" \
        --name $name ${org}/github-runner:${tag}
}

# 使用示例
github-runner your-account/your-repo       AARGHTHISISYOURGHACTIONSTOKEN
github-runner your-account/some-other-repo ARGHANOTHERGITHUBACTIONSTOKEN ubuntu-xenial

Docker Compose配置

yml
version: '2.3'

services:
  worker:
    image: docker.xuanyuan.run/msyea/github-actions-runner:latest
    environment:
      REPO_URL: https://github.com/example/repo
      RUNNER_NAME: example-name
      RUNNER_TOKEN: someGithubTokenHere
      RUNNER_GROUP: my-group
      ORG_RUNNER: 'false'
      LABELS: linux,x64,gpu

在GitHub Actions工作流中使用

yml
name: Package

on:
  release:
    types: [created]

jobs:
  build:
    runs-on: self-hosted
    steps:
    - uses: actions/checkout@v1
    - name: 构建包
      run: make all

自动获取运行器令牌

若提供 ACCESS_TOKEN（GitHub个人访问令牌），可在运行时自动获取运行器令牌。这利用了https://developer.github.com/v3/actions/self_hosted_runners/#create-a-registration-token。示例：

shell
docker run -d --restart always --name github-runner \
  -e ACCESS_TOKEN="footoken" \
  -e RUNNER_NAME="foo-runner" \
  -e RUNNER_WORKDIR="/tmp/github-runner-your-repo" \
  -e RUNNER_GROUP="my-group" \
  -e ORG_RUNNER="true" \
  -e ORG_NAME="octokode" \
  -e LABELS="my-label,other-label" \
  docker.xuanyuan.run/msyea/github-actions-runner:latest

创建GitHub个人访问令牌（PAT）

创建用于自托管运行器的GitHub个人访问令牌时，需确保选择以下作用域：

• repo（所有权限）
• admin:org（所有权限）（组织级运行器必需）
• admin:public_key - read:public_key
• admin:repo_hook - read:repo_hook
• admin:org_hook
• notifications
• workflow

此外，为使自托管运行器能处理特定组织多个仓库的事件，建议使用组织所有者账户创建PAT，否则PAT可能对所有仓库没有足够权限。