Repository navigation
[docs] docs: unbloat troubleshooting/debugging.md - #72536
Merged
Merged
Conversation
github-actions
Bot
added
automation
doc-unbloat
documentation
This was referenced Oct 28, 2026
pelikhan
marked this pull request as ready for review
October 28, 2026 01:14
Contributor
Author
|
✅ Test Quality Sentinel completed test quality analysis. Test Quality SentinelOutcome: The agent completed and reported no action. A no-op output alone does not verify that all required work was completed or that publication was possible. Agent messages are omitted from this comment. The category uses structured run status, not interpretation of agent prose.
|
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The condensed guidance omits the stdin permission caveat, preference for inline JSON, and specific log comparisons needed to troubleshoot intermittently missing commands.
2 open issues
What changed in this PR
Condenses gh-aw’s debugging guide, focusing on failure-investigation reports and missing commands inside agent sandboxes. This is a documentation-only change.
Changes:
- Shortens failure-cluster selection, metadata, and statistics explanations.
- Tightens sandbox troubleshooting and consolidates safe-output payload, stdin, and shell-denial guidance.
- Leaves command examples unchanged.
| File | Description |
|---|---|
docs/src/content/docs/troubleshooting/debugging.md |
Condenses failure-analysis and sandbox troubleshooting prose. |
Review effort: Max
| `command not found` for `jq` or `safeoutputs` is different from an unavailable MCP tool. The setup message `Successfully copied ... safe-outputs files` confirms that server scripts were copied to the runner. It does not confirm that the CLI wrapper was mounted or that its interpreter and directory are available on the agent's `PATH`. | ||
|
|
||
| For intermittent failures, compare one successful and one failing run from the same workflow and deployment. Retain both run URLs, the gh-aw and engine versions, the exact `sandbox:` block, and the generated lock-file image, mounts, and `PATH` configuration. Compare setup, MCP startup, CLI mounting, and agent launch logs. Different self-hosted runner images, custom sandbox images, missing mounts, or shell startup files that reset `PATH` are possible causes, not proof of a provisioning race. | ||
| For intermittent failures, compare one successful and one failing run from the same workflow: run URLs, gh-aw and engine versions, the `sandbox:` block, and the lock file's image, mounts, and `PATH`. Different self-hosted runner images, custom sandbox images, missing mounts, or shell startup files that reset `PATH` are possible causes, not proof of a provisioning race. |
| For intermittent failures, compare one successful and one failing run from the same workflow: run URLs, gh-aw and engine versions, the `sandbox:` block, and the lock file's image, mounts, and `PATH`. Different self-hosted runner images, custom sandbox images, missing mounts, or shell startup files that reset `PATH` are possible causes, not proof of a provisioning race. | ||
|
|
||
| Check `command -v safeoutputs` in the **agent's shell** when permitted, not just in a runner setup step. If the CLI is unavailable, use direct safe-output MCP tools only when the engine exposes them. CLI payloads do not require a separate serializer: pass one single-quoted JSON object, encoding newlines as `\n`, double quotes as `\"`, backslashes as `\\`, and apostrophes as `\u0027`. Unicode can remain literal. | ||
| Check `command -v safeoutputs` in the **agent's shell** when permitted, not just in a runner setup step. If the CLI is unavailable, use direct safe-output MCP tools only when the engine exposes them. CLI payloads take one single-quoted JSON object (encode newlines as `\n`, double quotes as `\"`, backslashes as `\\`, apostrophes as `\u0027`), or stdin via `safeoutputs <tool_name> .`: |
This was referenced Oct 28, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Condensed
docs/src/content/docs/troubleshooting/debugging.md(one file). Reduction is modest, about 250 words (~10%), below the 20% target.All commands, links, and warnings are preserved.