Bump to version 2.263.0

Add docker-compose example setup

.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+github: myoung34

.github/workflows/base.yml

@@ -0,0 +1,68 @@
+name: GitHub Actions Runner in Docker - Base
+on:
+  push:
+    paths:
+      - Dockerfile.base
+    branches:
+      - master
+      - develop
+
+jobs:
+  ubuntu_base_latest_deploy:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Copy Repo Files
+      uses: actions/checkout@master
+    - name: Get GitHub organization or user
+      run: echo ::set-env name=ORG::$(dirname ${GITHUB_REPOSITORY})
+    - name: Set up Docker Buildx
+      id: buildx
+      uses: crazy-max/ghaction-docker-buildx@v1
+      with:
+        version: latest
+    - name: Available platforms
+      run: echo ${{ steps.buildx.outputs.platforms }}
+    - name: Login
+      run: docker login -u ${{ secrets.DOCKER_USER }} -p ${{ secrets.DOCKER_TOKEN }}
+    - name: Build
+      run: docker buildx build -f Dockerfile.base -t ${ORG}/github-runner-base:latest --output "type=image,push=true" --platform linux/amd64,linux/arm/v7,linux/arm64 .
+  ubuntu_base_bionic_deploy:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Copy Repo Files
+      uses: actions/checkout@master
+    - name: Get GitHub organization or user
+      run: echo ::set-env name=ORG::$(dirname ${GITHUB_REPOSITORY})
+    - name: Set up Docker Buildx
+      id: buildx
+      uses: crazy-max/ghaction-docker-buildx@v1
+      with:
+        version: latest
+    - name: Available platforms
+      run: echo ${{ steps.buildx.outputs.platforms }}
+    - name: Copy Dockerfile
+      run: cp Dockerfile.base Dockerfile.base.ubuntu-bionic; sed -i.bak 's/FROM.*/FROM ubuntu:bionic/' Dockerfile.base.ubuntu-bionic
+    - name: Login
+      run: docker login -u ${{ secrets.DOCKER_USER }} -p ${{ secrets.DOCKER_TOKEN }}
+    - name: Build
+      run: docker buildx build -f Dockerfile.base.ubuntu-bionic -t ${ORG}/github-runner-base:ubuntu-bionic --output "type=image,push=true" --platform linux/amd64,linux/arm/v7,linux/arm64 .
+  ubuntu_base_xenial_deploy:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Copy Repo Files
+      uses: actions/checkout@master
+    - name: Get GitHub organization or user
+      run: echo ::set-env name=ORG::$(dirname ${GITHUB_REPOSITORY})
+    - name: Set up Docker Buildx
+      id: buildx
+      uses: crazy-max/ghaction-docker-buildx@v1
+      with:
+        version: latest
+    - name: Available platforms
+      run: echo ${{ steps.buildx.outputs.platforms }}
+    - name: Copy Dockerfile
+      run: cp Dockerfile.base Dockerfile.base.ubuntu-xenial; sed -i.bak 's/FROM.*/FROM ubuntu:xenial/' Dockerfile.base.ubuntu-xenial
+    - name: Login
+      run: docker login -u ${{ secrets.DOCKER_USER }} -p ${{ secrets.DOCKER_TOKEN }}
+    - name: Build
+      run: docker buildx build -f Dockerfile.base.ubuntu-xenial -t ${ORG}/github-runner-base:ubuntu-xenial --output "type=image,push=true" --platform linux/amd64,linux/arm/v7,linux/arm64 .

.github/workflows/deploy.yml

@@ -2,6 +2,7 @@ name: GitHub Actions Runner in Docker - Latest
 on:
   push:
     paths-ignore:
+      - Dockerfile.base
       - README.md
     branches:
       - master
@@ -41,7 +42,7 @@ jobs:
     - name: Available platforms
       run: echo ${{ steps.buildx.outputs.platforms }}
     - name: Copy Dockerfile
