Rename github-runner-installer to github-runner-starter (#6)

Author: jonpugh

.github/workflows/tests.yml

@@ -40,18 +40,18 @@ jobs:
       - name: Help
         run: |
           echo "Hi from .github/workflows/tests.yml!"
-          ./github-runner-installer --help
+          ./github-runner-starter --help
 
       - name: Run
         run: |
-          ./github-runner-installer \
+          ./github-runner-starter \
             --run \
             --name=${RUNNER_CONFIG_NAME} \
             --config-sh-options=--ephemeral
 
       - name: Run again
         run: |
-          ./github-runner-installer \
+          ./github-runner-starter \
             --run \
             --name=${RUNNER_CONFIG_NAME} \
             --config-sh-options=--ephemeral

Dockerfile

@@ -10,8 +10,8 @@ RUN yum install -y \
     jq
 
 # This codebase. The runner wrapper script.
-COPY ./ /github-runner-installer
-WORKDIR /github-runner-installer
+COPY ./ /github-runner-starter
+WORKDIR /github-runner-starter
 RUN chown runner:runner . -R
 
 # GitHub Runner code.
@@ -22,8 +22,8 @@ ENV RUNNER_PATH /usr/share/github-runner
 RUN curl https://raw.githubusercontent.com/actions/runner/refs/tags/v2.326.0/src/Misc/layoutbin/installdependencies.sh -o install-dependencies \
     && bash install-dependencies
 
-# Run github-runner-installer script.
-#RUN ./github-runner-installer --no-run --no-config --runner-path=${RUNNER_PATH}
+# Run github-runner-starter script.
+#RUN ./github-runner-starter --no-run --no-config --runner-path=${RUNNER_PATH}
 
 # Change runner ownership & Switch user.
 # RUN chown runner:runner ${RUNNER_PATH} -R

README.md

@@ -1,2 +1,2 @@
-# github-runner-installer
+# github-runner-starter
 A single script to install, configure, launch, and cleanup GitHub runners.

composer.json

@@ -11,6 +11,6 @@
     ],
     "require": {},
     "bin": [
-        "github-runner-installer"
+        "github-runner-starter"
     ]
 }

docker-compose.yml

@@ -7,13 +7,13 @@ services:
     image: jonpugh/github-runner
     hostname: localhost
     volumes:
-      - ./:/github-runner-installer
+      - ./:/github-runner-starter
     environment:
       GITHUB_TOKEN: ${GITHUB_TOKEN}
-      GITHUB_REPOSITORY: operations-project/github-runner-installer
+      GITHUB_REPOSITORY: operations-project/github-runner-starter
       RUNNER_CONFIG_LABELS: ${RUNNER_CONFIG_LABELS:-runner@localhost}
     entrypoint: ./docker-entrypoint
-    command: ./github-runner-installer
+    command: ./github-runner-starter
     build: ./
 
     # Give the containers more time to shutdown before being cancelled.

github-runner-installer github-runner-startergithub-runner-installer renamed to github-runner-starter

@@ -31,7 +31,7 @@ start() {
 
   else
     say Skipped running due to --no-run option.
-    say Exiting github-runner-installer.
+    say Exiting github-runner-starter.
   fi
 
 }
@@ -79,9 +79,9 @@ verify() {
   # Detect path to this script.
   # @TODO: Rename RUNNER_SCRIPT_ to reduce confusion with github runner CLI
   if [[ -z "$COMPOSER_RUNTIME_BIN_DIR" ]]; then
-    RUNNER_SCRIPT_PATH="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )/github-runner-installer"
+    RUNNER_SCRIPT_PATH="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )/github-runner-starter"
   else
-    RUNNER_SCRIPT_PATH="$COMPOSER_RUNTIME_BIN_DIR/github-runner-installer"
+    RUNNER_SCRIPT_PATH="$COMPOSER_RUNTIME_BIN_DIR/github-runner-starter"
   fi
   if [[ ! -f "${RUNNER_SCRIPT_PATH}" ]]; then
      say "Path detection failed."
@@ -93,7 +93,7 @@ verify() {
   # Defaults. If ENV vars exist, use them. If not, use these values.
   RUNNER_PATH=${RUNNER_PATH:-"runner"}
   RUNNER_CONFIG_NAME=${RUNNER_CONFIG_NAME:-$(whoami)@$(hostname -f)}
-  RUNNER_CONFIG_LABELS=${RUNNER_CONFIG_LABELS:-"operations-project/github-runner-installer"}
+  RUNNER_CONFIG_LABELS=${RUNNER_CONFIG_LABELS:-"operations-project/github-runner-starter"}
   RUNNER_CONFIG_OPTIONS=${RUNNER_CONFIG_OPTIONS:-""}
 
   # Whether to run the runner
@@ -322,7 +322,7 @@ cancel() {
   exit 1
 }
 say() {
-  echo " github-runner-installer | ${*}"
+  echo " github-runner-starter | ${*}"
 }
 line() {
   CHARACTER="${CHARACTER:--}"