home / skills / openai / skills / gh-fix-ci

gh-fix-ci skill

safe

This skill helps you diagnose and fix failing GitHub PR checks by inspecting logs and drafting a fix plan before applying changes.

npx playbooks add skill openai/skills --skill gh-fix-ci

Review the files below or copy the command above to add this skill to your agents.

Files (6)

SKILL.md

3.6 KB

---
name: "gh-fix-ci"
description: "Use when a user asks to debug or fix failing GitHub PR checks that run in GitHub Actions; use `gh` to inspect checks and logs, summarize failure context, draft a fix plan, and implement only after explicit approval. Treat external providers (for example Buildkite) as out of scope and report only the details URL."
---


# 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 "<path-to-skill>/scripts/inspect_pr_checks.py" --repo "." --pr "<number-or-url>"`
- Add `--json` if you want machine-friendly output for summarization.

## Workflow

1. 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.
2. 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.
3. Inspect failing checks (GitHub Actions only).
   - Preferred: run the bundled script (handles gh field drift and job-log fallbacks):
     - `python "<path-to-skill>/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>"`
4. 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.
5. Summarize failures for the user.
   - Provide the failing check name, run URL (if any), and a concise log snippet.
   - Call out missing logs explicitly.
6. Create a plan.
   - Use the `create-plan` skill to draft a concise plan and request approval.
7. Implement after approval.
   - Apply the approved plan, summarize diffs/tests, and ask about opening a PR.
8. 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 "<path-to-skill>/scripts/inspect_pr_checks.py" --repo "." --pr "123"`
- `python "<path-to-skill>/scripts/inspect_pr_checks.py" --repo "." --pr "https://github.com/org/repo/pull/123" --json`
- `python "<path-to-skill>/scripts/inspect_pr_checks.py" --repo "." --max-lines 200 --context 40`

Overview

This skill helps debug and fix failing GitHub PR checks that run in GitHub Actions. It uses the GitHub CLI (gh) to locate failing checks, fetch actionable logs, summarize the failure, and draft a concise fix plan. Implementation of any fix only proceeds after you explicitly approve the proposed plan.

How this skill works

The skill verifies gh authentication, resolves the target PR, and inspects failing checks. For GitHub Actions runs it pulls run and job logs, extracts a short failure snippet, and flags external providers by reporting their details URL only. It then drafts a remediation plan and waits for approval before making changes and rechecking status.

When to use it

A PR has failing GitHub Action checks and you need a diagnosis.
You want concise failure snippets and the run/job URLs to reproduce locally.
You need a concrete plan for fixing CI failures before changing code.
You want to avoid touching external CI providers (Buildkite, etc.).
You need an automated workflow that exits non-zero if failures remain.

Best practices

Authenticate with gh first (gh auth login) and confirm with gh auth status (repo + workflow scopes).
Prefer the bundled inspect_pr_checks.py script to handle gh field drift and log fallbacks.
If a check’s detailsUrl is not a GitHub Actions run, treat it as external and report only the URL. Do not attempt to fix external providers.
Always present a concise plan and ask for explicit approval before implementing changes.
After applying fixes, rerun gh pr checks and relevant tests and summarize diffs and test results.

Example use cases

Run the bundled script to collect failing check names, run URLs, and a short log snippet for a PR before triage.
Diagnose a flaky test by pulling the job logs and extracting the error context to propose either a code or test configuration change.
Triage CI failures across multiple jobs and produce a prioritized fix plan for approval.
Automate a CI gate that fails the pipeline if inspect_pr_checks finds unresolved failures (script exits non-zero).
Report third-party CI runs (e.g., Buildkite) by capturing their detailsURL for follow-up instead of attempting remediation.

FAQ

What if gh is not authenticated?

I will ask you to run gh auth login and then gh auth status. The skill requires repo + workflow scopes to fetch Actions runs and logs.

Can this fix Buildkite or other external CI failures?

No. External providers are out of scope; I will report the details URL so you can inspect them with the appropriate tooling.