-      run: cp Dockerfile Dockerfile.ubuntu-bionic; sed -i.bak 's/FROM.*/FROM ubuntu:bionic/' Dockerfile.ubuntu-bionic
+      run: cp Dockerfile Dockerfile.ubuntu-bionic; sed -i.bak "s/FROM.*/FROM ${ORG}\/github-runner-base:ubuntu-bionic/" Dockerfile.ubuntu-bionic
     - name: Login
       run: docker login -u ${{ secrets.DOCKER_USER }} -p ${{ secrets.DOCKER_TOKEN }}
     - name: Build
@@ -61,7 +62,7 @@ jobs:
     - name: Available platforms
       run: echo ${{ steps.buildx.outputs.platforms }}
     - name: Copy Dockerfile
-      run: cp Dockerfile Dockerfile.ubuntu-xenial; sed -i.bak 's/FROM.*/FROM ubuntu:xenial/' Dockerfile.ubuntu-xenial
+      run: cp Dockerfile Dockerfile.ubuntu-xenial; sed -i.bak "s/FROM.*/FROM ${ORG}\/github-runner-base:ubuntu-xenial/" Dockerfile.ubuntu-xenial
     - name: Login
       run: docker login -u ${{ secrets.DOCKER_USER }} -p ${{ secrets.DOCKER_TOKEN }}
     - name: Build

.github/workflows/release.yml

@@ -1,14 +1,29 @@
 name: GitHub Actions Runner in Docker - Release
 on:
   push:
-    paths-ignore:
-      - README.md
     tags:
       - '*'
 
 jobs:
+  create-release:
+    name: Create Release
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+    - name: Create Release
+      id: create_release
+      uses: actions/create-release@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        tag_name: ${{ github.ref }}
+        release_name: Release ${{ github.ref }}
+        draft: false
+        prerelease: false
   ubuntu_latest_tag:
     runs-on: ubuntu-latest
+    needs: create-release
     steps:
     - name: Copy Repo Files
       uses: actions/checkout@master
@@ -29,6 +44,7 @@ jobs:
       run: docker buildx build -f Dockerfile -t ${ORG}/github-runner:${TAG} --output "type=image,push=true" --platform linux/amd64,linux/arm/v7,linux/arm64 .
   ubuntu_bionic_tag:
     runs-on: ubuntu-latest
+    needs: create-release
     steps:
     - name: Copy Repo Files
       uses: actions/checkout@master
@@ -44,13 +60,14 @@ jobs:
     - name: Available platforms
       run: echo ${{ steps.buildx.outputs.platforms }}
     - name: Copy Dockerfile
-      run: cp Dockerfile Dockerfile.ubuntu-bionic; sed -i.bak 's/FROM.*/FROM ubuntu:bionic/' Dockerfile.ubuntu-bionic
+      run: cp Dockerfile Dockerfile.ubuntu-bionic; sed -i.bak "s/FROM.*/FROM ${ORG}\/github-runner-base:ubuntu-bionic/" Dockerfile.ubuntu-bionic
     - name: Login
       run: docker login -u ${{ secrets.DOCKER_USER }} -p ${{ secrets.DOCKER_TOKEN }}
     - name: Build
       run: docker buildx build -f Dockerfile.ubuntu-bionic -t ${ORG}/github-runner:${TAG}-ubuntu-bionic --output "type=image,push=true" --platform linux/amd64,linux/arm/v7,linux/arm64 .
   ubuntu_xenial_tag:
     runs-on: ubuntu-latest
+    needs: create-release
     steps:
     - name: Copy Repo Files
       uses: actions/checkout@master
@@ -66,7 +83,7 @@ jobs:
     - name: Available platforms
       run: echo ${{ steps.buildx.outputs.platforms }}
     - name: Copy Dockerfile
-      run: cp Dockerfile Dockerfile.ubuntu-xenial; sed -i.bak 's/FROM.*/FROM ubuntu:xenial/' Dockerfile.ubuntu-xenial
+      run: cp Dockerfile Dockerfile.ubuntu-xenial; sed -i.bak "s/FROM.*/FROM ${ORG}\/github-runner-base:ubuntu-xenial/" Dockerfile.ubuntu-xenial
     - name: Login
       run: docker login -u ${{ secrets.DOCKER_USER }} -p ${{ secrets.DOCKER_TOKEN }}
     - name: Build

