Skip to content

Commit 28da566

Browse files
committed
Improve .env.example
1 parent 2b3e104 commit 28da566

3 files changed

Lines changed: 30 additions & 8 deletions

File tree

.env.example

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,40 @@
22
# REQUIRED
33

44
# Repo to install the runner.
5-
#GITHUB_REPO=jonpugh/github-runner
5+
# Command line: --repo
6+
#GITHUB_REPOSITORY=operations-project/github-runner-starter
67

7-
# GitHub Token with admin:write permissions, for creating runners.
8+
# GitHub Personal Access Token with admin:write permissions, for creating runners.
9+
# Command line: --token
810
#GITHUB_TOKEN=
911

1012
# OPTIONAL
1113

1214
# Path to download the runner.
13-
#RUNNER_PATH=.runner
15+
# Command line: --runner-path
16+
# RUNNER_PATH=runner
1417

1518
# Name of the runner. Defaults to user@hostname
19+
# Command line: --name
1620
#RUNNER_CONFIG_NAME=user@custom.hostname.whatever
1721

18-
# Labels to add to the runner. Defaults to user@hostname
19-
#RUNNER_CONFIG_LABEL=our-custom-runner
22+
# Labels to add to the runner. Defaults to user@hostname. Separate with commas.
23+
# Command line: --labels
24+
#RUNNER_CONFIG_LABELS=our-custom-runner
25+
26+
# config.sh options
27+
# Command line: --config-sh-options
28+
#RUNNER_CONFIG_OPTIONS=
29+
30+
# Set to "yes" to launch run.sh.
31+
# Without the --run option, the github runner will only install and configure itself.
32+
# Use run.sh manually or install as a service to start the runner.
33+
# Command line: --run
34+
# RUNNER_RUN=""
35+
36+
# Set to "no" to prevent runing config.sh
37+
# Command line: --no-config
38+
# RUNNER_CONFIG=yes
39+
40+
# Set to "no" to prevent the github runner scripts from removal when the process is ended.
41+
#RUNNER_CLEANUP=yes

composer.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
2-
"name": "operations/github-runner-starter",
3-
"description": "A shell script for installing, configuring, and launching github runners in a single process.",
2+
"name": "jonpugh/github-runner",
3+
"description": "A shell script for launching github runners.",
44
"type": "library",
55
"license": "MIT",
66
"authors": [

github-runner-starter

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,6 @@ verify() {
9393
# Defaults. If ENV vars exist, use them. If not, use these values.
9494
RUNNER_PATH=${RUNNER_PATH:-"runner"}
9595
RUNNER_CONFIG_NAME=${RUNNER_CONFIG_NAME:-$(whoami)@$(hostname -f)}
96-
RUNNER_CONFIG_LABELS=${RUNNER_CONFIG_LABELS:-"operations-project/github-runner-starter"}
9796
RUNNER_CONFIG_OPTIONS=${RUNNER_CONFIG_OPTIONS:-""}
9897

9998
# Whether to run the runner
@@ -151,6 +150,7 @@ verify() {
151150
# Helpful URLs
152151
RUNNER_URL_REPO="https://github.com/${GITHUB_REPOSITORY}"
153152
RUNNER_URL_RUNNERS="${RUNNER_URL_REPO}/settings/actions/runners"
153+
RUNNER_CONFIG_LABELS=${RUNNER_CONFIG_LABELS:-${GITHUB_REPOSITORY}
154154
155155
line
156156
welcome

0 commit comments

Comments
 (0)