The highest tagged major version is v4.

github

package

v3.6.9 Latest Latest Go to latest Published: Apr 16, 2025 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/kyoh86/gogh

Links

Open Source Insights

Documentation ¶

Overview ¶

Package github provides GitHub API v3 adaptor

Index ¶

Constants
func OAuth2Config(host string) *oauth2.Config
type AcceptedError
type Adaptor
- func NewAdaptor(ctx context.Context, host string, token *Token) (Adaptor, error)
type ErrorResponse
type LanguageFragment
type ListOptions
type OrderDirection
type Organization
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 Token
type User

Constants ¶

View Source

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

View Source

const ClientID = "Ov23li6aEWIxek6F8P5L"

Variables ¶

This section is empty.

Functions ¶

func OAuth2Config ¶

func OAuth2Config(host string) *oauth2.Config

Types ¶

type AcceptedError ¶

type AcceptedError = github.AcceptedError

type Adaptor ¶

type Adaptor interface {
	GetAccessToken() (string, error)
	GetHost() string
	GetMe(ctx context.Context) (string, error)
	GetAuthenticatedUser(ctx context.Context) (*User, *Response, error)
	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)
	OrganizationList(ctx context.Context) ([]*Organization, *Response, error)
}

func NewAdaptor ¶

func NewAdaptor(ctx context.Context, host string, token *Token) (Adaptor, error)

type ErrorResponse ¶

type ErrorResponse = github.ErrorResponse

type LanguageFragment ¶

type LanguageFragment = githubv4.LanguageFragment

type ListOptions ¶

type ListOptions = github.ListOptions

type OrderDirection ¶

type OrderDirection = githubv4.OrderDirection

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

type Organization ¶ added in v3.6.4

type Organization = github.Organization

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 {
	OrderBy           RepositoryOrder
	After             string
	Privacy           RepositoryPrivacy
	OwnerAffiliations []RepositoryAffiliation
	Limit             int
	IsFork            *bool
	IsArchived        *bool
}

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 Token ¶

type Token = oauth2.Token

type User ¶

type User = github.User

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL