Add compatibility with enterprise-scoped runner

https://docs.github.com/en/[email protected]/rest/reference/enterprise-admin#create-a-registration-token-for-an-enterprise

Author: jakubstefan

README.md

@@ -40,6 +40,8 @@ These containers are built via Github actions that [copy the dockerfile](https:/
 | `ACCESS_TOKEN` | A [github PAT](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) to use to generate `RUNNER_TOKEN` dynamically at container start. Not using this requires a valid `RUNNER_TOKEN` |
 | `ORG_RUNNER` | Only valid if using `ACCESS_TOKEN`. This will set the runner to an org runner. Default is 'false'. Valid values are 'true' or 'false'. If this is set to true you must also set `ORG_NAME` and makes `REPO_URL` unneccesary |
 | `ORG_NAME` | The organization name for the runner to register under. Requires `ORG_RUNNER` to be 'true'. No default value. |
+| `ENTERPRISE_RUNNER` | Only valid if using `ACCESS_TOKEN`. This will set the runner to an enterprise runner. Default is 'false'. Valid values are 'true' or 'false'. If this is set to true you must also set `ENTERPRISE_NAME` and makes `REPO_URL` unneccesary |
+| `ENTERPRISE_NAME` | The enterprise name for the runner to register under. Requires `ENTERPRISE_RUNNER` to be 'true'. No default value. |
 | `LABELS` | A comma separated string to indicate the labels. Default is 'default' |
 | `REPO_URL` | If using a non-organization runner this is the full repository url to register under such as 'https://github.com/myoung34/repo' |
 | `RUNNER_TOKEN` | If not using a PAT for `ACCESS_TOKEN` this will be the runner token provided by the Add Runner UI (a manual process). Note: This token is short lived and will change frequently. `ACCESS_TOKEN` is likely preferred. |
@@ -268,10 +270,27 @@ Creating GitHub personal access token (PAT) for using by self-hosted runner make
 
 * repo (all)
 * admin:org (all) **_(mandatory for organization-wide runner)_**
+* admin:enterprise (all) **_(mandatory for enterprise-wide runner)_**
 * admin:public_key - read:public_key
 * admin:repo_hook - read:repo_hook
 * admin:org_hook
 * notifications
 * workflow
 
 Also, when creating a PAT for self-hosted runner which will process events from several repositories of the particular organization, create the PAT using organization owner account. Otherwise your new PAT will not have sufficient privileges for all repositories.
+
+## Run a runner on enterprise scrope  ##
+
+```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 ENTERPRISE_RUNNER="true" \
+  -e ENTERPRISE_NAME="my-enterprise" \
+  -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

@@ -22,6 +22,8 @@ _GITHUB_HOST=${GITHUB_HOST:="github.com"}
 
 if [[ ${ORG_RUNNER} == "true" ]]; then
   _SHORT_URL="https://${_GITHUB_HOST}/${ORG_NAME}"
+elif [[ ${ENTERPRISE_RUNNER} == "true" ]]; then
+  _SHORT_URL="https://${_GITHUB_HOST}/enterprises/${ENTERPRISE_NAME}"
 fi
 
 if [[ -n "${ACCESS_TOKEN}" ]]; then

token.sh

@@ -1,6 +1,7 @@
 #!/bin/bash
 
 _ORG_RUNNER=${ORG_RUNNER:-false}
+_ENTERPRISE_RUNNER=${ENTERPRISE_RUNNER:-false}
 _GITHUB_HOST=${GITHUB_HOST:="github.com"}
 
 # If URL is not github.com then use the enterprise api endpoint
@@ -27,6 +28,10 @@ if [[ ${_ORG_RUNNER} == "true" ]]; then
   [[ -z ${ORG_NAME} ]] && ( echo "ORG_NAME required for org runners"; exit 1 )
   _FULL_URL="${URI}/orgs/${ORG_NAME}/actions/runners/registration-token"
   _SHORT_URL="${_PROTO}${_GITHUB_HOST}/${ORG_NAME}"
+elif [[ ${_ENTERPRISE_RUNNER} == "true" ]]; then
+  [[ -z ${ENTERPRISE_NAME} ]] && ( echo "ENTERPRISE_NAME required for enterprise runners"; exit 1 )
+  _FULL_URL="${URI}/enterprises/${ENTERPRISE_NAME}/actions/runners/registration-token"
+  _SHORT_URL="${_PROTO}${_GITHUB_HOST}/enterprises/${ENTERPRISE_NAME}"
 else
   _SHORT_URL=$REPO_URL
 fi