Documentation
¶
Overview ¶
Package issuemirror provides access to mirrored Github issue data, cached on the local filesystem.
For example, see https://github.com/bradfitz/go-issue-mirror.
Index ¶
- type Root
- func (r Root) ForeachIssue(fn func(*github.Issue) error) error
- func (r Root) ForeachIssueComment(issueNum int, fn func(*github.IssueComment) error) error
- func (r Root) Issue(num int) (*github.Issue, error)
- func (r Root) IssueComment(issueNum, commentID int) (*github.IssueComment, error)
- func (r Root) IssueCommentFile(issueNum, commentID int) string
- func (r Root) IssueCommentsDir(num int) string
- func (r Root) IssueJSONFile(num int) string
- func (r Root) NumComments(issueNum int) (int, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Root ¶
type Root string
Root is the root directory of a repo's issue mirror on disk.
func (Root) ForeachIssue ¶
ForeachIssue iterates over each cached github issue, in numeric order. It stops at the first error. fn is not run concurrently.
func (Root) ForeachIssueComment ¶
ForeachIssueComment iterates over each cached github issue comment for the provided issue number, in numeric order. It stops at the first error. fn is not run concurrently.
func (Root) IssueComment ¶
func (r Root) IssueComment(issueNum, commentID int) (*github.IssueComment, error)
IssueComment returns the github issue comment from its cached JSON file on disk.
func (Root) IssueCommentFile ¶
IssueCommentFile returns the path to the provided comment's JSON file metadata.
func (Root) IssueCommentsDir ¶
IssueCommentsDir returns the path to the provided issue number's directory of comments.
func (Root) IssueJSONFile ¶
IssueJSONFile returns the path to the provided issue number's JSON file metadata.
Source Files
Directories