github

Documentation

Overview

Package github provides GitHub API v3 adaptor

Index

• Constants
• func NewAuthClient(ctx context.Context, accessToken string) *http.Client
• type AcceptedError
• type Adaptor
  • func NewAdaptor(ctx context.Context, host, token string, options ...Option) (Adaptor, error)
• type ErrorResponse
• type LanguageFragment
• type ListOptions
• type Option
  • func WithScheme(scheme string) Option
• type OrderDirection
• type OwnerFragment
• type PageInfoFragment
• type ParentRepositoryFragment
• type Repository
• type RepositoryAffiliation
• type RepositoryCreateForkOptions
• type RepositoryFragment
• type RepositoryListOptions
• type RepositoryOrder
• type RepositoryOrderField
• type RepositoryPrivacy
• type Response
• type TemplateRepoRequest
• type User

Constants

const (
	DefaultHost    = "github.com"
	DefaultAPIHost = "api.github.com"
)

Functions

func NewAuthClient

func NewAuthClient(ctx context.Context, accessToken string) *http.Client

Types

type AcceptedError

type AcceptedError = github.AcceptedError

type Adaptor

type Adaptor interface {
	GetHost() string
	UserGet(ctx context.Context, user string) (*User, *Response, error)
	RepositoryList(
		ctx context.Context,
		opts *RepositoryListOptions,
	) ([]*RepositoryFragment, PageInfoFragment, error)
	RepositoryCreate(
		ctx context.Context,
		org string,
		repo *Repository,
	) (*Repository, *Response, error)
	RepositoryCreateFork(
		ctx context.Context,
		owner string,
		repo string,
		opts *RepositoryCreateForkOptions,
	) (*Repository, *Response, error)
	RepositoryCreateFromTemplate(
		ctx context.Context,
		templateOwner, templateRepo string,
		templateRepoReq *TemplateRepoRequest,
	) (*Repository, *Response, error)
	RepositoryDelete(ctx context.Context, owner string, repo string) (*Response, error)
	RepositoryGet(ctx context.Context, owner string, repo string) (*Repository, *Response, error)
}

func NewAdaptor

func NewAdaptor(ctx context.Context, host, token string, options ...Option) (Adaptor, error)

type ErrorResponse

type ErrorResponse = github.ErrorResponse

type LanguageFragment

type LanguageFragment = githubv4.LanguageFragment

type ListOptions

type ListOptions = github.ListOptions

type Option

type Option func(baseRESTURL *url.URL, uploadRESTURL *url.URL, baseGQLURL *url.URL)

func WithScheme

func WithScheme(scheme string) Option

type OrderDirection

type OrderDirection = githubv4.OrderDirection

const (
	OrderDirectionAsc  OrderDirection = githubv4.OrderDirectionAsc
	OrderDirectionDesc OrderDirection = githubv4.OrderDirectionDesc
)

type OwnerFragment

type OwnerFragment = githubv4.OwnerFragment

type PageInfoFragment

type PageInfoFragment = githubv4.PageInfoFragment

type ParentRepositoryFragment

type ParentRepositoryFragment = githubv4.ParentRepositoryFragment

type Repository

type Repository = github.Repository

type RepositoryAffiliation

type RepositoryAffiliation = githubv4.RepositoryAffiliation

const (
	RepositoryAffiliationOwner              RepositoryAffiliation = githubv4.RepositoryAffiliationOwner
	RepositoryAffiliationCollaborator       RepositoryAffiliation = githubv4.RepositoryAffiliationCollaborator
	RepositoryAffiliationOrganizationMember RepositoryAffiliation = githubv4.RepositoryAffiliationOrganizationMember
)

type RepositoryCreateForkOptions

type RepositoryCreateForkOptions = github.RepositoryCreateForkOptions

type RepositoryFragment

type RepositoryFragment = githubv4.RepositoryFragment

type RepositoryListOptions

type RepositoryListOptions struct {
	Limit             *int64
	After             *string
	IsFork            *bool
	Privacy           *RepositoryPrivacy
	OrderBy           *RepositoryOrder
	OwnerAffiliations []*RepositoryAffiliation
}

type RepositoryOrder

type RepositoryOrder = githubv4.RepositoryOrder

type RepositoryOrderField

type RepositoryOrderField = githubv4.RepositoryOrderField

const (
	RepositoryOrderFieldCreatedAt  RepositoryOrderField = githubv4.RepositoryOrderFieldCreatedAt
	RepositoryOrderFieldUpdatedAt  RepositoryOrderField = githubv4.RepositoryOrderFieldUpdatedAt
	RepositoryOrderFieldPushedAt   RepositoryOrderField = githubv4.RepositoryOrderFieldPushedAt
	RepositoryOrderFieldName       RepositoryOrderField = githubv4.RepositoryOrderFieldName
	RepositoryOrderFieldStargazers RepositoryOrderField = githubv4.RepositoryOrderFieldStargazers
)

type RepositoryPrivacy

type RepositoryPrivacy = githubv4.RepositoryPrivacy

const (
	RepositoryPrivacyPublic  RepositoryPrivacy = githubv4.RepositoryPrivacyPublic
	RepositoryPrivacyPrivate RepositoryPrivacy = githubv4.RepositoryPrivacyPrivate
)

type Response

type Response = github.Response

type TemplateRepoRequest

type TemplateRepoRequest = github.TemplateRepoRequest

type User

type User = github.User