tasks

Documentation

Index

• func AddPagingQueryToUrl(url string) string
• func CollectChildrenOnCommits(owner string, repositoryName string, repositoryId int, ...)
• func CollectChildrenOnIssues(owner string, repositoryName string, repositoryId int, ...) error
• func CollectChildrenOnPullRequests(owner string, repositoryName string, repositoryId int, ...) error
• func CollectCommit(owner string, repositoryName string, repositoryId int, ...) error
• func CollectCommits(owner string, repositoryName string, repositoryId int, ...) error
• func CollectIssueComments(owner string, repositoryName string, issue *models.GithubIssue, ...) error
• func CollectIssueEvents(owner string, repositoryName string, issue *models.GithubIssue, ...) error
• func CollectIssueLabelsForSingleIssue(owner string, repositoryName string, issue *models.GithubIssue, ...) error
• func CollectIssueLabelsForSinglePullRequest(owner string, repositoryName string, pr *models.GithubPullRequest, ...) error
• func CollectIssues(owner string, repositoryName string, repositoryId int, ...) error
• func CollectPullRequest(owner string, repositoryName string, repositoryId int, ...) error
• func CollectPullRequestComments(owner string, repositoryName string, pull *models.GithubPullRequest, ...) error
• func CollectPullRequestCommits(owner string, repositoryName string, pull *models.GithubPullRequest, ...) error
• func CollectPullRequestReviews(owner string, repositoryName string, repositoryId int, ...) error
• func CollectRepository(owner string, repositoryName string) (int, error)
• func CollectRepositoryIssueLabels(owner string, repositoryName string, scheduler *utils.WorkerScheduler) error
• func RunConcurrently(resourceUriFormat string, pageSize int, conc int, ...) error
• type ApiCommitsResponse
• type ApiIssueCommentResponse
• type ApiIssueEventResponse
• type ApiIssueLabelResponse
• type ApiIssuesResponse
• type ApiPullRequestCommentResponse
• type ApiPullRequestCommitResponse
• type ApiPullRequestReviewResponse
• type ApiRepositoryResponse
• type ApiSingleCommitResponse
• type ApiSinglePullResponse
• type Commit
• type CommitsResponse
• type GithubApiClient
  • func CreateApiClient() *GithubApiClient
  • func (githubApiClient *GithubApiClient) FetchWithPaginationAnts(resourceUri string, pageSize int, conc int, scheduler *utils.WorkerScheduler, ...) error
• type GithubPaginationHandler
• type IssueComment
• type IssueEvent
• type IssueLabel
• type IssuesResponse
• type PrCommit
• type PrCommitsResponse
• type Pull
• type PullRequestComment
• type PullRequestReview

Functions

func AddPagingQueryToUrl

func AddPagingQueryToUrl(url string) string

func CollectChildrenOnCommits

func CollectChildrenOnCommits(owner string, repositoryName string, repositoryId int, scheduler *utils.WorkerScheduler)

func CollectChildrenOnIssues

func CollectChildrenOnIssues(owner string, repositoryName string, repositoryId int, scheduler *utils.WorkerScheduler) error

func CollectChildrenOnPullRequests

func CollectChildrenOnPullRequests(owner string, repositoryName string, repositoryId int, scheduler *utils.WorkerScheduler) error

func CollectCommit

func CollectCommit(owner string, repositoryName string, repositoryId int, commit *models.GithubCommit) error

func CollectCommits

func CollectCommits(owner string, repositoryName string, repositoryId int, scheduler *utils.WorkerScheduler) error

func CollectIssueComments

func CollectIssueComments(owner string, repositoryName string, issue *models.GithubIssue, scheduler *utils.WorkerScheduler) error

func CollectIssueEvents

func CollectIssueEvents(owner string, repositoryName string, issue *models.GithubIssue, scheduler *utils.WorkerScheduler) error

func CollectIssueLabelsForSingleIssue

func CollectIssueLabelsForSingleIssue(owner string, repositoryName string, issue *models.GithubIssue, scheduler *utils.WorkerScheduler) error

func CollectIssueLabelsForSinglePullRequest

func CollectIssueLabelsForSinglePullRequest(owner string, repositoryName string, pr *models.GithubPullRequest, scheduler *utils.WorkerScheduler) error

func CollectIssues

func CollectIssues(owner string, repositoryName string, repositoryId int, scheduler *utils.WorkerScheduler) error

func CollectPullRequest

func CollectPullRequest(owner string, repositoryName string, repositoryId int, pr *models.GithubPullRequest) error

func CollectPullRequestComments

func CollectPullRequestComments(owner string, repositoryName string, pull *models.GithubPullRequest, scheduler *utils.WorkerScheduler) error

func CollectPullRequestCommits

func CollectPullRequestCommits(owner string, repositoryName string, pull *models.GithubPullRequest, scheduler *utils.WorkerScheduler) error

func CollectPullRequestReviews

