install.sh

#!/usr/bin/env bash

# Copyright 2024 Nils Knieling. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# Install GitHub Actions Runner for Linux with x64 or ARM64 CPU architecture
# https://github.com/actions/runner
# https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#linux

# Get the script's name
MY_SCRIPT_NAME=$(basename "$0")

# Set default GitHub Actions Runner version (latest)
MY_RUNNER_VERSION="latest"

# Set default GitHub Actions Runner installation directory
MY_RUNNER_DIR="/actions-runner"

# Function to exit the script with a failure message
function exit_with_failure() {
	echo >&2 "FAILURE: $1"  # Print error message to stderr
	exit 1
}

# Function to display usage information
function usage {
	MY_RETURN_CODE="$1"
	echo -e "Usage: $MY_SCRIPT_NAME [-v <runner_version>] [-d <runner_dir>] [-h]:
	[-v <runner_version>]  Version (without 'v') of the GitHub Actions Runner. (default: $MY_RUNNER_VERSION)
	[-d <runner_dir>]      Directory for the GitHub Actions Runner installation. (default: $MY_RUNNER_DIR)
	[-h]                   Displays this message."
	exit "$MY_RETURN_CODE"
}

# If version is "skip", skip GitHub Actions Runner installation.
if [[ "$MY_RUNNER_VERSION" = "skip" ]]; then
	exit 0
fi

# Define required commands
MY_COMMANDS=(
	curl
	gzip
	jq
	sed
	tar
)
# Check if required commands are available
for MY_COMMAND in "${MY_COMMANDS[@]}"; do
	if ! command -v "$MY_COMMAND" >/dev/null 2>&1; then
		exit_with_failure "The command '$MY_COMMAND' was not found. Please install it."
	fi
done

# Detect CPU architecture
case $(uname -m) in
aarch64|arm64)
	MY_ARCH="arm64"
	;;
amd64|x86_64)
	MY_ARCH="x64"
	;;
*)
	exit_with_failure "Cannot determine CPU architecture!"
esac

# Process command line arguments
while getopts ":v:d:h" opt; do
	case $opt in
	v)
		MY_RUNNER_VERSION="$OPTARG"
		;;
	d)
		MY_RUNNER_DIR="$OPTARG"
		;;
	h)
		usage 0
		;;
	*)
		echo "Invalid option: -$OPTARG"
		usage 1
		;;
	esac
done

# If version is "latest", fetch the latest version from GitHub API
if [[ "$MY_RUNNER_VERSION" = "latest" ]]; then
	MY_RUNNER_LATEST_VERSION=$(curl -sL "https://api.github.com/repos/actions/runner/releases/latest" | jq -r '.tag_name' | sed -e 's/^v//')
	MY_RUNNER_VERSION="$MY_RUNNER_LATEST_VERSION"
	if [[ -z "$MY_RUNNER_LATEST_VERSION" || "null" == "$MY_RUNNER_LATEST_VERSION" ]]; then
		exit_with_failure "Could not retrieve the latest GitHub Actions Runner version!"
	fi
	echo "GitHub Actions Runner version 'v${MY_RUNNER_LATEST_VERSION}' is detected as the latest version."
else
	echo "GitHub Actions Runner version 'v$MY_INPUT_RUNNER_VERSION' is specified as version."
	MY_RUNNER_VERSION="$MY_INPUT_RUNNER_VERSION"
fi

# Create directory (if it doesn't exist) and change to the installation directory
mkdir -p "$MY_RUNNER_DIR" && \
cd "$MY_RUNNER_DIR" && \
# Download the GitHub Actions Runner archive
curl -O -L "https://github.com/actions/runner/releases/download/v${MY_RUNNER_VERSION}/actions-runner-linux-${MY_ARCH}-${MY_RUNNER_VERSION}.tar.gz" && \
tar xzf "actions-runner-linux-${MY_ARCH}-${MY_RUNNER_VERSION}.tar.gz"

# Patch for Ubuntu 24.04 (https://github.com/actions/runner/issues/3150)
# This patch might be necessary for successful installation on Ubuntu 24.04
sed -i 's/libicu72/libicu72 libicu74/' ./bin/installdependencies.sh

# Run the installation script
./bin/installdependencies.sh && \
echo "GitHub Actions Runner installed successfully."