Documentation
¶
Overview ¶
Package github is a wrapper around the go Github client and API
Index ¶
- type Client
- func (c *Client) CheckGithubRateLimit()
- func (c *Client) CreateGithubIssue(org, repo, issue string) (out string)
- func (c *Client) GetArchive(org, repo, branch string) (*url.URL, string, error)
- func (c *Client) GetFile(org, repo, path string) ([]byte, string, error)
- func (c *Client) GetGithubUsers(org string) (out string)
- func (c *Client) Octocat(message string) string
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client is a wrapper for the github Client
func (*Client) CheckGithubRateLimit ¶
func (c *Client) CheckGithubRateLimit()
CheckGithubRateLimit returns the API Rate limit to the debug console https://github.com/google/go-github/blob/master/examples/repos/main.go
func (*Client) CreateGithubIssue ¶
CreateGithubIssue creates issues in github for the supplied repo
func (*Client) GetArchive ¶
GetArchive returns an Archive based on the repo and branch supplied
func (*Client) GetFile ¶
GetFile returns the contents of a file and the download URL of the file from a file within a github repository. A repository and path to a file must be supplied.
func (*Client) GetGithubUsers ¶
GetGithubUsers returns the usernames for all users in the github organization This can then be used in the assignee section of !git issue. This is useful if you don't know the github username of the person you'd like to assign the issue to.
Source Files