如何让GitHub Codespace启动时自托管Runner自动处于Idle状态？

问题分析 #

你通过.devcontainer.json的postCreateCommand和postStartCommand调用startup.sh启动自托管Runner，但自动执行时Runner显示离线，手动运行脚本却正常。核心原因大概率是脚本语法、执行环境或进程管理方式存在问题。

具体修复方案 #

1. 修正nohup命令的语法错误 #

你的startup.sh里的nohup命令包含HTML转义字符，Shell无法识别，导致执行失败：

# 原错误写法
nohup ./run.sh & > _diag/runner.log

改成标准Shell语法，同时确保日志目录存在：

# 先创建日志目录，避免因目录不存在报错
mkdir -p _diag
# 正确的后台执行+日志重定向（包含错误输出）
nohup ./run.sh > _diag/runner.log 2>&1 &

2. 确保脚本在正确的工作目录执行 #

postCreateCommand和postStartCommand默认在容器根目录执行，如果config.sh、run.sh不在该目录，./config.sh会找不到文件。在脚本开头切换到Runner文件所在目录：

# 示例：假设Runner文件存放在.devcontainer/scripts/runner/下
cd ./.devcontainer/scripts/runner/

echo "Configure GitHub Runner"
./config.sh remove --token $SELF_HOSTED_RUNNER_TOKEN
# 后续配置、启动命令...

3. 验证环境变量在启动阶段的可用性 #

部分环境变量可能在postCreateCommand执行时还未完全注入。在脚本开头添加变量打印，排查是否为空：

echo "=== 检查环境变量 ==="
echo "SELF_HOSTED_RUNNER_TOKEN: $SELF_HOSTED_RUNNER_TOKEN"
echo "GITHUB_REPOSITORY: $GITHUB_REPOSITORY"
echo "RepositoryName: $RepositoryName"

如果变量为空，在.devcontainer.json中显式配置环境变量传递：

"remoteEnv": {
  "SELF_HOSTED_RUNNER_TOKEN": "${localEnv:SELF_HOSTED_RUNNER_TOKEN}",
  "GITHUB_REPOSITORY": "${localEnv:GITHUB_REPOSITORY}",
  "RepositoryName": "${localEnv:RepositoryName}"
}

4. 改用更可靠的进程管理方式 #

nohup在容器环境中可能因会话结束被回收，建议用supervisord管理Runner进程：

1. 在容器中安装supervisord：

apt-get update && apt-get install -y supervisor

2. 创建配置文件/etc/supervisor/conf.d/github-runner.conf：

[program:github-runner]
directory=/path/to/runner/directory
command=/path/to/runner/directory/run.sh
autostart=true
autorestart=true
stdout_logfile=/path/to/runner/directory/_diag/runner.log
stderr_logfile=/path/to/runner/directory/_diag/runner-error.log

3. 修改startup.sh，仅保留配置步骤，启动supervisord：

echo "Configure GitHub Runner"
./config.sh remove --token $SELF_HOSTED_RUNNER_TOKEN
./config.sh --url https://github.com/$GITHUB_REPOSITORY --unattended --token $SELF_HOSTED_RUNNER_TOKEN --name $RepositoryName --labels "self-hosted,Linux,X64,$RepositoryName"

# 启动进程管理器
supervisord -c /etc/supervisor/supervisord.conf

5. 调整命令执行时机 #

如果postStartCommand执行过早，容器未完全就绪，改用postAttachCommand（用户连接到Codespace后执行，环境更稳定）：

"postAttachCommand": ".devcontainer/scripts/startup.sh"

验证步骤 #

1. 修改配置后重新创建Codespace
2. 查看_diag/runner.log日志，排查是否有执行错误
3. 在仓库的Settings > Actions > Runners中查看Runner状态

内容的提问来源于stack exchange，提问作者Lukasz Dynowski