Skip to content

UX Improvements for GitHub Actions Test Output #35

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

Merged
merged 2 commits into from
Jul 28, 2025
Merged

UX Improvements for GitHub Actions Test Output #35

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
783315f
treadmill-ci: print names of failed tests in error message
lschuermann Jul 26, 2025
beaadac
treadmill-ci: group output by test in GitHub actions
lschuermann Jul 26, 2025
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
18 changes: 14 additions & 4 deletions .github/workflows/treadmill-ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,7 @@ jobs:
cd ./hwci
source ./.venv/bin/activate

STEP_FAIL=0
FAILED_TESTS=""

# Generate a summary of all the tests executed:
cat <<GITHUB_STEP_SUMMARY >>"$GITHUB_STEP_SUMMARY"
Expand All @@ -277,6 +277,9 @@ jobs:
while read TEST; do
# WHILE ---------->

# Open a new "group" in the GitHub actions output for this test:
echo "::group::Test ${TEST}"

# For markdown links, we want a sanitized test name without special characters
SANITIZED_TEST_NAME="${TEST//[^[:alnum:]]/_}"

Expand All @@ -302,7 +305,11 @@ jobs:
else
echo "===== Test $TEST failed! ====="
echo "| ❌ | \`$TEST\` ([Output](#test-$SANITIZED_TEST_NAME)) |" >>"$GITHUB_STEP_SUMMARY"
STEP_FAIL=1

# Append this test to the list of failed tests (prefixing
# it with a comma, if other tests have already failed:
test -n "${FAILED_TESTS}" && FAILED_TESTS="${FAILED_TESTS}, "
FAILED_TESTS="${FAILED_TESTS}${TEST}"
fi

# Sanitize the output (remove triple backslashes) and copy it into the step summary details:
Expand All @@ -316,6 +323,9 @@ jobs:

STEP_SUMMARY_DETAILS

# Close the "group" in the GitHub actions output:
echo "::endgroup::"

# -----------> DONE
done < <(echo "$JSON_TEST_ARRAY" | jq -r -c '.[]')

Expand All @@ -324,8 +334,8 @@ jobs:
cat "./step-summary-details.txt" >>"$GITHUB_STEP_SUMMARY"

# Exit with an error if at least one test failed:
if [ "$STEP_FAIL" != "0" ]; then
echo "At least one test failed, exiting with error."
if [ "$FAILED_TESTS" != "" ]; then
echo "One or more tests failed, exiting with error: $FAILED_TESTS"
exit 1
fi

Expand Down