github

Documentation

Overview

Package github implements a GitHub client.

Index

• Variables
• func New(uri string) (*scm.Client, error)
• func NewDefault() *scm.Client
• func NewWebHookService() scm.WebhookService
• type Error
  • func (e *Error) Error() string

Variables

var NormLogin = strings.ToLower

NormLogin normalizes GitHub login strings

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.

func NewWebHookService

func NewWebHookService() scm.WebhookService

NewWebHookService creates a new instance of the webhook service without the rest of the client

Types

type Error

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

Error represents a Github error.

func (*Error) Error

func (e *Error) Error() string