Skip to content

Trap EXIT to deregister runner when runner exits by itself #582

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jonathan528i wants to merge 6 commits into
base: master
Choose a base branch
from
+39 −2
Open

Trap EXIT to deregister runner when runner exits by itself #582

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
061cdb1
Trap EXIT
jonathan528i Apr 8, 2026
2b0b6b4
switch to using goss
jonathan528i Apr 8, 2026
3b95600
remove accidental inclusion
jonathan528i Apr 8, 2026
158fbe8
Add new line at end of file per lint analyzer
jonathan528i Apr 10, 2026
5e8e866
Make the exit code consistent across different bash environments
jonathan528i Apr 10, 2026
7c060c5
Use long time out to allow arm targets to pass
jonathan528i Apr 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .github/workflows/test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,17 @@ jobs:
if [ $? -ne 0 ]; then
exit 1
fi
# test the EXIT trap on process crash
GOSS_VARS=goss_vars_${GH_RUNNER_IMAGE}.yaml GOSS_FILE=goss_trap_exit.yaml GOSS_SLEEP=1 dgoss run --entrypoint /usr/bin/sleep \
-e DEBUG_ONLY=false \
-e REPO_URL=https://github.com/fake/repo \
-e RUNNER_TOKEN=faketoken \
-e RUN_AS_ROOT=true \
-e DISABLE_AUTOMATIC_DEREGISTRATION=false \
${GH_RUNNER_IMAGE} 10
if [ $? -ne 0 ]; then
exit 1
fi
debian_tests:
runs-on: ubuntu-latest
strategy:
Expand Down Expand Up @@ -233,3 +244,14 @@ jobs:
-e EPHEMERAL=true \
-e DISABLE_AUTO_UPDATE=true \
${GH_RUNNER_IMAGE} 10
# test the EXIT trap on process crash
GOSS_VARS=goss_vars_${GH_RUNNER_IMAGE}.yaml GOSS_FILE=goss_trap_exit.yaml GOSS_SLEEP=1 dgoss run --entrypoint /usr/bin/sleep \
-e DEBUG_ONLY=false \
-e REPO_URL=https://github.com/fake/repo \
-e RUNNER_TOKEN=faketoken \
-e RUN_AS_ROOT=true \
-e DISABLE_AUTOMATIC_DEREGISTRATION=false \
${GH_RUNNER_IMAGE} 10
if [ $? -ne 0 ]; then
exit 1
fi
9 changes: 7 additions & 2 deletions entrypoint.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ trap_with_arg() {
}

deregister_runner() {
COMMAND_EXIT_CODE=$?
Copy link
Copy Markdown
Owner

@myoung34 myoung34 Apr 15, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the issue here is 2 things:

  • that EXIT doesnt trap signals
  • qemu is doing something differently with how EXIT works here (why arm64 only, cant confirm what though)
Suggested change
COMMAND_EXIT_CODE=$?
local COMMAND_EXIT_CODE="${1:-EXIT}"
echo "Caught ${COMMAND_EXIT_CODE} - Deregistering runner"

echo "Caught $1 - Deregistering runner"
if [[ -n "${ACCESS_TOKEN}" ]]; then
# If using GitHub App authentication, refresh the access token before deregistration
Expand All @@ -40,7 +41,11 @@ deregister_runner() {
fi
./config.sh remove --token "${RUNNER_TOKEN}"
[[ -f "/actions-runner/.runner" ]] && rm -f /actions-runner/.runner
exit

# Simply calling `exit` on different environments will either return the exit code of the passed-in $@ command, or
# the exit code of the last executed command in this function. To ensure that the behavior is consistent, we always
# return the exit code of the passed-in command, which is stored in COMMAND_EXIT_CODE.
exit ${COMMAND_EXIT_CODE}
}

_DEBUG_ONLY=${DEBUG_ONLY:-false}
Expand Down Expand Up @@ -236,7 +241,7 @@ fi

if [[ ${_DISABLE_AUTOMATIC_DEREGISTRATION} == "false" ]]; then
if [[ ${_DEBUG_ONLY} == "false" ]]; then
trap_with_arg deregister_runner SIGINT SIGQUIT SIGTERM INT TERM QUIT
trap_with_arg deregister_runner SIGINT SIGQUIT SIGTERM INT TERM QUIT EXIT
fi
fi

Expand Down
10 changes: 10 additions & 0 deletions goss_trap_exit.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
command:
/entrypoint.sh /bin/bash -c "exit 1":
exit-status: 1
stdout:
- "Runner reusage is disabled"
- "Caught EXIT - Deregistering runner"
# We need to run this test with DEBUG_ONLY=false in order for entrypoint.sh to set up the trap.
# DEBUG_ONLY causes configure runner to run, which runs the .NET runtime. Running the .NET runtime
# is very slow when emulating arm64 on x86_64, so we need to use a longer timeout for this test to pass on arm64.
timeout: 120000
Loading