CSUBST GitHub Issue Reporting
Overview
Publish high-signal issue updates with reproducible commands, artifact paths, and parity conclusions, while handling transient gh failures safely.
Workflow
- •Resolve the target issue explicitly with
gh issue view <id>. - •Gather factual evidence before drafting:
- •branch and commit hash
- •exact command lines used
- •output file paths
- •parity hashes or metric summaries
- •Draft the comment in
/tmp/<issue>_<topic>.md. - •Post with
gh issue comment <id> --repo kfuku52/csubst --body-file <file>. - •If
ghfails with network/TLS/API transient errors, retry the same command. - •Close an issue only after fix commits are on remote and the comment includes commit and version.
Frequent Failure Points
- •Posting to the wrong issue:
- •Validate title and state with
gh issue viewbefore commenting.
- •Validate title and state with
- •Losing structured evidence in ad-hoc comments:
- •Use a file-based template and include sections.
- •Treating transient API failures as hard failures:
- •Retry when errors mention TLS handshake timeout or connection errors.
- •Closing issues without traceable fix:
- •Include branch, commit SHA, version, and validation summary in the closing comment.
Resource
- •Read
references/issue-comment-template.mdand use it as the default issue update format.