Skip to content

docs(#843): document event_payload for run-to-PR correlation - #846

Open
fullsend-ai-coder[bot] wants to merge 1 commit into
mainfrom
agent/843-document-event-payload
Open

docs(#843): document event_payload for run-to-PR correlation#846
fullsend-ai-coder[bot] wants to merge 1 commit into
mainfrom
agent/843-document-event-payload

Conversation

@fullsend-ai-coder

Copy link
Copy Markdown
Contributor

Summary

  • Adds a "Correlating dispatch-repo runs to source-repo PRs" subsection to the "Reading agent logs and artifacts" section in skills/retro-analysis/SKILL.md
  • Documents that dispatch-repo run logs contain event_payload JSON with pull_request.head.sha, pull_request.number, and pull_request.base.ref for direct run-to-PR/commit mapping
  • Includes a gh run view CLI example for extracting the payload

Context

PR #540 spent 7 review rounds building increasingly complex timestamp-based and branch-name-grep workarounds for run-to-PR correlation, only to discover in round 7 that event_payload provides the mapping directly. This change documents that method in the general tracing section so future agents and skill authors find it upfront.

Complementary to PR #834, which adds event_payload usage within the new flapping-detection section — this covers the general log-reading guidance used by all retro tasks.

Testing

  • Verified the new subsection is positioned after the existing artifact-download code block and before the "Exploration strategy" section
  • Confirmed no duplication with PR feat(retro): add flapping detection to retro analysis skill #834's flapping-detection section (different sections, different purposes)
  • Doc linter (hack/lint-agent-docs) passes
  • Secret scan passes

Closes #843

Post-script verification

  • Branch is not main/master (agent/843-document-event-payload)
  • Secret scan passed (gitleaks — 1a3086f5512b3700ab8e081c689cc7586c9af20f..HEAD)
  • PR body secret scan passed (gitleaks — no-git)

Add a "Correlating dispatch-repo runs to source-repo PRs"
subsection to the "Reading agent logs and artifacts" section
in the retro-analysis skill. This documents that dispatch-repo
run logs contain event_payload JSON with pull_request.head.sha,
pull_request.number, and pull_request.base.ref — fields that
provide direct run-to-PR/commit mapping without timestamp
heuristics or branch-name grep workarounds.

Includes a gh run view CLI example for extracting the payload.
Complementary to PR #834, which uses event_payload within the
new flapping-detection section — this covers the general
tracing guidance used by all retro tasks.

Closes #843
@fullsend-ai-coder
fullsend-ai-coder Bot requested a review from a team as a code owner August 17, 2026 13:06
@fullsend-ai-review

fullsend-ai-review Bot commented Aug 17, 2026

Copy link
Copy Markdown

🤖 Finished Review · ✅ Success · Started 1:07 PM UTC · Completed 1:18 PM UTC

Commit: c234e6c · View workflow run →

@fullsend-ai-review

Copy link
Copy Markdown

Review

Findings

Medium

Low

  • [edge-case] skills/retro-analysis/SKILL.md:91 — The grep -o 'event_payload.*' command captures from event_payload to end-of-line only. If the event_payload JSON in the log is spread across multiple lines, only the first line would be captured. GitHub Actions structured logs typically use single-line entries, making this unlikely in practice, but the command differs from a jq-based approach that would handle multi-line JSON.

Labels: PR is a documentation-only change to a skill file

@fullsend-ai-review fullsend-ai-review Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

See the review comment for full details.

- `pull_request.number` — the source-repo PR number
- `pull_request.base.ref` — the target branch of the PR

```bash

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

[low] edge-case

The grep -o 'event_payload.*' command captures from event_payload to end-of-line only. If the event_payload JSON in the log is spread across multiple lines, only the first line would be captured. GitHub Actions structured logs typically use single-line entries, making this unlikely in practice.

Suggested fix: Consider adding a note that the command assumes single-line JSON log entries, or suggest jq for structured extraction if multi-line output is possible.

@fullsend-ai-review fullsend-ai-review Bot added requires-manual-review Review requires human judgment documentation Improvements or additions to documentation labels Aug 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation ready-for-review requires-manual-review Review requires human judgment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Retro-analysis skill should document event_payload for run-to-PR/commit correlation

0 participants