AgentSkillsCN

gh-issue-comment

适用于将调查结果、审查摘要或事故报告记录为 GitHub Issues 上的评论时。

SKILL.md
--- frontmatter
name: gh-issue-comment
description: >-
  Use when recording investigation results, review summaries, or incident
  reports as comments on GitHub Issues.
user-invocable: true
disable-model-invocation: false

Issue Comment

Overview

Post a structured comment to a GitHub Issue with a visible summary and zero or more collapsible details sections. The script enforces the output format via jq validation; the AI composes content, confirms with the user, then posts.

Execution order: compose content -> confirm with user -> post comment. Execute the script from the git repository root, not from the skill directory.

Input

  • •repo: string (required): Target repository, passed as --repo OWNER/REPO.
  • •issue_number: number (required): Target issue number, passed as --issue NUMBER.
  • •summary: string (required, markdown): Visible summary for the comment body. Keep it self-contained so the reader can understand the conclusion and next actions without expanding details.
  • •details: array<{ label: string, content: string }>: Optional collapsible sections passed in stdin JSON. Each entry uses label: string (required) for the <summary> text and content: string (required, markdown) for the section body.

Content is provided via stdin JSON:

json
{
  "summary": "string",
  "details": [{ "label": "string", "content": "string" }]
}

If details is omitted or empty, a summary-only comment is posted.

Output

  • •url: string: URL of the posted comment returned by gh issue comment.

Operations

Compose Content

Prepare summary and details from investigation results, review findings, or incident analysis. The summary must be self-contained, while each details entry should capture one evidence set, analysis thread, or supporting report section.

Confirm with User

Present the composed summary and details to the user and get explicit approval before posting. Do not post without that confirmation.

Post Comment

Run scripts/post-comment.sh with --repo OWNER/REPO and --issue NUMBER. Pipe the composed JSON payload (matching the Input schema) through stdin.

The script validates the JSON, assembles the comment body, and posts via gh issue comment. On success it prints the comment URL to stdout.

For multi-details and summary-only patterns, see references/examples.md.

Examples

  • •Happy: investigation results are composed into a 5-line summary plus two details sections, the user approves the content, and the comment is posted with a returned URL.
  • •Failure: summary is empty in the stdin JSON payload -- validation fails and the comment is not posted.