github

Documentation

Overview

Package github implements a GitHub client.

Index

• func New(uri string) (*scm.Client, error)
• func NewDefault() *scm.Client
• type Error
  • func (e *Error) Error() string
• type RepositoryService
  • func (s *RepositoryService) CreateDeployStatus(ctx context.Context, repo string, input *scm.DeployStatus) (*scm.DeployStatus, *scm.Response, error)
  • func (s *RepositoryService) CreateHook(ctx context.Context, repo string, input *scm.HookInput) (*scm.Hook, *scm.Response, error)
  • func (s *RepositoryService) CreateStatus(ctx context.Context, repo, ref string, input *scm.StatusInput) (*scm.Status, *scm.Response, error)
  • func (s *RepositoryService) DeleteHook(ctx context.Context, repo, id string) (*scm.Response, error)
  • func (s *RepositoryService) Find(ctx context.Context, repo string) (*scm.Repository, *scm.Response, error)
  • func (s *RepositoryService) FindHook(ctx context.Context, repo string, id string) (*scm.Hook, *scm.Response, error)
  • func (s *RepositoryService) FindPerms(ctx context.Context, repo string) (*scm.Perm, *scm.Response, error)
  • func (s *RepositoryService) List(ctx context.Context, opts scm.ListOptions) ([]*scm.Repository, *scm.Response, error)
  • func (s *RepositoryService) ListByInstallation(ctx context.Context, opts scm.ListOptions) ([]*scm.Repository, *scm.Response, error)
  • func (s *RepositoryService) ListHooks(ctx context.Context, repo string, opts scm.ListOptions) ([]*scm.Hook, *scm.Response, error)
  • func (s *RepositoryService) ListStatus(ctx context.Context, repo, ref string, opts scm.ListOptions) ([]*scm.Status, *scm.Response, error)
  • func (s *RepositoryService) ListV2(ctx context.Context, opts scm.RepoListOptions) ([]*scm.Repository, *scm.Response, error)
  • func (s *RepositoryService) UpdateHook(ctx context.Context, repo, id string, input *scm.HookInput) (*scm.Hook, *scm.Response, error)

Functions

func New

func New(uri string) (*scm.Client, error)

New returns a new GitHub API client.

func NewDefault

func NewDefault() *scm.Client

NewDefault returns a new GitHub API client using the default api.github.com address.

Types

type Error

type Error struct {
	Message string `json:"message"`
}

Error represents a Github error.

func (*Error) Error

func (e *Error) Error() string

type RepositoryService

type RepositoryService struct {
	// contains filtered or unexported fields
}

RepositoryService implements the repository service for the GitHub driver.

func (*RepositoryService) CreateDeployStatus

func (s *RepositoryService) CreateDeployStatus(ctx context.Context, repo string, input *scm.DeployStatus) (*scm.DeployStatus, *scm.Response, error)

CreateDeployStatus creates a new deployment status.

func (*RepositoryService) CreateHook

func (s *RepositoryService) CreateHook(ctx context.Context, repo string, input *scm.HookInput) (*scm.Hook, *scm.Response, error)

CreateHook creates a new repository webhook.

func (*RepositoryService) CreateStatus

func (s *RepositoryService) CreateStatus(ctx context.Context, repo, ref string, input *scm.StatusInput) (*scm.Status, *scm.Response, error)

CreateStatus creates a new commit status.

func (*RepositoryService) DeleteHook

func (s *RepositoryService) DeleteHook(ctx context.Context, repo, id string) (*scm.Response, error)

DeleteHook deletes a repository webhook.

func (*RepositoryService) Find

func (s *RepositoryService) Find(ctx context.Context, repo string) (*scm.Repository, *scm.Response, error)

Find returns the repository by name.

func (*RepositoryService) FindHook

func (s *RepositoryService) FindHook(ctx context.Context, repo string, id string) (*scm.Hook, *scm.Response, error)

FindHook returns a repository hook.

func (*RepositoryService) FindPerms

func (s *RepositoryService) FindPerms(ctx context.Context, repo string) (*scm.Perm, *scm.Response, error)

FindPerms returns the repository permissions.

func (*RepositoryService) List

func (s *RepositoryService) List(ctx context.Context, opts scm.ListOptions) ([]*scm.Repository, *scm.Response, error)

List returns the user repository list.

func (*RepositoryService) ListByInstallation

func (s *RepositoryService) ListByInstallation(ctx context.Context, opts scm.ListOptions) ([]*scm.Repository, *scm.Response, error)

List returns the github app installation repository list.

func (*RepositoryService) ListHooks

func (s *RepositoryService) ListHooks(ctx context.Context, repo string, opts scm.ListOptions) ([]*scm.Hook, *scm.Response, error)

ListHooks returns a list or repository hooks.

func (*RepositoryService) ListStatus

func (s *RepositoryService) ListStatus(ctx context.Context, repo, ref string, opts scm.ListOptions) ([]*scm.Status, *scm.Response, error)

ListStatus returns a list of commit statuses.

func (*RepositoryService) ListV2

func (s *RepositoryService) ListV2(ctx context.Context, opts scm.RepoListOptions) ([]*scm.Repository, *scm.Response, error)

ListV2 returns the user repository list based on the searchTerm passed.

func (*RepositoryService) UpdateHook

func (s *RepositoryService) UpdateHook(ctx context.Context, repo, id string, input *scm.HookInput) (*scm.Hook, *scm.Response, error)

UpdateHook updates a repository webhook.