func CollectPullRequestReviews(owner string, repositoryName string, repositoryId int, pull *models.GithubPullRequest, scheduler *utils.WorkerScheduler) error

func CollectRepository

func CollectRepository(owner string, repositoryName string) (int, error)

func CollectRepositoryIssueLabels

func CollectRepositoryIssueLabels(owner string, repositoryName string, scheduler *utils.WorkerScheduler) error

func RunConcurrently

func RunConcurrently(resourceUriFormat string, pageSize int, conc int, scheduler *utils.WorkerScheduler, handler GithubPaginationHandler) error

This method exists in the case where we do not know how many pages of data we have to fetch This loops through the data in chunks of `conc` and if there is any request in there with no data returned, we assume we are at the end of the data required to fetch This is needed since we do not want to make a request to get the paging details first since the rate limit for github is so low

Types

type ApiCommitsResponse

type ApiCommitsResponse []CommitsResponse

type ApiIssueCommentResponse

type ApiIssueCommentResponse []IssueComment

type ApiIssueEventResponse

type ApiIssueEventResponse []IssueEvent

type ApiIssueLabelResponse

type ApiIssueLabelResponse []IssueLabel

type ApiIssuesResponse

type ApiIssuesResponse []IssuesResponse

type ApiPullRequestCommentResponse

type ApiPullRequestCommentResponse []PullRequestComment

type ApiPullRequestCommitResponse

type ApiPullRequestCommitResponse []PrCommitsResponse

type ApiPullRequestReviewResponse

type ApiPullRequestReviewResponse []PullRequestReview

type ApiRepositoryResponse

type ApiRepositoryResponse struct {
	Name     string `json:"name"`
	GithubId int    `json:"id"`
	HTMLUrl  string `json:"html_url"`
}

type ApiSingleCommitResponse

type ApiSingleCommitResponse struct {
	Stats struct {
		Additions int
		Deletions int
	}
}

type ApiSinglePullResponse

type ApiSinglePullResponse struct {
	Additions      int
	Deletions      int
	Comments       int
	Commits        int
	ReviewComments int `json:"review_comments"`
	Merged         bool
}

type Commit

type Commit struct {
	Author struct {
		Name  string
		Email string
		Date  string
	}
	Committer struct {
		Name  string
		Email string
		Date  string
	}
	Message string
}

type CommitsResponse

type CommitsResponse struct {
	Sha    string `json:"sha"`
	Commit Commit
	Url    string
}

type GithubApiClient

type GithubApiClient struct {
	core.ApiClient
}

func CreateApiClient

func CreateApiClient() *GithubApiClient

func (*GithubApiClient) FetchWithPaginationAnts

func (githubApiClient *GithubApiClient) FetchWithPaginationAnts(resourceUri string, pageSize int, conc int, scheduler *utils.WorkerScheduler, handler GithubPaginationHandler) error

run all requests in an Ants worker pool conc - number of concurent requests you want to run

type GithubPaginationHandler

type GithubPaginationHandler func(res *http.Response) error

type IssueComment

type IssueComment struct {
	GithubId int `json:"id"`
	Body     string
	User     struct {
		Login string
	}
}

type IssueEvent

type IssueEvent struct {
	GithubId int `json:"id"`
	Event    string
	Actor    struct {
		Login string
	}
	CreatedAt string `json:"created_at"`
}

type IssueLabel

type IssueLabel struct {
	GithubId    int `json:"id"`
	Name        string
	Description string
	Color       string
}

type IssuesResponse

type IssuesResponse struct {
	GithubId    int `json:"id"`
	Number      int
	State       string
	Title       string
	Body        string
	PullRequest struct {
		Url     string `json:"url"`
		HtmlUrl string `json:"html_url"`
	} `json:"pull_request"`
	ClosedAt        string `json:"closed_at"`
	GithubCreatedAt string `json:"created_at"`
	GithubUpdatedAt string `json:"updated_at"`
}

type PrCommit

type PrCommit struct {
	Author struct {
		Name  string
		Email string
		Date  string
	}
	Committer struct {
		Name  string
		Email string
		Date  string
	}
	Message string
}

type PrCommitsResponse

type PrCommitsResponse struct {
	Sha    string `json:"sha"`
	Commit PrCommit
	Url    string
}

type Pull

type Pull struct {
	GithubId        int `json:"id"`
	State           string
	Title           string
	Number          int
	CommentsUrl     string `json:"comments_url"`
	CommitsUrl      string `json:"commits_url"`
	HTMLUrl         string `json:"html_url"`
	MergedAt        string `json:"merged_at"`
	GithubCreatedAt string `json:"created_at"`
	ClosedAt        string `json:"closed_at"`
}

type PullRequestComment

type PullRequestComment struct {
	GithubId int `json:"id"`
	Body     string
	User     struct {
		Login string
	}
}

type PullRequestReview

type PullRequestReview struct {
	GithubId int `json:"id"`
	User     struct {
		Id    int
		Login string
	}
	Body        string
	State       string
	SubmittedAt string `json:"submitted_at"`
}