github

Documentation

Index

• Constants
• Variables
• func NewClient(token string) *gh.Client
• func NewSyncCommand(client *github.Client, blobStore storage.BlobStore) *syncCmd
• func NewSyncCommandWithOptions(client *github.Client, blobStore storage.BlobStore, opt *syncOptions) *syncCmd
• type GitHubStateFilter
• type PartialMessage

Constants

const (
	EvtCommitComment            = "commit_comment"
	EvtCreate                   = "create"
	EvtDelete                   = "delete"
	EvtDeployment               = "deployment"
	EvtDeploymentStatus         = "deployment_status"
	EvtFollow                   = "follow"
	EvtFork                     = "fork"
	EvtForkApply                = "fork_apply"
	EvtGollum                   = "gollum"
	EvtIssueComment             = "issue_comment"
	EvtIssues                   = "issues"
	EvtMember                   = "member"
	EvtMembership               = "membership"
	EvtPageBuild                = "page_build"
	EvtPublic                   = "public"
	EvtPullRequest              = "pull_request"
	EvtPullRequestReviewComment = "pull_request_review_comment"
	EvtPush                     = "push"
	EvtRelease                  = "release"
	EvtRepositories             = "repositories"
	EvtStatus                   = "status"
	EvtTeamAdd                  = "team_add"
	EvtWatch                    = "watch"
)

const (
	// DefaultFrom is the default starting number for syncing repository items.
	DefaultFrom = 1

	// DefaultNumFetchProcs is the default number of goroutines fetching data
	// from the GitHub API in parallel.
	DefaultNumFetchProcs = 20

	// DefaultNumIndexProcs is the default number of goroutines indexing data
	// into Elastic Search in parallel.
	DefaultNumIndexProcs = 5

	// DefaultPerPage is the default number of items per page in GitHub API
	// requests.
	DefaultPerPage = 100

	// DefaultSleepPerPage is the default number of seconds to sleep between
	// each GitHub page queried.
	DefaultSleepPerPage = 0

	// DefaultStorage is the default destination store for the synchronization
	// job.
	DefaultStorage = storage.StoreSnapshot

	// DefaultFilterMode is the default filtering mode for retrieving issues.
	DefaultFilterMode = GitHubStateFilterOpened
)

Variables

var DefaultSyncOptions = syncOptions{
	From:          DefaultFrom,
	NumFetchProcs: DefaultNumFetchProcs,
	NumIndexProcs: DefaultNumIndexProcs,
	PerPage:       DefaultPerPage,
	SleepPerPage:  DefaultSleepPerPage,
	State:         GitHubStateFilterOpened,
	Storage:       DefaultStorage,
}

DefaultSyncOptions is the default set of options for a synchronization job.

Functions

func NewClient

func NewClient(token string) *gh.Client

func NewSyncCommand

func NewSyncCommand(client *github.Client, blobStore storage.BlobStore) *syncCmd

NewSyncCommand creates a default configured synchronization job.

func NewSyncCommandWithOptions

func NewSyncCommandWithOptions(client *github.Client, blobStore storage.BlobStore, opt *syncOptions) *syncCmd

NewSyncCommandWithOptions creates a synchronization job with the specific options set. Be careful when using that function to give meaningful values to all options: it is recommand to start from a copy of DefaultSyncOptions and modify what needs to be from there.

Types

type GitHubStateFilter

type GitHubStateFilter string

GitHubStateFilter is an enumeration of possible filtering mode when retrieving GitHub issues.

const (
	// GitHubStateFilterAll takes all issues.
	GitHubStateFilterAll GitHubStateFilter = "all"

	// GitHubStateFilterClosed filters closed issues.
	GitHubStateFilterClosed GitHubStateFilter = "closed"

	// GitHubStateFilterOpened filters opened issues.
	GitHubStateFilterOpened GitHubStateFilter = "open"
)

type PartialMessage

type PartialMessage struct {
	GitHubEvent    string `json:"X-GitHub-Event"`
	GitHubDelivery string `json:"X-GitHub-Delivery"`
	HubSignature   string `json:"X-Hub-Signature"`
}