Dockerfile

@@ -1,48 +1,11 @@
-FROM ubuntu:rolling
-LABEL maintainer="3vilpenguin@gmail.com"
+# hadolint ignore=DL3007
+FROM myoung34/github-runner-base:latest
+LABEL maintainer="myoung34@my.apsu.edu"
 
-ARG GIT_VERSION="2.23.0"
-ARG GH_RUNNER_VERSION="2.169.0"
+ARG GH_RUNNER_VERSION="2.263.0"
 ARG TARGETPLATFORM
 
 SHELL ["/bin/bash", "-o", "pipefail", "-c"]
-# hadolint ignore=DL3003
-RUN apt-get update && \
-  apt-get install -y --no-install-recommends \
-    curl \
-    tar \
-    apt-transport-https \
-    ca-certificates \
-    sudo \
-    gnupg-agent \
-    software-properties-common \
-    build-essential \
-    zlib1g-dev \
-    gettext \
-    liblttng-ust0 \
-    libcurl4-openssl-dev \
-    inetutils-ping \
-    jq \
-  && rm -rf /var/lib/apt/lists/* \
-  && c_rehash \
-  && cd /tmp \
-  && curl -sL https://www.kernel.org/pub/software/scm/git/git-${GIT_VERSION}.tar.gz -o git.tgz \
-  && tar zxf git.tgz \
-  && cd git-${GIT_VERSION} \
-  && ./configure --prefix=/usr \
-  && make \
-  && make install \
-  && cd / \
-  && rm -rf /tmp/git.tgz /tmp/git-${GIT_VERSION}
-
-RUN curl -fsSL https://download.docker.com/linux/ubuntu/gpg | apt-key add - \
-  && [[ $(lsb_release -cs) == "eoan" ]] && ( add-apt-repository "deb [arch=$(dpkg --print-architecture)] https://download.docker.com/linux/ubuntu disco stable" ) || ( add-apt-repository "deb [arch=$(dpkg --print-architecture)] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" )\
-  && apt-get update \
-  && apt-get install -y docker-ce docker-ce-cli containerd.io --no-install-recommends \
-  && rm -rf /var/lib/apt/lists/*
-
-RUN curl -sL "https://github.com/docker/compose/releases/download/1.25.4/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose \
-  && chmod +x /usr/local/bin/docker-compose
 
 WORKDIR /actions-runner
 COPY install_actions.sh /actions-runner

Dockerfile.base

@@ -0,0 +1,44 @@
+FROM ubuntu:eoan
+LABEL maintainer="myoung34@my.apsu.edu"
+
+ARG GIT_VERSION="2.26.2"
+
+SHELL ["/bin/bash", "-o", "pipefail", "-c"]
+ENV DEBIAN_FRONTEND=noninteractive
+# hadolint ignore=DL3003
+RUN apt-get update && \
+  apt-get install -y --no-install-recommends \
+    curl \
+    tar \
+    apt-transport-https \
+    ca-certificates \
+    sudo \
+    gnupg-agent \
+    software-properties-common \
+    build-essential \
+    zlib1g-dev \
+    gettext \
+    liblttng-ust0 \
+    libcurl4-openssl-dev \
+    inetutils-ping \
+    jq \
+  && rm -rf /var/lib/apt/lists/* \
+  && c_rehash \
+  && cd /tmp \
+  && curl -sL https://www.kernel.org/pub/software/scm/git/git-${GIT_VERSION}.tar.gz -o git.tgz \
+  && tar zxf git.tgz \
+  && cd git-${GIT_VERSION} \
+  && ./configure --prefix=/usr \
+  && make \
+  && make install \
+  && cd / \
+  && rm -rf /tmp/git.tgz /tmp/git-${GIT_VERSION}
+
+RUN curl -fsSL https://download.docker.com/linux/ubuntu/gpg | apt-key add - \
+  && [[ $(lsb_release -cs) == "eoan" ]] && ( add-apt-repository "deb [arch=$(dpkg --print-architecture)] https://download.docker.com/linux/ubuntu disco stable" ) || ( add-apt-repository "deb [arch=$(dpkg --print-architecture)] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" )\
+  && apt-get update \
+  && apt-get install -y docker-ce docker-ce-cli containerd.io --no-install-recommends \
+  && rm -rf /var/lib/apt/lists/*
+
+RUN curl -sL "https://github.com/docker/compose/releases/download/1.25.4/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose \
+  && chmod +x /usr/local/bin/docker-compose

README.md

@@ -1,6 +1,8 @@
 Docker Github Actions Runner
 ============================
 
+[![Docker Pulls](https://img.shields.io/docker/pulls/myoung34/github-runner.svg)](https://hub.docker.com/r/myoung34/github-runner)
+
 This will run the [new self-hosted github actions runners](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/hosting-your-own-runners).
 
 This has been tested and verified on:
@@ -21,6 +23,19 @@ If you're using a RHEL based OS with SELinux, add `--security-opt=label=disable`
 ### Manual ###
 
 ```
+# org runner 
+docker run -d --restart always --name github-runner \
+  -e REPO_URL="https://github.com/myoung34/repo" \
+  -e RUNNER_NAME="foo-runner" \
+  -e RUNNER_TOKEN="footoken" \
+  -e RUNNER_WORKDIR="/tmp/github-runner-your-repo" \
+  -e ORG_RUNNER="true" \
+  -e ORG_NAME="octokode" \
+  -e LABELS="my-label,other-label" \
+  -v /var/run/docker.sock:/var/run/docker.sock \
+  -v /tmp/github-runner-your-repo:/tmp/github-runner-your-repo \
+  myoung34/github-runner:latest
+# per repo
 docker run -d --restart always --name github-runner \
   -e REPO_URL="https://github.com/myoung34/repo" \
   -e RUNNER_NAME="foo-runner" \
@@ -45,6 +60,9 @@ function github-runner {
         -e RUNNER_TOKEN="$2" \
         -e RUNNER_NAME="linux-${repo}" \
         -e RUNNER_WORKDIR="/tmp/github-runner-${repo}" \
+        -e ORG_RUNNER="true" \
+        -e ORG_NAME="octokode" \
+        -e LABELS="my-label,other-label" \
         -v /var/run/docker.sock:/var/run/docker.sock \
         -v /tmp/github-runner-${repo}:/tmp/github-runner-${repo} \
         --name $name ${org}/github-runner:${tag}
@@ -54,6 +72,33 @@ github-runner your-account/your-repo       AARGHTHISISYOURGHACTIONSTOKEN
 github-runner your-account/some-other-repo ARGHANOTHERGITHUBACTIONSTOKEN ubuntu-xenial
 ```
 
+Or `docker-compose.yml`:
+```yml
+version: '2.3'
+
+services:
+  worker:
+    build: .
+    image: myoung34/github-runner:latest
+    environment:
+      REPO_URL: https://github.com/example/repo
+      RUNNER_NAME: example-name
+      RUNNER_TOKEN: someGithubTokenHere
+      RUNNER_WORKDIR: /tmp/runner/work
+      ORG_RUNNER: true
+      ORG_NAME: example-github-org
+      LABELS: linux,x64,gpu
+    security_opt:
+      # needed on SELinux systems to allow docker container to manage other docker containers
+      - label:disable
+    volumes:
+      - '/var/run/docker.sock:/var/run/docker.sock'
+      - '/tmp/runner:/tmp/runner'
+      # note: a quirk of docker-in-docker is that this path 
+      # needs to be the same path on host and inside the container,
+      # docker mgmt cmds run outside of docker but expect the paths from within
+```
+
 ### Nomad ###
 
 ```
@@ -68,6 +113,9 @@ job "github_runner" {
       REPO_URL = "https://github.com/your-account/your-repo"
       RUNNER_TOKEN   = "footoken"
       RUNNER_WORKDIR = "/tmp/github-runner-your-repo"
+      ORG_RUNNER     = "true"
+      ORG_NAME       = "octokode"
+      LABELS         = "my-label,other-label"
     }
 
     config {
@@ -111,6 +159,12 @@ spec:
       - name: runner
         image: myoung34/github-runner:latest
         env:
+        - name: ORG_RUNNER
+          value: true
+        - name: ORG_NAME
+          value: octokode
+        - name: LABELS
+          value: my-label,other-label
         - name: RUNNER_TOKEN
           value: footoken
         - name: REPO_URL
@@ -156,6 +210,9 @@ docker run -d --restart always --name github-runner \
   -e REPO_URL="https://github.com/myoung34/repo" \
   -e RUNNER_NAME="foo-runner" \
   -e RUNNER_WORKDIR="/tmp/github-runner-your-repo" \
+  -e ORG_RUNNER="true" \
+  -e ORG_NAME="octokode" \
+  -e LABELS="my-label,other-label" \
   -v /var/run/docker.sock:/var/run/docker.sock \
   -v /tmp/github-runner-your-repo:/tmp/github-runner-your-repo \
   myoung34/github-runner:latest

entrypoint.sh

@@ -5,6 +5,9 @@ export PATH=$PATH:/actions-runner
 
 _RUNNER_NAME=${RUNNER_NAME:-default}
 _RUNNER_WORKDIR=${RUNNER_WORKDIR:-/_work}
+_ORG_RUNNER=${ORG_RUNNER:-false}
+_LABELS=${LABELS:-default}
+_SHORT_URL=${REPO_URL}
 
 if [[ -n "${ACCESS_TOKEN}" ]]; then
     URI=https://api.github.com
@@ -13,17 +16,34 @@ if [[ -n "${ACCESS_TOKEN}" ]]; then
     AUTH_HEADER="Authorization: token ${ACCESS_TOKEN}"
 
     _PROTO="$(echo "${REPO_URL}" | grep :// | sed -e's,^\(.*://\).*,\1,g')"
+    # shellcheck disable=SC2116
     _URL="$(echo "${REPO_URL/${_PROTO}/}")"
     _PATH="$(echo "${_URL}" | grep / | cut -d/ -f2-)"
     _ACCOUNT="$(echo "${_PATH}" | cut -d/ -f1)"
     _REPO="$(echo "${_PATH}" | cut -d/ -f2)"
 
+    _FULL_URI="${URI}/repos/${_ACCOUNT}/${_REPO}/actions/runners/registration-token"
+    if [[ ${_ORG_RUNNER} == "true" ]]; then
+      [[ -z ${ORG_NAME} ]] && ( echo "ORG_NAME required for org runners"; exit 1 )
+      _FULL_URI="${URI}/orgs/${ORG_NAME}/actions/runners/registration-token"
+      _SHORT_URL="${_PROTO}github.com/${ORG_NAME}"
+    fi
     RUNNER_TOKEN="$(curl -XPOST -fsSL \
-    -H "${AUTH_HEADER}" \
-    -H "${API_HEADER}" \
-    "${URI}/repos/${_ACCOUNT}/${_REPO}/actions/runners/registration-token" \
+      -H "${AUTH_HEADER}" \
+      -H "${API_HEADER}" \
+      "${_FULL_URI}" \
     | jq -r '.token')"
 fi
 
-./config.sh --url "${REPO_URL}" --token "${RUNNER_TOKEN}" --name "${_RUNNER_NAME}" --work "${_RUNNER_WORKDIR}"
-./run.sh
+echo "Configuring"
+
+./config.sh \
+    --url "${_SHORT_URL}" \
+    --token "${RUNNER_TOKEN}" \
+    --name "${_RUNNER_NAME}" \
+    --work "${_RUNNER_WORKDIR}" \
+    --labels "${_LABELS}" \
+    --unattended \
+    --replace
+
+./bin/runsvc.sh