Gh Pr Checks Plan Fix
Overview
Use gh to locate failing PR checks, fetch GitHub Actions logs for actionable failures, summarize the failure snippet, then propose a fix plan and implement after explicit approval.
- If a plan-oriented skill (for example
create-plan) is available, use it; otherwise draft a concise plan inline and request approval before implementing.
Prereq: authenticate with the standard GitHub CLI once (for example, run gh auth login), then confirm with gh auth status (repo + workflow scopes are typically required).
Inputs
repo: path inside the repo (default .)
pr: PR number or URL (optional; defaults to current branch PR)
gh authentication for the repo host
Quick start
python "{baseDir}/scripts/inspect_pr_checks.py" --repo "." --pr "<number-or-url>"
- Add
--json if you want machine-friendly output for summarization.
Workflow
- Verify gh authentication.
- Run
gh auth status in the repo.
- If unauthenticated, ask the user to run
gh auth login (ensuring repo + workflow scopes) before proceeding.
- Resolve the PR.
- Prefer the current branch PR:
gh pr view --json number,url.
- If the user provides a PR number or URL, use that directly.
- Inspect failing checks (GitHub Actions only).
- Preferred: run the bundled script (handles gh field drift and job-log fallbacks):
python "{baseDir}/scripts/inspect_pr_checks.py" --repo "." --pr "<number-or-url>"
- Add
--json for machine-friendly output.
- Manual fallback:
gh pr checks <pr> --json name,state,bucket,link,startedAt,completedAt,workflow
- If a field is rejected, rerun with the available fields reported by
gh.
- For each failing check, extract the run id from
detailsUrl and run:
gh run view <run_id> --json name,workflowName,conclusion,status,url,event,headBranch,headSha
gh run view <run_id> --log
- If the run log says it is still in progress, fetch job logs directly:
gh api "/repos/<owner>/<repo>/actions/jobs/<job_id>/logs" > "<path>"
- Scope non-GitHub Actions checks.
- If
detailsUrl is not a GitHub Actions run, label it as external and only report the URL.
- Do not attempt Buildkite or other providers; keep the workflow lean.
- Summarize failures for the user.
- Provide the failing check name, run URL (if any), and a concise log snippet.
- Call out missing logs explicitly.
- Create a plan.
- Use the
create-plan skill to draft a concise plan and request approval.
- Implement after approval.
- Apply the approved plan, summarize diffs/tests, and ask about opening a PR.
- Recheck status.
- After changes, suggest re-running the relevant tests and
gh pr checks to confirm.
Bundled Resources
scripts/inspect_pr_checks.py
Fetch failing PR checks, pull GitHub Actions logs, and extract a failure snippet. Exits non-zero when failures remain so it can be used in automation.
Usage examples:
python "{baseDir}/scripts/inspect_pr_checks.py" --repo "." --pr "123"
python "{baseDir}/scripts/inspect_pr_checks.py" --repo "." --pr "https://github.com/org/repo/pull/123" --json
python "{baseDir}/scripts/inspect_pr_checks.py" --repo "." --max-lines 200 --context 40
When to Use
When NOT to Use
1---
2name: openai-gh-fix-ci
3description: Use when a user asks to debug or fix failing GitHub PR checks that run in GitHub Actions;
4 use `gh` to inspect checks and logs, summarize failure context, draft a fix plan, and implement only
5 after explicit approval. Treat external providers (for example Buildkite) as out of scope and report
6 only the details URL. Originally from OpenAI's curated skills catalog.
7allowed-tools:
8- Bash
9- Read
10- Grep
11- Glob
12- Write
13- Edit
14metadata:
15 source: https://skillmd.com/skills/trailofbits/openai-gh-fix-ci
16---
17
18# Gh Pr Checks Plan Fix
19
20## Overview
21
22Use gh to locate failing PR checks, fetch GitHub Actions logs for actionable failures, summarize the failure snippet, then propose a fix plan and implement after explicit approval.
23- If a plan-oriented skill (for example `create-plan`) is available, use it; otherwise draft a concise plan inline and request approval before implementing.
24
25Prereq: authenticate with the standard GitHub CLI once (for example, run `gh auth login`), then confirm with `gh auth status` (repo + workflow scopes are typically required).
26
27## Inputs
28
29- `repo`: path inside the repo (default `.`)
30- `pr`: PR number or URL (optional; defaults to current branch PR)
31- `gh` authentication for the repo host
32
33## Quick start
34
35- `python "{baseDir}/scripts/inspect_pr_checks.py" --repo "." --pr "<number-or-url>"`
36- Add `--json` if you want machine-friendly output for summarization.
37
38## Workflow
39
401. Verify gh authentication.
41 - Run `gh auth status` in the repo.
42 - If unauthenticated, ask the user to run `gh auth login` (ensuring repo + workflow scopes) before proceeding.
432. Resolve the PR.
44 - Prefer the current branch PR: `gh pr view --json number,url`.
45 - If the user provides a PR number or URL, use that directly.
463. Inspect failing checks (GitHub Actions only).
47 - Preferred: run the bundled script (handles gh field drift and job-log fallbacks):
48 - `python "{baseDir}/scripts/inspect_pr_checks.py" --repo "." --pr "<number-or-url>"`
49 - Add `--json` for machine-friendly output.
50 - Manual fallback:
51 - `gh pr checks <pr> --json name,state,bucket,link,startedAt,completedAt,workflow`
52 - If a field is rejected, rerun with the available fields reported by `gh`.
53 - For each failing check, extract the run id from `detailsUrl` and run:
54 - `gh run view <run_id> --json name,workflowName,conclusion,status,url,event,headBranch,headSha`
55 - `gh run view <run_id> --log`
56 - If the run log says it is still in progress, fetch job logs directly:
57 - `gh api "/repos/<owner>/<repo>/actions/jobs/<job_id>/logs" > "<path>"`
584. Scope non-GitHub Actions checks.
59 - If `detailsUrl` is not a GitHub Actions run, label it as external and only report the URL.
60 - Do not attempt Buildkite or other providers; keep the workflow lean.
615. Summarize failures for the user.
62 - Provide the failing check name, run URL (if any), and a concise log snippet.
63 - Call out missing logs explicitly.
646. Create a plan.
65 - Use the `create-plan` skill to draft a concise plan and request approval.
667. Implement after approval.
67 - Apply the approved plan, summarize diffs/tests, and ask about opening a PR.
688. Recheck status.
69 - After changes, suggest re-running the relevant tests and `gh pr checks` to confirm.
70
71## Bundled Resources
72
73### scripts/inspect_pr_checks.py
74
75Fetch failing PR checks, pull GitHub Actions logs, and extract a failure snippet. Exits non-zero when failures remain so it can be used in automation.
76
77Usage examples:
78- `python "{baseDir}/scripts/inspect_pr_checks.py" --repo "." --pr "123"`
79- `python "{baseDir}/scripts/inspect_pr_checks.py" --repo "." --pr "https://github.com/org/repo/pull/123" --json`
80- `python "{baseDir}/scripts/inspect_pr_checks.py" --repo "." --max-lines 200 --context 40`
81
82## When to Use
83
84<!-- TODO: review -->
85
86## When NOT to Use
87
88<!-- TODO: review -->
89