You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: add comprehensive documentation for summary attachments feature
Adds detailed documentation section explaining the summary attachments feature
including:
- Configuration options and their defaults
- What gets included in each type of summary
- Markdown examples showing dispatched and running comments
- When to enable/disable the feature
- Workflow integration guide for status.json
Complements the implementation from the previous commit.
Co-authored-by: Shelley <shelley@exe.dev>
Copy file name to clipboardExpand all lines: modules/gh-pm/README.md
+139Lines changed: 139 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -157,6 +157,145 @@ backend = "shelley"
157
157
model = "claude-sonnet-4.5"
158
158
```
159
159
160
+
## Summary Attachments in GitHub Comments
161
+
162
+
By default, gh-pm posts minimal status comments to GitHub issues. You can optionally enable **summary attachments** to include detailed analysis breakdowns and execution progress directly in the comments.
163
+
164
+
### Configuration
165
+
166
+
Add these settings to your `~/.gh-pm/gh-pm.toml`:
167
+
168
+
```toml
169
+
[settings]
170
+
# Enable summary attachments (default: false)
171
+
attach_summaries = true
172
+
173
+
# Include LLM analysis breakdown in dispatch comments (default: true when attach_summaries=true)
174
+
summary_analyze = true
175
+
176
+
# Include execution progress in status update comments (default: true when attach_summaries=true)
177
+
summary_running = true
178
+
179
+
# Summary display format: "detailed" or "compact" (default: "detailed")
180
+
summary_format = "detailed"
181
+
182
+
# Wrap summaries in collapsible <details> sections (default: true)
183
+
summary_use_collapsible = true
184
+
185
+
# Maximum summary length in characters (default: 10000)
gh-pm will automatically include this summary in status update comments when `summary_running = true`.
298
+
160
299
## Using Shelley as LLM Backend
161
300
162
301
On [exe.dev](https://exe.dev) VMs, you can use **shelley** as your LLM backend. Shelley is a local AI agent that runs on the same host, eliminating the need for external API keys and enabling fully offline operation.
0 commit comments