Initial commit for runner based on debian-buster

Author: tcardonne

.dockerignore

@@ -0,0 +1 @@
+.env

.gitignore

@@ -0,0 +1 @@
+.env

Makefile

@@ -0,0 +1,16 @@
+APP_NAME="tcardonne/github-runner"
+
+# HELP
+# This will output the help for each task
+# thanks to https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html
+.PHONY: help
+help: ## This help.
+	@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST)
+
+.DEFAULT_GOAL := help
+
+build: ## Build the image
+	docker build -t $(APP_NAME) debian-buster
+
+shell: ## Creates a shell inside the container for debug purposes
+	docker run -it $(APP_NAME) bash

README.md

@@ -0,0 +1,43 @@
+# GitHub Runner
+
+GitHub allows developpers to run GitHub Actions workflows on your own runners.
+This Docker image allows you to create your own runner on Docker.
+
+Note : As stated in the [documentation](https://help.github.com/en/github/automating-your-workflow-with-github-actions/about-self-hosted-runners) :
+> "GitHub Actions is currently in limited public beta and is subject to change. We strongly recommend that you do not use this feature for high-value workflows and content during the beta period".
+
+## Usage
+
+Use the following command to start listening for jobs:
+```shell
+docker run -it --name my-runner \
+    -e RUNNER_NAME=my-runner \
+    -e RUNNER_TOKEN=token \
+    -e RUNNER_REPOSITORY_URL=https://github.com/... \
+    tcardonne/github-runner
+```
+
+## Environment variables
+
+The following environment variables allows you to control the configuration parameters.
+
+| Name | Description | Default value |
+|------|---------------|-------------|
+| RUNNER_REPOSITORY_URL | The runner will be linked to this repository URL | Required |
+| RUNNER_TOKEN | Personal Access Token provided by GitHub | Required
+| RUNNER_WORK_DIRECTORY | Runner's work directory | `"_work"`
+| RUNNER_NAME | Name of the runner displayed in the GitHub UI | Hostname of the container
+
+## Using docker-compose.yml
+
+```yaml
+version: "3.6"
+
+services:
+    runner:
+      image: tcardonne/github-runner:latest
+      environment:
+        RUNNER_NAME: "my-runner"
+        RUNNER_REPOSITORY_URL: ${RUNNER_REPOSITORY_URL}
+        RUNNER_TOKEN: ${RUNNER_TOKEN}
+```

debian-buster/Dockerfile

@@ -0,0 +1,41 @@
+FROM debian:buster
+
+ARG GH_RUNNER_VERSION="2.160.0"
+
+ENV RUNNER_NAME=""
+ENV RUNNER_WORK_DIRECTORY="_work"
+ENV RUNNER_TOKEN=""
+ENV RUNNER_REPOSITORY_URL=""
+
+# Labels.
+LABEL maintainer="me@tcardonne.fr" \
+    org.label-schema.schema-version="1.0" \
+    org.label-schema.build-date=$BUILD_DATE \
+    org.label-schema.vcs-ref=$VCS_REF \
+    org.label-schema.name="tcardonne/github-runner" \
+    org.label-schema.description="Dockerized GitHub Actions runner." \
+    org.label-schema.url="https://github.com/tcardonne/docker-github-runner" \
+    org.label-schema.vcs-url="https://github.com/tcardonne/docker-github-runner" \
+    org.label-schema.vendor="Thomas Cardonne" \
+    org.label-schema.docker.cmd="docker run -it tcardonne/github-runner:latest"
+
+RUN DEBIAN_FRONTEND=noninteractive apt-get update && \
+    apt-get install -y curl git && \
+    rm -rf /var/lib/apt/lists/* && \
+    apt-get clean
+
+RUN useradd -ms /bin/bash runner
+WORKDIR /home/runner
+
+RUN curl -O https://githubassets.azureedge.net/runners/${GH_RUNNER_VERSION}/actions-runner-linux-x64-${GH_RUNNER_VERSION}.tar.gz \
+    && tar -zxf actions-runner-linux-x64-${GH_RUNNER_VERSION}.tar.gz \
+    && rm -f actions-runner-linux-x64-${GH_RUNNER_VERSION}.tar.gz \
+    && ./bin/installdependencies.sh \
+    && chown -R runner: /home/runner
+
+COPY entrypoint.sh /entrypoint.sh
+RUN chmod +x /entrypoint.sh
+ENTRYPOINT ["/entrypoint.sh"]
+CMD ["./run.sh"]
+
+USER runner

debian-buster/entrypoint.sh

@@ -0,0 +1,37 @@
+#!/bin/bash
+
+if [[ "$@" == "bash" ]]; then
+    exec $@
+fi
+
+if [[ -z $RUNNER_NAME ]]; then
+    echo "RUNNER_NAME environment variable is not set, using '${HOSTNAME}'."
+    export RUNNER_NAME=${HOSTNAME}
+fi
+
+if [[ -z $RUNNER_WORK_DIRECTORY ]]; then
+    echo "RUNNER_WORK_DIRECTORY environment variable is not set, using '_work'."
+    export RUNNER_WORK_DIRECTORY="_work"
+fi
+
+if [[ -z $RUNNER_TOKEN ]]; then
+    echo "Error : You need to set the RUNNER_TOKEN environment variable."
+    exit 1
+fi
+
+if [[ -z $RUNNER_REPOSITORY_URL ]]; then
+    echo "Error : You need to set the RUNNER_REPOSITORY_URL environment variable."
+    exit 1
+fi
+
+if [[ -f ".runner" ]]; then
+    echo "Runner already configured. Skipping config."
+else
+    ./config.sh \
+        --url $RUNNER_REPOSITORY_URL \
+        --token $RUNNER_TOKEN \
+        --agent $RUNNER_NAME \
+        --work $RUNNER_WORK_DIRECTORY
+fi
+
+exec "$@"

docker-compose.yml

@@ -0,0 +1,9 @@
+version: "3.6"
+
+services:
+    runner:
+      image: tcardonne/github-runner
+      environment:
+        RUNNER_NAME: "my-runner"
+        RUNNER_REPOSITORY_URL: ${RUNNER_REPOSITORY_URL}
+        RUNNER_TOKEN: ${RUNNER_TOKEN}