Skip to content

Improve pre-agent audit summary tree #50129

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
pelikhan merged 1 commit into from
Aug 4, 2026
+21 −12
Merged

Improve pre-agent audit summary tree #50129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 13 additions & 6 deletions actions/setup/sh/audit_pre_agent_workspace.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,25 +100,32 @@ list_dir() {
list_dir "gh-aw temp directory" "${RUNNER_TEMP}/gh-aw"
} > "${AUDIT_FILE}"

# Render the audit listing as a compact ASCII tree in a fenced code region.
# Render the audit listing as a collapsed, compact tree in the step summary.
render_summary_tree() {
local line
local label
echo "<details>"
echo "<summary>Pre-agent workspace audit</summary>"
echo
echo '```text'
while IFS= read -r line; do
case "${line}" in
"=== "*) echo "Pre-agent workspace audit" ;;
"=== "*) continue ;;
"--- "*": "*" ---")
echo "| |-- ${line#--- }"
label="${line#--- }"
echo "│ ├── ${label% ---}"
;;
"--- "*" ---")
echo "|-- ${line#--- }"
label="${line#--- }"
echo "├── ${label% ---}"
;;
"(not found)") echo "| | \-- ${line}" ;;
"(not found)") echo "│ │ └── ${line}" ;;
"") continue ;;
*) echo "| | \-- ${line}" ;;
*) echo "│ │ └── ${line}" ;;
Comment on lines +122 to +124
esac
done < "${AUDIT_FILE}"
echo '```'
echo "</details>"
}

LINE_COUNT="$(wc -l < "${AUDIT_FILE}" | tr -d ' ')"
Expand Down
14 changes: 8 additions & 6 deletions actions/setup/sh/audit_pre_agent_workspace_test.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,8 +108,8 @@ assert "node_modules excluded from listing" "! grep -q 'node_modules/some-pkg' /
assert "agent.md still listed despite node_modules sibling" "grep -q 'agent.md' /tmp/gh-aw/pre-agent-audit.txt"
echo ""

# ── Test 8: Step summary tree is rendered ──────────────────────────────────
echo "Test 8: Step summary contains an ASCII tree"
# ── Test 8: Collapsed step summary tree is rendered ─────────────────────────
echo "Test 8: Step summary contains a collapsed tree"
WORKSPACE="${TEST_ROOT}/workspace-8"
mkdir -p "${WORKSPACE}/.github/agents"
echo "agent" > "${WORKSPACE}/.github/agents/agent.md"
Expand All @@ -122,11 +122,13 @@ touch "${GH_OUT8}" "${SUMMARY8}"
GITHUB_WORKSPACE="${WORKSPACE}" HOME="${TEST_ROOT}/home8" RUNNER_TEMP="${TMPDIR}" GITHUB_OUTPUT="${GH_OUT8}" GITHUB_STEP_SUMMARY="${SUMMARY8}" bash "${SCRIPT_PATH}" >/dev/null 2>&1
assert "Summary uses a text code fence" "grep -Fq \"\${FENCE}text\" '${SUMMARY8}'"
assert "Summary closes the code fence" "grep -Fq \"\${FENCE}\" '${SUMMARY8}'"
assert "Summary contains the audit root" "grep -Fq 'Pre-agent workspace audit' '${SUMMARY8}'"
assert "Summary contains ASCII tree branches" "grep -Fq '|-- Copilot engine' '${SUMMARY8}'"
assert "Summary lists agent.md in the tree" "grep -Fq '\\-- ${WORKSPACE}/.github/agents/agent.md' '${SUMMARY8}'"
assert "Summary uses details" "grep -Fq '<details>' '${SUMMARY8}'"
assert "Summary closes details" "grep -Fq '</details>' '${SUMMARY8}'"
assert "Summary title is in the details summary" "grep -Fq '<summary>Pre-agent workspace audit</summary>' '${SUMMARY8}'"
assert "Summary contains tree branches" "grep -Fq '├── Copilot engine' '${SUMMARY8}'"
assert "Summary lists agent.md in the tree" "grep -Fq '└── ${WORKSPACE}/.github/agents/agent.md' '${SUMMARY8}'"
assert "Summary does not use a table" "! grep -Fq '| Section | Path | Size |' '${SUMMARY8}'"
assert "Summary does not use details" "! grep -Fq '<details>' '${SUMMARY8}'"
assert "Summary does not use ASCII branches" "! grep -Fq '|-- Copilot engine' '${SUMMARY8}'"
echo ""

# ── Test 9: Works without GITHUB_STEP_SUMMARY set ──────────────────────────
Expand Down