Documentation
¶
Overview ¶
Package github contains code that is for interacting with the GitHub API and the Actions interfaces.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Action ¶
type Action interface {
Context() (*githubactions.GitHubContext, error)
GetInput(string) string
Debugf(message string, args ...any)
Infof(message string, args ...any)
Warningf(message string, args ...any)
Errorf(message string, args ...any)
Fatalf(message string, args ...any)
}
Action is an interface that mirrors the functionality exposed by the github.com/sethvargo/go-githubactions library's root client.
type Client ¶
type Client interface {
CreateCommentFromOutput(ctx context.Context, planOutput []string, path string) (*github.IssueComment, *github.Response, error)
}
Client is an interface mirroring the internal GitHub wrapper client.
type IssueService ¶
type IssueService interface {
CreateComment(ctx context.Context, owner string, repo string, number int, comment *github.IssueComment) (*github.IssueComment, *github.Response, error)
EditComment(ctx context.Context, owner string, repo string, commentID int64, comment *github.IssueComment) (*github.IssueComment, *github.Response, error)
ListComments(ctx context.Context, owner string, repo string, number int, opts *github.IssueListCommentsOptions) ([]*github.IssueComment, *github.Response, error)
DeleteComment(ctx context.Context, owner string, repo string, commentID int64) (*github.Response, error)
}
IssueService is a wrapper around the GitHub IssueService exposed by "github.com/google/go-github/
type PullRequestService ¶
type PullRequestService interface {
CreateComment(ctx context.Context, owner string, repo string, number int, comment *github.PullRequestComment) (*github.PullRequestComment, *github.Response, error)
}
PullRequestService is a wrapper around the GitHub PullRequestService exposed by "github.com/google/go-github/
Click to show internal directories.
Click to hide internal directories.