lib

Documentation

Index

• func ClientConnect(token string) *github.Client
• func CreateComment(token, owner, repository, body string, bid int)
• func CreateIssue(owner, repository, title, body string)
• func CreatePullRequest(owner, repository, title, body, head, base string)
• func CreateReview(token, owner, repository, body string, bid int) (bool, error)
• type Collaborators
  • func GetCollaborators(owner, repository, token string) *Collaborators
• type PullRequestInputData
  • func PullRequestData(githubrepo, githubref string) PullRequestInputData
• type PullRequestOutputData
  • func GetPullRequestData(githubrepo, githubref, token string) *PullRequestOutputData

Functions

func ClientConnect

func ClientConnect(token string) *github.Client

clientConnect Takens a token and uses this to establish a connection to github

func CreateComment

func CreateComment(token, owner, repository, body string, bid int)

CreateComment will create a comment on the pull request

func CreateIssue

func CreateIssue(owner, repository, title, body string)

CreateIssue will create an issue in a repository

func CreatePullRequest

func CreatePullRequest(owner, repository, title, body, head, base string)

CreatePullRequest will create a pull request in a repository

func CreateReview

func CreateReview(token, owner, repository, body string, bid int) (bool, error)

CreateReview will create a review on the pull request

Types

type Collaborators

type Collaborators struct {
	Collaborators []string
}

Collaborators is a struct to hold the data for a repository collaborators to be used in other functions and packages

func GetCollaborators

func GetCollaborators(owner, repository, token string) *Collaborators

GetCollaborators will get a list of collaborators for a repository

type PullRequestInputData

type PullRequestInputData struct {
	Owner,
	Repository string
	Bid int
}

Return values from pullRequestInfo

func PullRequestData

func PullRequestData(githubrepo, githubref string) PullRequestInputData

TODO: gather pull request data

type PullRequestOutputData

type PullRequestOutputData struct {
	ID int64
	Title,
	Body,
	State,
	URL,
	CommitID,
	User,
	Owner,
	Repository string
	Number,
	Commits int
}

PullRequestOutputData is a struct to hold the data for a pull request to be used in other functions and packages

func GetPullRequestData

func GetPullRequestData(githubrepo, githubref, token string) *PullRequestOutputData

GetPullRequestData will get the data for a pull request and return a struct