Package github

go-github: github.com/google/go-github/github Index | Examples | Files

package github

import "github.com/google/go-github/github"

Package github provides a client for using the GitHub API.

Usage:

import "github.com/google/go-github/v24/github"	// with go modules enabled (GO111MODULE=on or outside GOPATH)
import "github.com/google/go-github/github"     // with go modules disabled

Construct a new GitHub client, then use the various services on the client to access different parts of the GitHub API. For example:

client := github.NewClient(nil)

// list all organizations for user "willnorris"
orgs, _, err := client.Organizations.List(ctx, "willnorris", nil)

Some API methods have optional parameters that can be passed. For example:

client := github.NewClient(nil)

// list public repositories for org "github"
opt := &github.RepositoryListByOrgOptions{Type: "public"}
repos, _, err := client.Repositories.ListByOrg(ctx, "github", opt)

The services of a client divide the API into logical chunks and correspond to the structure of the GitHub API documentation at https://developer.github.com/v3/.

NOTE: Using the https://godoc.org/context package, one can easily pass cancelation signals and deadlines to various services of the client for handling a request. In case there is no context available, then context.Background() can be used as a starting point.

For more sample code snippets, head over to the https://github.com/google/go-github/tree/master/example directory.

Authentication ¶

The go-github library does not directly handle authentication. Instead, when creating a new client, pass an http.Client that can handle authentication for you. The easiest and recommended way to do this is using the golang.org/x/oauth2 library, but you can always use any other library that provides an http.Client. If you have an OAuth2 access token (for example, a personal API token), you can use it with the oauth2 library using:

import "golang.org/x/oauth2"

func main() {
	ctx := context.Background()
	ts := oauth2.StaticTokenSource(
		&oauth2.Token{AccessToken: "... your access token ..."},
	)
	tc := oauth2.NewClient(ctx, ts)

	client := github.NewClient(tc)

	// list all repositories for the authenticated user
	repos, _, err := client.Repositories.List(ctx, "", nil)
}

Note that when using an authenticated Client, all calls made by the client will include the specified OAuth token. Therefore, authenticated clients should almost never be shared between different users.

See the oauth2 docs for complete instructions on using that library.

For API methods that require HTTP Basic Authentication, use the BasicAuthTransport.

GitHub Apps authentication can be provided by the https://github.com/bradleyfalzon/ghinstallation package.

import "github.com/bradleyfalzon/ghinstallation"

func main() {
	// Wrap the shared transport for use with the integration ID 1 authenticating with installation ID 99.
	itr, err := ghinstallation.NewKeyFromFile(http.DefaultTransport, 1, 99, "2016-10-19.private-key.pem")
	if err != nil {
		// Handle error.
	}

	// Use installation transport with client
	client := github.NewClient(&http.Client{Transport: itr})

	// Use client...
}

Rate Limiting ¶

GitHub imposes a rate limit on all API clients. Unauthenticated clients are limited to 60 requests per hour, while authenticated clients can make up to 5,000 requests per hour. The Search API has a custom rate limit. Unauthenticated clients are limited to 10 requests per minute, while authenticated clients can make up to 30 requests per minute. To receive the higher rate limit when making calls that are not issued on behalf of a user, use UnauthenticatedRateLimitedTransport.

The returned Response.Rate value contains the rate limit information from the most recent API call. If a recent enough response isn't available, you can use RateLimits to fetch the most up-to-date rate limit data for the client.

To detect an API rate limit error, you can check if its type is *github.RateLimitError:

repos, _, err := client.Repositories.List(ctx, "", nil)
if _, ok := err.(*github.RateLimitError); ok {
	log.Println("hit rate limit")
}

Learn more about GitHub rate limiting at https://developer.github.com/v3/#rate-limiting.

Accepted Status ¶

Some endpoints may return a 202 Accepted status code, meaning that the information required is not yet ready and was scheduled to be gathered on the GitHub side. Methods known to behave like this are documented specifying this behavior.

To detect this condition of error, you can check if its type is *github.AcceptedError:

stats, _, err := client.Repositories.ListContributorsStats(ctx, org, repo)
if _, ok := err.(*github.AcceptedError); ok {
	log.Println("scheduled on GitHub side")
}

Conditional Requests ¶

The GitHub API has good support for conditional requests which will help prevent you from burning through your rate limit, as well as help speed up your application. go-github does not handle conditional requests directly, but is instead designed to work with a caching http.Transport. We recommend using https://github.com/gregjones/httpcache for that.

Learn more about GitHub conditional requests at https://developer.github.com/v3/#conditional-requests.

Creating and Updating Resources ¶

All structs for GitHub resources use pointer values for all non-repeated fields. This allows distinguishing between unset fields and those set to a zero-value. Helper functions have been provided to easily create these pointers for string, bool, and int values. For example:

// create a new private repository named "foo"
repo := &github.Repository{
	Name:    github.String("foo"),
	Private: github.Bool(true),
}
client.Repositories.Create(ctx, "", repo)

Users who have worked with protocol buffers should find this pattern familiar.

All requests for resource collections (repos, pull requests, issues, etc.) support pagination. Pagination options are described in the github.ListOptions struct and passed to the list methods directly or as an embedded type of a more specific list options struct (for example github.PullRequestListOptions). Pages information is available via the github.Response struct.

client := github.NewClient(nil)

opt := &github.RepositoryListByOrgOptions{
	ListOptions: github.ListOptions{PerPage: 10},
}
// get all pages of results
var allRepos []*github.Repository
for {
	repos, resp, err := client.Repositories.ListByOrg(ctx, "github", opt)
	if err != nil {
		return err
	}
	allRepos = append(allRepos, repos...)
	if resp.NextPage == 0 {
		break
	}
	opt.Page = resp.NextPage
}

const (
    // Tarball specifies an archive in gzipped tar format.
    Tarball archiveFormat = "tarball"

    // Zipball specifies an archive in zip format.
    Zipball archiveFormat = "zipball"
)

func Bool ¶ Uses

❖

func Bool(v bool) *bool

Bool is a helper routine that allocates a new bool value to store v and returns a pointer to it.

func CheckResponse ¶ Uses

❖

func CheckResponse(r *http.Response) error

CheckResponse checks the API response for errors, and returns them if present. A response is considered an error if it has a status code outside the 200 range or equal to 202 Accepted. API error responses are expected to have either no response body, or a JSON response body that maps to ErrorResponse. Any other response body will be silently ignored.

The error type will be *RateLimitError for rate limit exceeded errors, *AcceptedError for 202 Accepted status codes, and *TwoFactorAuthError for two-factor authentication errors.

func DeliveryID ¶ Uses

❖

func DeliveryID(r *http.Request) string

DeliveryID returns the unique delivery ID of webhook request r.

GitHub API docs: https://developer.github.com/v3/repos/hooks/#webhook-headers

func Int ¶ Uses

❖

func Int(v int) *int

Int is a helper routine that allocates a new int value to store v and returns a pointer to it.

func Int64 ¶ Uses

❖

func Int64(v int64) *int64

Int64 is a helper routine that allocates a new int64 value to store v and returns a pointer to it.

func ParseWebHook ¶ Uses

❖

func ParseWebHook(messageType string, payload []byte) (interface{}, error)

ParseWebHook parses the event payload. For recognized event types, a value of the corresponding struct type will be returned (as returned by Event.ParsePayload()). An error will be returned for unrecognized event types.

Example usage:

func (s *GitHubEventMonitor) ServeHTTP(w http.ResponseWriter, r *http.Request) {
  payload, err := github.ValidatePayload(r, s.webhookSecretKey)
  if err != nil { ... }
  event, err := github.ParseWebHook(github.WebHookType(r), payload)
  if err != nil { ... }
  switch event := event.(type) {
  case *github.CommitCommentEvent:
      processCommitCommentEvent(event)
  case *github.CreateEvent:
      processCreateEvent(event)
  ...
  }
}

func String ¶ Uses

❖

func String(v string) *string

String is a helper routine that allocates a new string value to store v and returns a pointer to it.

func Stringify ¶ Uses

❖

func Stringify(message interface{}) string

Stringify attempts to create a reasonable string representation of types in the GitHub library. It does things like resolve pointers to their values and omits struct fields with nil values.

func ValidatePayload ¶ Uses

❖

func ValidatePayload(r *http.Request, secretKey []byte) (payload []byte, err error)

ValidatePayload validates an incoming GitHub Webhook event request and returns the (JSON) payload. The Content-Type header of the payload can be "application/json" or "application/x-www-form-urlencoded". If the Content-Type is neither then an error is returned. secretKey is the GitHub Webhook secret message.

Example usage:

func (s *GitHubEventMonitor) ServeHTTP(w http.ResponseWriter, r *http.Request) {
  payload, err := github.ValidatePayload(r, s.webhookSecretKey)
  if err != nil { ... }
  // Process payload...
}

func ValidateSignature ¶ Uses

❖

func ValidateSignature(signature string, payload, secretKey []byte) error

ValidateSignature validates the signature for the given payload. signature is the GitHub hash signature delivered in the X-Hub-Signature header. payload is the JSON payload sent by GitHub Webhooks. secretKey is the GitHub Webhook secret message.

GitHub API docs: https://developer.github.com/webhooks/securing/#validating-payloads-from-github

func WebHookType ¶ Uses

❖

func WebHookType(r *http.Request) string

WebHookType returns the event type of webhook request r.

GitHub API docs: https://developer.github.com/v3/repos/hooks/#webhook-headers

type APIMeta ¶ Uses

❖

type APIMeta struct {
    // An Array of IP addresses in CIDR format specifying the addresses
    // that incoming service hooks will originate from on GitHub.com.
    Hooks []string `json:"hooks,omitempty"`

    // An Array of IP addresses in CIDR format specifying the Git servers
    // for GitHub.com.
    Git []string `json:"git,omitempty"`

    // Whether authentication with username and password is supported.
    // (GitHub Enterprise instances using CAS or OAuth for authentication
    // will return false. Features like Basic Authentication with a
    // username and password, sudo mode, and two-factor authentication are
    // not supported on these servers.)
    VerifiablePasswordAuthentication *bool `json:"verifiable_password_authentication,omitempty"`

    // An array of IP addresses in CIDR format specifying the addresses
    // which serve GitHub Pages websites.
    Pages []string `json:"pages,omitempty"`

    // An Array of IP addresses specifying the addresses that source imports
    // will originate from on GitHub.com.
    Importer []string `json:"importer,omitempty"`
}

APIMeta represents metadata about the GitHub API.

func (*APIMeta) GetVerifiablePasswordAuthentication ¶ Uses

❖

func (a *APIMeta) GetVerifiablePasswordAuthentication() bool

GetVerifiablePasswordAuthentication returns the VerifiablePasswordAuthentication field if it's non-nil, zero value otherwise.

type AbuseRateLimitError ¶ Uses

❖

type AbuseRateLimitError struct {
    Response *http.Response // HTTP response that caused this error
    Message  string         `json:"message"` // error message

    // RetryAfter is provided with some abuse rate limit errors. If present,
    // it is the amount of time that the client should wait before retrying.
    // Otherwise, the client should try again later (after an unspecified amount of time).
    RetryAfter *time.Duration
}

AbuseRateLimitError occurs when GitHub returns 403 Forbidden response with the "documentation_url" field value equal to "https://developer.github.com/v3/#abuse-rate-limits".

func (*AbuseRateLimitError) Error ¶ Uses

❖

func (r *AbuseRateLimitError) Error() string

func (*AbuseRateLimitError) GetRetryAfter ¶ Uses

❖

func (a *AbuseRateLimitError) GetRetryAfter() time.Duration

GetRetryAfter returns the RetryAfter field if it's non-nil, zero value otherwise.

type AcceptedError ¶ Uses

❖

type AcceptedError struct {
    // Raw contains the response body.
    Raw []byte
}

AcceptedError occurs when GitHub returns 202 Accepted response with an empty body, which means a job was scheduled on the GitHub side to process the information needed and cache it. Technically, 202 Accepted is not a real error, it's just used to indicate that results are not ready yet, but should be available soon. The request can be repeated after some time.

func (*AcceptedError) Error ¶ Uses

❖

func (*AcceptedError) Error() string

type ActivityListStarredOptions ¶ Uses

❖

type ActivityListStarredOptions struct {
    // How to sort the repository list. Possible values are: created, updated,
    // pushed, full_name. Default is "full_name".
    Sort string `url:"sort,omitempty"`

    // Direction in which to sort repositories. Possible values are: asc, desc.
    // Default is "asc" when sort is "full_name", otherwise default is "desc".
    Direction string `url:"direction,omitempty"`

    ListOptions
}

ActivityListStarredOptions specifies the optional parameters to the ActivityService.ListStarred method.

type ActivityService ¶ Uses

❖

type ActivityService service

ActivityService handles communication with the activity related methods of the GitHub API.

GitHub API docs: https://developer.github.com/v3/activity/

func (*ActivityService) DeleteRepositorySubscription ¶ Uses

❖

func (s *ActivityService) DeleteRepositorySubscription(ctx context.Context, owner, repo string) (*Response, error)

DeleteRepositorySubscription deletes the subscription for the specified repository for the authenticated user.

This is used to stop watching a repository. To control whether or not to receive notifications from a repository, use SetRepositorySubscription.

GitHub API docs: https://developer.github.com/v3/activity/watching/#delete-a-repository-subscription

func (*ActivityService) DeleteThreadSubscription ¶ Uses

❖

func (s *ActivityService) DeleteThreadSubscription(ctx context.Context, id string) (*Response, error)

DeleteThreadSubscription deletes the subscription for the specified thread for the authenticated user.

GitHub API docs: https://developer.github.com/v3/activity/notifications/#delete-a-thread-subscription

func (*ActivityService) GetRepositorySubscription ¶ Uses

❖

func (s *ActivityService) GetRepositorySubscription(ctx context.Context, owner, repo string) (*Subscription, *Response, error)

GetRepositorySubscription returns the subscription for the specified repository for the authenticated user. If the authenticated user is not watching the repository, a nil Subscription is returned.

GitHub API docs: https://developer.github.com/v3/activity/watching/#get-a-repository-subscription

func (*ActivityService) GetThread ¶ Uses

❖

func (s *ActivityService) GetThread(ctx context.Context, id string) (*Notification, *Response, error)

GetThread gets the specified notification thread.

GitHub API docs: https://developer.github.com/v3/activity/notifications/#view-a-single-thread

func (*ActivityService) GetThreadSubscription ¶ Uses

❖

func (s *ActivityService) GetThreadSubscription(ctx context.Context, id string) (*Subscription, *Response, error)

GetThreadSubscription checks to see if the authenticated user is subscribed to a thread.

GitHub API docs: https://developer.github.com/v3/activity/notifications/#get-a-thread-subscription

func (*ActivityService) IsStarred ¶ Uses

❖

func (s *ActivityService) IsStarred(ctx context.Context, owner, repo string) (bool, *Response, error)

IsStarred checks if a repository is starred by authenticated user.

GitHub API docs: https://developer.github.com/v3/activity/starring/#check-if-you-are-starring-a-repository

func (*ActivityService) ListEvents ¶ Uses

❖

func (s *ActivityService) ListEvents(ctx context.Context, opt *ListOptions) ([]*Event, *Response, error)

ListEvents drinks from the firehose of all public events across GitHub.

GitHub API docs: https://developer.github.com/v3/activity/events/#list-public-events

func (*ActivityService) ListEventsForOrganization ¶ Uses

❖

func (s *ActivityService) ListEventsForOrganization(ctx context.Context, org string, opt *ListOptions) ([]*Event, *Response, error)

ListEventsForOrganization lists public events for an organization.

GitHub API docs: https://developer.github.com/v3/activity/events/#list-public-events-for-an-organization

func (*ActivityService) ListEventsForRepoNetwork ¶ Uses

❖

func (s *ActivityService) ListEventsForRepoNetwork(ctx context.Context, owner, repo string, opt *ListOptions) ([]*Event, *Response, error)

ListEventsForRepoNetwork lists public events for a network of repositories.

GitHub API docs: https://developer.github.com/v3/activity/events/#list-public-events-for-a-network-of-repositories

func (*ActivityService) ListEventsPerformedByUser ¶ Uses

❖

func (s *ActivityService) ListEventsPerformedByUser(ctx context.Context, user string, publicOnly bool, opt *ListOptions) ([]*Event, *Response, error)

ListEventsPerformedByUser lists the events performed by a user. If publicOnly is true, only public events will be returned.

GitHub API docs: https://developer.github.com/v3/activity/events/#list-events-performed-by-a-user

func (*ActivityService) ListEventsReceivedByUser ¶ Uses

❖

func (s *ActivityService) ListEventsReceivedByUser(ctx context.Context, user string, publicOnly bool, opt *ListOptions) ([]*Event, *Response, error)

ListEventsReceivedByUser lists the events received by a user. If publicOnly is true, only public events will be returned.

GitHub API docs: https://developer.github.com/v3/activity/events/#list-events-that-a-user-has-received

func (*ActivityService) ListFeeds ¶ Uses

❖

func (s *ActivityService) ListFeeds(ctx context.Context) (*Feeds, *Response, error)

ListFeeds lists all the feeds available to the authenticated user.

GitHub provides several timeline resources in Atom format:

Timeline: The GitHub global public timeline
User: The public timeline for any user, using URI template
Current user public: The public timeline for the authenticated user
Current user: The private timeline for the authenticated user
Current user actor: The private timeline for activity created by the
    authenticated user
Current user organizations: The private timeline for the organizations
    the authenticated user is a member of.

Note: Private feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.

func (*ActivityService) ListIssueEventsForRepository ¶ Uses

❖

func (s *ActivityService) ListIssueEventsForRepository(ctx context.Context, owner, repo string, opt *ListOptions) ([]*IssueEvent, *Response, error)

ListIssueEventsForRepository lists issue events for a repository.

GitHub API docs: https://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository

func (*ActivityService) ListNotifications ¶ Uses

❖

func (s *ActivityService) ListNotifications(ctx context.Context, opt *NotificationListOptions) ([]*Notification, *Response, error)

ListNotifications lists all notifications for the authenticated user.

GitHub API docs: https://developer.github.com/v3/activity/notifications/#list-your-notifications

func (*ActivityService) ListRepositoryEvents ¶ Uses

❖

func (s *ActivityService) ListRepositoryEvents(ctx context.Context, owner, repo string, opt *ListOptions) ([]*Event, *Response, error)

ListRepositoryEvents lists events for a repository.

GitHub API docs: https://developer.github.com/v3/activity/events/#list-repository-events

func (*ActivityService) ListRepositoryNotifications ¶ Uses

❖

func (s *ActivityService) ListRepositoryNotifications(ctx context.Context, owner, repo string, opt *NotificationListOptions) ([]*Notification, *Response, error)

ListRepositoryNotifications lists all notifications in a given repository for the authenticated user.

GitHub API docs: https://developer.github.com/v3/activity/notifications/#list-your-notifications-in-a-repository

func (*ActivityService) ListStargazers ¶ Uses

❖

func (s *ActivityService) ListStargazers(ctx context.Context, owner, repo string, opt *ListOptions) ([]*Stargazer, *Response, error)

ListStargazers lists people who have starred the specified repo.

GitHub API docs: https://developer.github.com/v3/activity/starring/#list-stargazers

func (*ActivityService) ListStarred ¶ Uses

❖

func (s *ActivityService) ListStarred(ctx context.Context, user string, opt *ActivityListStarredOptions) ([]*StarredRepository, *Response, error)

ListStarred lists all the repos starred by a user. Passing the empty string will list the starred repositories for the authenticated user.

GitHub API docs: https://developer.github.com/v3/activity/starring/#list-repositories-being-starred

func (*ActivityService) ListUserEventsForOrganization ¶ Uses

❖

func (s *ActivityService) ListUserEventsForOrganization(ctx context.Context, org, user string, opt *ListOptions) ([]*Event, *Response, error)

ListUserEventsForOrganization provides the user’s organization dashboard. You must be authenticated as the user to view this.

GitHub API docs: https://developer.github.com/v3/activity/events/#list-events-for-an-organization

func (*ActivityService) ListWatched ¶ Uses

❖

func (s *ActivityService) ListWatched(ctx context.Context, user string, opt *ListOptions) ([]*Repository, *Response, error)

ListWatched lists the repositories the specified user is watching. Passing the empty string will fetch watched repos for the authenticated user.

GitHub API docs: https://developer.github.com/v3/activity/watching/#list-repositories-being-watched

func (*ActivityService) ListWatchers ¶ Uses

❖

func (s *ActivityService) ListWatchers(ctx context.Context, owner, repo string, opt *ListOptions) ([]*User, *Response, error)

ListWatchers lists watchers of a particular repo.

GitHub API docs: https://developer.github.com/v3/activity/watching/#list-watchers

func (*ActivityService) MarkNotificationsRead ¶ Uses

❖

func (s *ActivityService) MarkNotificationsRead(ctx context.Context, lastRead time.Time) (*Response, error)

MarkNotificationsRead marks all notifications up to lastRead as read.

GitHub API docs: https://developer.github.com/v3/activity/notifications/#mark-as-read

func (*ActivityService) MarkRepositoryNotificationsRead ¶ Uses

❖

func (s *ActivityService) MarkRepositoryNotificationsRead(ctx context.Context, owner, repo string, lastRead time.Time) (*Response, error)

MarkRepositoryNotificationsRead marks all notifications up to lastRead in the specified repository as read.

GitHub API docs: https://developer.github.com/v3/activity/notifications/#mark-notifications-as-read-in-a-repository

func (*ActivityService) MarkThreadRead ¶ Uses

❖

func (s *ActivityService) MarkThreadRead(ctx context.Context, id string) (*Response, error)

MarkThreadRead marks the specified thread as read.

GitHub API docs: https://developer.github.com/v3/activity/notifications/#mark-a-thread-as-read

func (*ActivityService) SetRepositorySubscription ¶ Uses

❖

func (s *ActivityService) SetRepositorySubscription(ctx context.Context, owner, repo string, subscription *Subscription) (*Subscription, *Response, error)

SetRepositorySubscription sets the subscription for the specified repository for the authenticated user.

To watch a repository, set subscription.Subscribed to true. To ignore notifications made within a repository, set subscription.Ignored to true. To stop watching a repository, use DeleteRepositorySubscription.

GitHub API docs: https://developer.github.com/v3/activity/watching/#set-a-repository-subscription

func (*ActivityService) SetThreadSubscription ¶ Uses

❖

func (s *ActivityService) SetThreadSubscription(ctx context.Context, id string, subscription *Subscription) (*Subscription, *Response, error)

SetThreadSubscription sets the subscription for the specified thread for the authenticated user.

GitHub API docs: https://developer.github.com/v3/activity/notifications/#set-a-thread-subscription

func (*ActivityService) Star ¶ Uses

❖

func (s *ActivityService) Star(ctx context.Context, owner, repo string) (*Response, error)

Star a repository as the authenticated user.

GitHub API docs: https://developer.github.com/v3/activity/starring/#star-a-repository

func (*ActivityService) Unstar ¶ Uses

❖

func (s *ActivityService) Unstar(ctx context.Context, owner, repo string) (*Response, error)

Unstar a repository as the authenticated user.

GitHub API docs: https://developer.github.com/v3/activity/starring/#unstar-a-repository

type AdminEnforcement ¶ Uses

❖

type AdminEnforcement struct {
    URL     *string `json:"url,omitempty"`
    Enabled bool    `json:"enabled"`
}

AdminEnforcement represents the configuration to enforce required status checks for repository administrators.

func (*AdminEnforcement) GetURL ¶ Uses

❖

func (a *AdminEnforcement) GetURL() string

GetURL returns the URL field if it's non-nil, zero value otherwise.

type AdminService ¶ Uses

❖

type AdminService service

AdminService handles communication with the admin related methods of the GitHub API. These API routes are normally only accessible for GitHub Enterprise installations.

GitHub API docs: https://developer.github.com/v3/enterprise/

func (*AdminService) GetAdminStats ¶ Uses

❖

func (s *AdminService) GetAdminStats(ctx context.Context) (*AdminStats, *Response, error)

GetAdminStats returns a variety of metrics about a Github Enterprise installation.

Please note that this is only available to site administrators, otherwise it will error with a 404 not found (instead of 401 or 403).

GitHub API docs: https://developer.github.com/v3/enterprise-admin/admin_stats/

func (*AdminService) UpdateTeamLDAPMapping ¶ Uses

❖

func (s *AdminService) UpdateTeamLDAPMapping(ctx context.Context, team int64, mapping *TeamLDAPMapping) (*TeamLDAPMapping, *Response, error)

UpdateTeamLDAPMapping updates the mapping between a GitHub team and an LDAP group.

GitHub API docs: https://developer.github.com/v3/enterprise/ldap/#update-ldap-mapping-for-a-team

func (*AdminService) UpdateUserLDAPMapping ¶ Uses

❖

func (s *AdminService) UpdateUserLDAPMapping(ctx context.Context, user string, mapping *UserLDAPMapping) (*UserLDAPMapping, *Response, error)

UpdateUserLDAPMapping updates the mapping between a GitHub user and an LDAP user.

GitHub API docs: https://developer.github.com/v3/enterprise/ldap/#update-ldap-mapping-for-a-user

type AdminStats ¶ Uses

❖

type AdminStats struct {
    Issues     *IssueStats     `json:"issues,omitempty"`
    Hooks      *HookStats      `json:"hooks,omitempty"`
    Milestones *MilestoneStats `json:"milestones,omitempty"`
    Orgs       *OrgStats       `json:"orgs,omitempty"`
    Comments   *CommentStats   `json:"comments,omitempty"`
    Pages      *PageStats      `json:"pages,omitempty"`
    Users      *UserStats      `json:"users,omitempty"`
    Gists      *GistStats      `json:"gists,omitempty"`
    Pulls      *PullStats      `json:"pulls,omitempty"`
    Repos      *RepoStats      `json:"repos,omitempty"`
}

AdminStats represents a variety of stats of a Github Enterprise installation.

func (*AdminStats) GetComments ¶ Uses

❖

func (a *AdminStats) GetComments() *CommentStats

GetComments returns the Comments field.

func (*AdminStats) GetGists ¶ Uses

❖

func (a *AdminStats) GetGists() *GistStats

GetGists returns the Gists field.

func (*AdminStats) GetHooks ¶ Uses

❖

func (a *AdminStats) GetHooks() *HookStats

GetHooks returns the Hooks field.

func (*AdminStats) GetIssues ¶ Uses

❖

func (a *AdminStats) GetIssues() *IssueStats

GetIssues returns the Issues field.

func (*AdminStats) GetMilestones ¶ Uses

❖

func (a *AdminStats) GetMilestones() *MilestoneStats

GetMilestones returns the Milestones field.

func (*AdminStats) GetOrgs ¶ Uses

❖

func (a *AdminStats) GetOrgs() *OrgStats

GetOrgs returns the Orgs field.

func (*AdminStats) GetPages ¶ Uses

❖

func (a *AdminStats) GetPages() *PageStats

GetPages returns the Pages field.

func (*AdminStats) GetPulls ¶ Uses

❖

func (a *AdminStats) GetPulls() *PullStats

GetPulls returns the Pulls field.

func (*AdminStats) GetRepos ¶ Uses

❖

func (a *AdminStats) GetRepos() *RepoStats

GetRepos returns the Repos field.

func (*AdminStats) GetUsers ¶ Uses

❖

func (a *AdminStats) GetUsers() *UserStats

GetUsers returns the Users field.

func (AdminStats) String ¶ Uses

❖

func (s AdminStats) String() string

type App ¶ Uses

❖

type App struct {
    ID          *int64     `json:"id,omitempty"`
    NodeID      *string    `json:"node_id,omitempty"`
    Owner       *User      `json:"owner,omitempty"`
    Name        *string    `json:"name,omitempty"`
    Description *string    `json:"description,omitempty"`
    ExternalURL *string    `json:"external_url,omitempty"`
    HTMLURL     *string    `json:"html_url,omitempty"`
    CreatedAt   *time.Time `json:"created_at,omitempty"`
    UpdatedAt   *time.Time `json:"updated_at,omitempty"`
}

App represents a GitHub App.

func (*App) GetCreatedAt ¶ Uses

❖

func (a *App) GetCreatedAt() time.Time

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*App) GetDescription ¶ Uses

❖

func (a *App) GetDescription() string

GetDescription returns the Description field if it's non-nil, zero value otherwise.

func (*App) GetExternalURL ¶ Uses

❖

func (a *App) GetExternalURL() string

GetExternalURL returns the ExternalURL field if it's non-nil, zero value otherwise.

func (*App) GetHTMLURL ¶ Uses

❖

func (a *App) GetHTMLURL() string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*App) GetID ¶ Uses

❖

func (a *App) GetID() int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*App) GetName ¶ Uses

❖

func (a *App) GetName() string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*App) GetNodeID ¶ Uses

❖

func (a *App) GetNodeID() string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*App) GetOwner ¶ Uses

❖

func (a *App) GetOwner() *User

GetOwner returns the Owner field.

func (*App) GetUpdatedAt ¶ Uses

❖

func (a *App) GetUpdatedAt() time.Time

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

type AppsService ¶ Uses

❖

type AppsService service

AppsService provides access to the installation related functions in the GitHub API.

GitHub API docs: https://developer.github.com/v3/apps/

func (*AppsService) AddRepository ¶ Uses

❖

func (s *AppsService) AddRepository(ctx context.Context, instID, repoID int64) (*Repository, *Response, error)

AddRepository adds a single repository to an installation.

GitHub API docs: https://developer.github.com/v3/apps/installations/#add-repository-to-installation

func (*AppsService) CreateInstallationToken ¶ Uses

❖

func (s *AppsService) CreateInstallationToken(ctx context.Context, id int64) (*InstallationToken, *Response, error)

CreateInstallationToken creates a new installation token.

GitHub API docs: https://developer.github.com/v3/apps/#create-a-new-installation-token

func (*AppsService) FindOrganizationInstallation ¶ Uses

❖

func (s *AppsService) FindOrganizationInstallation(ctx context.Context, org string) (*Installation, *Response, error)

FindOrganizationInstallation finds the organization's installation information.

GitHub API docs: https://developer.github.com/v3/apps/#find-organization-installation

func (*AppsService) FindRepositoryInstallation ¶ Uses

❖

func (s *AppsService) FindRepositoryInstallation(ctx context.Context, owner, repo string) (*Installation, *Response, error)

FindRepositoryInstallation finds the repository's installation information.

GitHub API docs: https://developer.github.com/v3/apps/#find-repository-installation

func (*AppsService) FindRepositoryInstallationByID ¶ Uses

❖

func (s *AppsService) FindRepositoryInstallationByID(ctx context.Context, id int64) (*Installation, *Response, error)

FindRepositoryInstallationByID finds the repository's installation information.

Note: FindRepositoryInstallationByID uses the undocumented GitHub API endpoint /repositories/:id/installation.

func (*AppsService) FindUserInstallation ¶ Uses

❖

func (s *AppsService) FindUserInstallation(ctx context.Context, user string) (*Installation, *Response, error)

FindUserInstallation finds the user's installation information.

GitHub API docs: https://developer.github.com/v3/apps/#find-repository-installation

func (*AppsService) Get ¶ Uses

❖

func (s *AppsService) Get(ctx context.Context, appSlug string) (*App, *Response, error)

Get a single GitHub App. Passing the empty string will get the authenticated GitHub App.

Note: appSlug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).

GitHub API docs: https://developer.github.com/v3/apps/#get-a-single-github-app

func (*AppsService) GetInstallation ¶ Uses

❖

func (s *AppsService) GetInstallation(ctx context.Context, id int64) (*Installation, *Response, error)

GetInstallation returns the specified installation.

GitHub API docs: https://developer.github.com/v3/apps/#get-a-single-installation

func (*AppsService) ListInstallations ¶ Uses

❖

func (s *AppsService) ListInstallations(ctx context.Context, opt *ListOptions) ([]*Installation, *Response, error)

ListInstallations lists the installations that the current GitHub App has.

GitHub API docs: https://developer.github.com/v3/apps/#find-installations

func (*AppsService) ListRepos ¶ Uses

❖

func (s *AppsService) ListRepos(ctx context.Context, opt *ListOptions) ([]*Repository, *Response, error)

ListRepos lists the repositories that are accessible to the authenticated installation.

GitHub API docs: https://developer.github.com/v3/apps/installations/#list-repositories

func (*AppsService) ListUserInstallations ¶ Uses

❖

func (s *AppsService) ListUserInstallations(ctx context.Context, opt *ListOptions) ([]*Installation, *Response, error)

ListUserInstallations lists installations that are accessible to the authenticated user.

GitHub API docs: https://developer.github.com/v3/apps/#list-installations-for-user

func (*AppsService) ListUserRepos ¶ Uses

❖

func (s *AppsService) ListUserRepos(ctx context.Context, id int64, opt *ListOptions) ([]*Repository, *Response, error)

ListUserRepos lists repositories that are accessible to the authenticated user for an installation.

GitHub API docs: https://developer.github.com/v3/apps/installations/#list-repositories-accessible-to-the-user-for-an-installation

func (*AppsService) RemoveRepository ¶ Uses

❖

func (s *AppsService) RemoveRepository(ctx context.Context, instID, repoID int64) (*Response, error)

RemoveRepository removes a single repository from an installation.

GitHub docs: https://developer.github.com/v3/apps/installations/#remove-repository-from-installation

type Authorization ¶ Uses

❖

type Authorization struct {
    ID             *int64            `json:"id,omitempty"`
    URL            *string           `json:"url,omitempty"`
    Scopes         []Scope           `json:"scopes,omitempty"`
    Token          *string           `json:"token,omitempty"`
    TokenLastEight *string           `json:"token_last_eight,omitempty"`
    HashedToken    *string           `json:"hashed_token,omitempty"`
    App            *AuthorizationApp `json:"app,omitempty"`
    Note           *string           `json:"note,omitempty"`
    NoteURL        *string           `json:"note_url,omitempty"`
    UpdatedAt      *Timestamp        `json:"updated_at,omitempty"`
    CreatedAt      *Timestamp        `json:"created_at,omitempty"`
    Fingerprint    *string           `json:"fingerprint,omitempty"`

    // User is only populated by the Check and Reset methods.
    User *User `json:"user,omitempty"`
}

Authorization represents an individual GitHub authorization.

func (*Authorization) GetApp ¶ Uses

❖

func (a *Authorization) GetApp() *AuthorizationApp

GetApp returns the App field.

func (*Authorization) GetCreatedAt ¶ Uses

❖

func (a *Authorization) GetCreatedAt() Timestamp

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*Authorization) GetFingerprint ¶ Uses

❖

func (a *Authorization) GetFingerprint() string

GetFingerprint returns the Fingerprint field if it's non-nil, zero value otherwise.

func (*Authorization) GetHashedToken ¶ Uses

❖

func (a *Authorization) GetHashedToken() string

GetHashedToken returns the HashedToken field if it's non-nil, zero value otherwise.

func (*Authorization) GetID ¶ Uses

❖

func (a *Authorization) GetID() int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*Authorization) GetNote ¶ Uses

❖

func (a *Authorization) GetNote() string

GetNote returns the Note field if it's non-nil, zero value otherwise.

func (*Authorization) GetNoteURL ¶ Uses

❖

func (a *Authorization) GetNoteURL() string

GetNoteURL returns the NoteURL field if it's non-nil, zero value otherwise.

func (*Authorization) GetToken ¶ Uses

❖

func (a *Authorization) GetToken() string

GetToken returns the Token field if it's non-nil, zero value otherwise.

func (*Authorization) GetTokenLastEight ¶ Uses

❖

func (a *Authorization) GetTokenLastEight() string

GetTokenLastEight returns the TokenLastEight field if it's non-nil, zero value otherwise.

func (*Authorization) GetURL ¶ Uses

❖

func (a *Authorization) GetURL() string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*Authorization) GetUpdatedAt ¶ Uses

❖

func (a *Authorization) GetUpdatedAt() Timestamp

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

func (*Authorization) GetUser ¶ Uses

❖

func (a *Authorization) GetUser() *User

GetUser returns the User field.

func (Authorization) String ¶ Uses

❖

func (a Authorization) String() string

type AuthorizationApp ¶ Uses

❖

type AuthorizationApp struct {
    URL      *string `json:"url,omitempty"`
    Name     *string `json:"name,omitempty"`
    ClientID *string `json:"client_id,omitempty"`
}

AuthorizationApp represents an individual GitHub app (in the context of authorization).

func (*AuthorizationApp) GetClientID ¶ Uses

❖

func (a *AuthorizationApp) GetClientID() string

GetClientID returns the ClientID field if it's non-nil, zero value otherwise.

func (*AuthorizationApp) GetName ¶ Uses

❖

func (a *AuthorizationApp) GetName() string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*AuthorizationApp) GetURL ¶ Uses

❖

func (a *AuthorizationApp) GetURL() string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (AuthorizationApp) String ¶ Uses

❖

func (a AuthorizationApp) String() string

type AuthorizationRequest ¶ Uses

❖

type AuthorizationRequest struct {
    Scopes       []Scope `json:"scopes,omitempty"`
    Note         *string `json:"note,omitempty"`
    NoteURL      *string `json:"note_url,omitempty"`
    ClientID     *string `json:"client_id,omitempty"`
    ClientSecret *string `json:"client_secret,omitempty"`
    Fingerprint  *string `json:"fingerprint,omitempty"`
}

AuthorizationRequest represents a request to create an authorization.

func (*AuthorizationRequest) GetClientID ¶ Uses

❖

func (a *AuthorizationRequest) GetClientID() string

GetClientID returns the ClientID field if it's non-nil, zero value otherwise.

func (*AuthorizationRequest) GetClientSecret ¶ Uses

❖

func (a *AuthorizationRequest) GetClientSecret() string

GetClientSecret returns the ClientSecret field if it's non-nil, zero value otherwise.

func (*AuthorizationRequest) GetFingerprint ¶ Uses

❖

func (a *AuthorizationRequest) GetFingerprint() string

GetFingerprint returns the Fingerprint field if it's non-nil, zero value otherwise.

func (*AuthorizationRequest) GetNote ¶ Uses

❖

func (a *AuthorizationRequest) GetNote() string

GetNote returns the Note field if it's non-nil, zero value otherwise.

func (*AuthorizationRequest) GetNoteURL ¶ Uses

❖

func (a *AuthorizationRequest) GetNoteURL() string

GetNoteURL returns the NoteURL field if it's non-nil, zero value otherwise.

func (AuthorizationRequest) String ¶ Uses

❖

func (a AuthorizationRequest) String() string

type AuthorizationUpdateRequest ¶ Uses

❖

type AuthorizationUpdateRequest struct {
    Scopes       []string `json:"scopes,omitempty"`
    AddScopes    []string `json:"add_scopes,omitempty"`
    RemoveScopes []string `json:"remove_scopes,omitempty"`
    Note         *string  `json:"note,omitempty"`
    NoteURL      *string  `json:"note_url,omitempty"`
    Fingerprint  *string  `json:"fingerprint,omitempty"`
}

AuthorizationUpdateRequest represents a request to update an authorization.

Note that for any one update, you must only provide one of the "scopes" fields. That is, you may provide only one of "Scopes", or "AddScopes", or "RemoveScopes".

GitHub API docs: https://developer.github.com/v3/oauth_authorizations/#update-an-existing-authorization

func (*AuthorizationUpdateRequest) GetFingerprint ¶ Uses

❖

func (a *AuthorizationUpdateRequest) GetFingerprint() string

GetFingerprint returns the Fingerprint field if it's non-nil, zero value otherwise.

func (*AuthorizationUpdateRequest) GetNote ¶ Uses

❖

func (a *AuthorizationUpdateRequest) GetNote() string

GetNote returns the Note field if it's non-nil, zero value otherwise.

func (*AuthorizationUpdateRequest) GetNoteURL ¶ Uses

❖

func (a *AuthorizationUpdateRequest) GetNoteURL() string

GetNoteURL returns the NoteURL field if it's non-nil, zero value otherwise.

func (AuthorizationUpdateRequest) String ¶ Uses

❖

func (a AuthorizationUpdateRequest) String() string

type AuthorizationsService ¶ Uses

❖

type AuthorizationsService service

AuthorizationsService handles communication with the authorization related methods of the GitHub API.

This service requires HTTP Basic Authentication; it cannot be accessed using an OAuth token.

GitHub API docs: https://developer.github.com/v3/oauth_authorizations/

func (*AuthorizationsService) Check ¶ Uses

❖

func (s *AuthorizationsService) Check(ctx context.Context, clientID string, token string) (*Authorization, *Response, error)

Check if an OAuth token is valid for a specific app.

Note that this operation requires the use of BasicAuth, but where the username is the OAuth application clientID, and the password is its clientSecret. Invalid tokens will return a 404 Not Found.

The returned Authorization.User field will be populated.

GitHub API docs: https://developer.github.com/v3/oauth_authorizations/#check-an-authorization

func (*AuthorizationsService) Create ¶ Uses

❖

func (s *AuthorizationsService) Create(ctx context.Context, auth *AuthorizationRequest) (*Authorization, *Response, error)

Create a new authorization for the specified OAuth application.

GitHub API docs: https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization

func (*AuthorizationsService) CreateImpersonation ¶ Uses

❖

func (s *AuthorizationsService) CreateImpersonation(ctx context.Context, username string, authReq *AuthorizationRequest) (*Authorization, *Response, error)

CreateImpersonation creates an impersonation OAuth token.

This requires admin permissions. With the returned Authorization.Token you can e.g. create or delete a user's public SSH key. NOTE: creating a new token automatically revokes an existing one.

GitHub API docs: https://developer.github.com/enterprise/v3/enterprise-admin/users/#create-an-impersonation-oauth-token

func (*AuthorizationsService) Delete ¶ Uses

❖

func (s *AuthorizationsService) Delete(ctx context.Context, id int64) (*Response, error)

Delete a single authorization.

GitHub API docs: https://developer.github.com/v3/oauth_authorizations/#delete-an-authorization

func (*AuthorizationsService) DeleteGrant ¶ Uses

❖

func (s *AuthorizationsService) DeleteGrant(ctx context.Context, id int64) (*Response, error)

DeleteGrant deletes an OAuth application grant. Deleting an application's grant will also delete all OAuth tokens associated with the application for the user.

GitHub API docs: https://developer.github.com/v3/oauth_authorizations/#delete-a-grant

func (*AuthorizationsService) DeleteImpersonation ¶ Uses

❖

func (s *AuthorizationsService) DeleteImpersonation(ctx context.Context, username string) (*Response, error)

DeleteImpersonation deletes an impersonation OAuth token.

NOTE: there can be only one at a time.

GitHub API docs: https://developer.github.com/enterprise/v3/enterprise-admin/users/#delete-an-impersonation-oauth-token

func (*AuthorizationsService) Edit ¶ Uses

❖

func (s *AuthorizationsService) Edit(ctx context.Context, id int64, auth *AuthorizationUpdateRequest) (*Authorization, *Response, error)

Edit a single authorization.

GitHub API docs: https://developer.github.com/v3/oauth_authorizations/#update-an-existing-authorization

func (*AuthorizationsService) Get ¶ Uses

❖

func (s *AuthorizationsService) Get(ctx context.Context, id int64) (*Authorization, *Response, error)

Get a single authorization.

GitHub API docs: https://developer.github.com/v3/oauth_authorizations/#get-a-single-authorization

func (*AuthorizationsService) GetGrant ¶ Uses

❖

func (s *AuthorizationsService) GetGrant(ctx context.Context, id int64) (*Grant, *Response, error)

GetGrant gets a single OAuth application grant.

GitHub API docs: https://developer.github.com/v3/oauth_authorizations/#get-a-single-grant

func (*AuthorizationsService) GetOrCreateForApp ¶ Uses

❖

func (s *AuthorizationsService) GetOrCreateForApp(ctx context.Context, clientID string, auth *AuthorizationRequest) (*Authorization, *Response, error)

GetOrCreateForApp creates a new authorization for the specified OAuth application, only if an authorization for that application doesn’t already exist for the user.

If a new token is created, the HTTP status code will be "201 Created", and the returned Authorization.Token field will be populated. If an existing token is returned, the status code will be "200 OK" and the Authorization.Token field will be empty.

clientID is the OAuth Client ID with which to create the token.

GitHub API docs: https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint

func (*AuthorizationsService) List ¶ Uses

❖

func (s *AuthorizationsService) List(ctx context.Context, opt *ListOptions) ([]*Authorization, *Response, error)

List the authorizations for the authenticated user.

GitHub API docs: https://developer.github.com/v3/oauth_authorizations/#list-your-authorizations

func (*AuthorizationsService) ListGrants ¶ Uses

❖

func (s *AuthorizationsService) ListGrants(ctx context.Context, opt *ListOptions) ([]*Grant, *Response, error)

ListGrants lists the set of OAuth applications that have been granted access to a user's account. This will return one entry for each application that has been granted access to the account, regardless of the number of tokens an application has generated for the user.

GitHub API docs: https://developer.github.com/v3/oauth_authorizations/#list-your-grants

func (*AuthorizationsService) Reset ¶ Uses

❖

func (s *AuthorizationsService) Reset(ctx context.Context, clientID string, token string) (*Authorization, *Response, error)

Reset is used to reset a valid OAuth token without end user involvement. Applications must save the "token" property in the response, because changes take effect immediately.

Note that this operation requires the use of BasicAuth, but where the username is the OAuth application clientID, and the password is its clientSecret. Invalid tokens will return a 404 Not Found.

The returned Authorization.User field will be populated.

GitHub API docs: https://developer.github.com/v3/oauth_authorizations/#reset-an-authorization

func (*AuthorizationsService) Revoke ¶ Uses

❖

func (s *AuthorizationsService) Revoke(ctx context.Context, clientID string, token string) (*Response, error)

Revoke an authorization for an application.

Note that this operation requires the use of BasicAuth, but where the username is the OAuth application clientID, and the password is its clientSecret. Invalid tokens will return a 404 Not Found.

GitHub API docs: https://developer.github.com/v3/oauth_authorizations/#revoke-an-authorization-for-an-application

type AutoTriggerCheck ¶ Uses

❖

type AutoTriggerCheck struct {
    AppID   *int64 `json:"app_id,omitempty"`  // The id of the GitHub App. (Required.)
    Setting *bool  `json:"setting,omitempty"` // Set to "true" to enable automatic creation of CheckSuite events upon pushes to the repository, or "false" to disable them. Default: "true" (Required.)
}

AutoTriggerCheck enables or disables automatic creation of CheckSuite events upon pushes to the repository.

func (*AutoTriggerCheck) GetAppID ¶ Uses

❖

func (a *AutoTriggerCheck) GetAppID() int64

GetAppID returns the AppID field if it's non-nil, zero value otherwise.

func (*AutoTriggerCheck) GetSetting ¶ Uses

❖

func (a *AutoTriggerCheck) GetSetting() bool

GetSetting returns the Setting field if it's non-nil, zero value otherwise.

type BasicAuthTransport ¶ Uses

❖

type BasicAuthTransport struct {
    Username string // GitHub username
    Password string // GitHub password
    OTP      string // one-time password for users with two-factor auth enabled

    // Transport is the underlying HTTP transport to use when making requests.
    // It will default to http.DefaultTransport if nil.
    Transport http.RoundTripper
}

BasicAuthTransport is an http.RoundTripper that authenticates all requests using HTTP Basic Authentication with the provided username and password. It additionally supports users who have two-factor authentication enabled on their GitHub account.

func (*BasicAuthTransport) Client ¶ Uses

❖

func (t *BasicAuthTransport) Client() *http.Client

Client returns an *http.Client that makes requests that are authenticated using HTTP Basic Authentication.

func (*BasicAuthTransport) RoundTrip ¶ Uses

❖

func (t *BasicAuthTransport) RoundTrip(req *http.Request) (*http.Response, error)

RoundTrip implements the RoundTripper interface.

type Blob ¶ Uses

❖

type Blob struct {
    Content  *string `json:"content,omitempty"`
    Encoding *string `json:"encoding,omitempty"`
    SHA      *string `json:"sha,omitempty"`
    Size     *int    `json:"size,omitempty"`
    URL      *string `json:"url,omitempty"`
    NodeID   *string `json:"node_id,omitempty"`
}

Blob represents a blob object.

func (*Blob) GetContent ¶ Uses

❖

func (b *Blob) GetContent() string

GetContent returns the Content field if it's non-nil, zero value otherwise.

func (*Blob) GetEncoding ¶ Uses

❖

func (b *Blob) GetEncoding() string

GetEncoding returns the Encoding field if it's non-nil, zero value otherwise.

func (*Blob) GetNodeID ¶ Uses

❖

func (b *Blob) GetNodeID() string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*Blob) GetSHA ¶ Uses

❖

func (b *Blob) GetSHA() string

GetSHA returns the SHA field if it's non-nil, zero value otherwise.

func (*Blob) GetSize ¶ Uses

❖

func (b *Blob) GetSize() int

GetSize returns the Size field if it's non-nil, zero value otherwise.

func (*Blob) GetURL ¶ Uses

❖

func (b *Blob) GetURL() string

GetURL returns the URL field if it's non-nil, zero value otherwise.

type Branch ¶ Uses

❖

type Branch struct {
    Name      *string           `json:"name,omitempty"`
    Commit    *RepositoryCommit `json:"commit,omitempty"`
    Protected *bool             `json:"protected,omitempty"`
}

Branch represents a repository branch

func (*Branch) GetCommit ¶ Uses

❖

func (b *Branch) GetCommit() *RepositoryCommit

GetCommit returns the Commit field.

func (*Branch) GetName ¶ Uses

❖

func (b *Branch) GetName() string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*Branch) GetProtected ¶ Uses

❖

func (b *Branch) GetProtected() bool

GetProtected returns the Protected field if it's non-nil, zero value otherwise.

type BranchRestrictions ¶ Uses

❖

type BranchRestrictions struct {
    // The list of user logins with push access.
    Users []*User `json:"users"`
    // The list of team slugs with push access.
    Teams []*Team `json:"teams"`
}

BranchRestrictions represents the restriction that only certain users or teams may push to a branch.

type BranchRestrictionsRequest ¶ Uses

❖

type BranchRestrictionsRequest struct {
    // The list of user logins with push access. (Required; use []string{} instead of nil for empty list.)
    Users []string `json:"users"`
    // The list of team slugs with push access. (Required; use []string{} instead of nil for empty list.)
    Teams []string `json:"teams"`
}

BranchRestrictionsRequest represents the request to create/edit the restriction that only certain users or teams may push to a branch. It is separate from BranchRestrictions above because the request structure is different from the response structure.

type CheckRun ¶ Uses

❖

type CheckRun struct {
    ID           *int64          `json:"id,omitempty"`
    NodeID       *string         `json:"node_id,omitempty"`
    HeadSHA      *string         `json:"head_sha,omitempty"`
    ExternalID   *string         `json:"external_id,omitempty"`
    URL          *string         `json:"url,omitempty"`
    HTMLURL      *string         `json:"html_url,omitempty"`
    DetailsURL   *string         `json:"details_url,omitempty"`
    Status       *string         `json:"status,omitempty"`
    Conclusion   *string         `json:"conclusion,omitempty"`
    StartedAt    *Timestamp      `json:"started_at,omitempty"`
    CompletedAt  *Timestamp      `json:"completed_at,omitempty"`
    Output       *CheckRunOutput `json:"output,omitempty"`
    Name         *string         `json:"name,omitempty"`
    CheckSuite   *CheckSuite     `json:"check_suite,omitempty"`
    App          *App            `json:"app,omitempty"`
    PullRequests []*PullRequest  `json:"pull_requests,omitempty"`
}

CheckRun represents a GitHub check run on a repository associated with a GitHub app.

func (*CheckRun) GetApp ¶ Uses

❖

func (c *CheckRun) GetApp() *App

GetApp returns the App field.

func (*CheckRun) GetCheckSuite ¶ Uses

❖

func (c *CheckRun) GetCheckSuite() *CheckSuite

GetCheckSuite returns the CheckSuite field.

func (*CheckRun) GetCompletedAt ¶ Uses

❖

func (c *CheckRun) GetCompletedAt() Timestamp

GetCompletedAt returns the CompletedAt field if it's non-nil, zero value otherwise.

func (*CheckRun) GetConclusion ¶ Uses

❖

func (c *CheckRun) GetConclusion() string

GetConclusion returns the Conclusion field if it's non-nil, zero value otherwise.

func (*CheckRun) GetDetailsURL ¶ Uses

❖

func (c *CheckRun) GetDetailsURL() string

GetDetailsURL returns the DetailsURL field if it's non-nil, zero value otherwise.

func (*CheckRun) GetExternalID ¶ Uses

❖

func (c *CheckRun) GetExternalID() string

GetExternalID returns the ExternalID field if it's non-nil, zero value otherwise.

func (*CheckRun) GetHTMLURL ¶ Uses

❖

func (c *CheckRun) GetHTMLURL() string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*CheckRun) GetHeadSHA ¶ Uses

❖

func (c *CheckRun) GetHeadSHA() string

GetHeadSHA returns the HeadSHA field if it's non-nil, zero value otherwise.

func (*CheckRun) GetID ¶ Uses

❖

func (c *CheckRun) GetID() int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*CheckRun) GetName ¶ Uses

❖

func (c *CheckRun) GetName() string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*CheckRun) GetNodeID ¶ Uses

❖

func (c *CheckRun) GetNodeID() string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*CheckRun) GetOutput ¶ Uses

❖

func (c *CheckRun) GetOutput() *CheckRunOutput

GetOutput returns the Output field.

func (*CheckRun) GetStartedAt ¶ Uses

❖

func (c *CheckRun) GetStartedAt() Timestamp

GetStartedAt returns the StartedAt field if it's non-nil, zero value otherwise.

func (*CheckRun) GetStatus ¶ Uses

❖

func (c *CheckRun) GetStatus() string

GetStatus returns the Status field if it's non-nil, zero value otherwise.

func (*CheckRun) GetURL ¶ Uses

❖

func (c *CheckRun) GetURL() string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (CheckRun) String ¶ Uses

❖

func (c CheckRun) String() string

type CheckRunAction ¶ Uses

❖

type CheckRunAction struct {
    Label       string `json:"label"`       // The text to be displayed on a button in the web UI. The maximum size is 20 characters. (Required.)
    Description string `json:"description"` // A short explanation of what this action would do. The maximum size is 40 characters. (Required.)
    Identifier  string `json:"identifier"`  // A reference for the action on the integrator's system. The maximum size is 20 characters. (Required.)
}

CheckRunAction exposes further actions the integrator can perform, which a user may trigger.

type CheckRunAnnotation ¶ Uses

❖

type CheckRunAnnotation struct {
    Path            *string `json:"path,omitempty"`
    BlobHRef        *string `json:"blob_href,omitempty"`
    StartLine       *int    `json:"start_line,omitempty"`
    EndLine         *int    `json:"end_line,omitempty"`
    AnnotationLevel *string `json:"annotation_level,omitempty"`
    Message         *string `json:"message,omitempty"`
    Title           *string `json:"title,omitempty"`
    RawDetails      *string `json:"raw_details,omitempty"`
}

CheckRunAnnotation represents an annotation object for a CheckRun output.

func (*CheckRunAnnotation) GetAnnotationLevel ¶ Uses

❖

func (c *CheckRunAnnotation) GetAnnotationLevel() string

GetAnnotationLevel returns the AnnotationLevel field if it's non-nil, zero value otherwise.

func (*CheckRunAnnotation) GetBlobHRef ¶ Uses

❖

func (c *CheckRunAnnotation) GetBlobHRef() string

GetBlobHRef returns the BlobHRef field if it's non-nil, zero value otherwise.

func (*CheckRunAnnotation) GetEndLine ¶ Uses

❖

func (c *CheckRunAnnotation) GetEndLine() int

GetEndLine returns the EndLine field if it's non-nil, zero value otherwise.

func (*CheckRunAnnotation) GetMessage ¶ Uses

❖

func (c *CheckRunAnnotation) GetMessage() string

GetMessage returns the Message field if it's non-nil, zero value otherwise.

func (*CheckRunAnnotation) GetPath ¶ Uses

❖

func (c *CheckRunAnnotation) GetPath() string

GetPath returns the Path field if it's non-nil, zero value otherwise.

func (*CheckRunAnnotation) GetRawDetails ¶ Uses

❖

func (c *CheckRunAnnotation) GetRawDetails() string

GetRawDetails returns the RawDetails field if it's non-nil, zero value otherwise.

func (*CheckRunAnnotation) GetStartLine ¶ Uses

❖

func (c *CheckRunAnnotation) GetStartLine() int

GetStartLine returns the StartLine field if it's non-nil, zero value otherwise.

func (*CheckRunAnnotation) GetTitle ¶ Uses

❖

func (c *CheckRunAnnotation) GetTitle() string

GetTitle returns the Title field if it's non-nil, zero value otherwise.

type CheckRunEvent ¶ Uses

❖

type CheckRunEvent struct {
    CheckRun *CheckRun `json:"check_run,omitempty"`
    // The action performed. Can be "created", "updated", "rerequested" or "requested_action".
    Action *string `json:"action,omitempty"`

    // The following fields are only populated by Webhook events.
    Repo         *Repository   `json:"repository,omitempty"`
    Org          *Organization `json:"organization,omitempty"`
    Sender       *User         `json:"sender,omitempty"`
    Installation *Installation `json:"installation,omitempty"`

    // The action requested by the user. Populated when the Action is "requested_action".
    RequestedAction *RequestedAction `json:"requested_action,omitempty"` //
}

CheckRunEvent is triggered when a check run is "created", "updated", or "re-requested". The Webhook event name is "check_run".

GitHub API docs: https://developer.github.com/v3/activity/events/types/#checkrunevent

func (*CheckRunEvent) GetAction ¶ Uses

❖

func (c *CheckRunEvent) GetAction() string

GetAction returns the Action field if it's non-nil, zero value otherwise.

func (*CheckRunEvent) GetCheckRun ¶ Uses

❖

func (c *CheckRunEvent) GetCheckRun() *CheckRun

GetCheckRun returns the CheckRun field.

func (*CheckRunEvent) GetInstallation ¶ Uses

❖

func (c *CheckRunEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*CheckRunEvent) GetOrg ¶ Uses

❖

func (c *CheckRunEvent) GetOrg() *Organization

GetOrg returns the Org field.

func (*CheckRunEvent) GetRepo ¶ Uses

❖

func (c *CheckRunEvent) GetRepo() *Repository

GetRepo returns the Repo field.

func (*CheckRunEvent) GetRequestedAction ¶ Uses

❖

func (c *CheckRunEvent) GetRequestedAction() *RequestedAction

GetRequestedAction returns the RequestedAction field.

func (*CheckRunEvent) GetSender ¶ Uses

❖

func (c *CheckRunEvent) GetSender() *User

GetSender returns the Sender field.

type CheckRunImage ¶ Uses

❖

type CheckRunImage struct {
    Alt      *string `json:"alt,omitempty"`
    ImageURL *string `json:"image_url,omitempty"`
    Caption  *string `json:"caption,omitempty"`
}

CheckRunImage represents an image object for a CheckRun output.

func (*CheckRunImage) GetAlt ¶ Uses

❖

func (c *CheckRunImage) GetAlt() string

GetAlt returns the Alt field if it's non-nil, zero value otherwise.

func (*CheckRunImage) GetCaption ¶ Uses

❖

func (c *CheckRunImage) GetCaption() string

GetCaption returns the Caption field if it's non-nil, zero value otherwise.

func (*CheckRunImage) GetImageURL ¶ Uses

❖

func (c *CheckRunImage) GetImageURL() string

GetImageURL returns the ImageURL field if it's non-nil, zero value otherwise.

type CheckRunOutput ¶ Uses

❖

type CheckRunOutput struct {
    Title            *string               `json:"title,omitempty"`
    Summary          *string               `json:"summary,omitempty"`
    Text             *string               `json:"text,omitempty"`
    AnnotationsCount *int                  `json:"annotations_count,omitempty"`
    AnnotationsURL   *string               `json:"annotations_url,omitempty"`
    Annotations      []*CheckRunAnnotation `json:"annotations,omitempty"`
    Images           []*CheckRunImage      `json:"images,omitempty"`
}

CheckRunOutput represents the output of a CheckRun.

func (*CheckRunOutput) GetAnnotationsCount ¶ Uses

❖

func (c *CheckRunOutput) GetAnnotationsCount() int

GetAnnotationsCount returns the AnnotationsCount field if it's non-nil, zero value otherwise.

func (*CheckRunOutput) GetAnnotationsURL ¶ Uses

❖

func (c *CheckRunOutput) GetAnnotationsURL() string

GetAnnotationsURL returns the AnnotationsURL field if it's non-nil, zero value otherwise.

func (*CheckRunOutput) GetSummary ¶ Uses

❖

func (c *CheckRunOutput) GetSummary() string

GetSummary returns the Summary field if it's non-nil, zero value otherwise.

func (*CheckRunOutput) GetText ¶ Uses

❖

func (c *CheckRunOutput) GetText() string

GetText returns the Text field if it's non-nil, zero value otherwise.

func (*CheckRunOutput) GetTitle ¶ Uses

❖

func (c *CheckRunOutput) GetTitle() string

GetTitle returns the Title field if it's non-nil, zero value otherwise.

type CheckSuite ¶ Uses

❖

type CheckSuite struct {
    ID           *int64         `json:"id,omitempty"`
    NodeID       *string        `json:"node_id,omitempty"`
    HeadBranch   *string        `json:"head_branch,omitempty"`
    HeadSHA      *string        `json:"head_sha,omitempty"`
    URL          *string        `json:"url,omitempty"`
    BeforeSHA    *string        `json:"before,omitempty"`
    AfterSHA     *string        `json:"after,omitempty"`
    Status       *string        `json:"status,omitempty"`
    Conclusion   *string        `json:"conclusion,omitempty"`
    App          *App           `json:"app,omitempty"`
    Repository   *Repository    `json:"repository,omitempty"`
    PullRequests []*PullRequest `json:"pull_requests,omitempty"`
}

CheckSuite represents a suite of check runs.

func (*CheckSuite) GetAfterSHA ¶ Uses

❖

func (c *CheckSuite) GetAfterSHA() string

GetAfterSHA returns the AfterSHA field if it's non-nil, zero value otherwise.

func (*CheckSuite) GetApp ¶ Uses

❖

func (c *CheckSuite) GetApp() *App

GetApp returns the App field.

func (*CheckSuite) GetBeforeSHA ¶ Uses

❖

func (c *CheckSuite) GetBeforeSHA() string

GetBeforeSHA returns the BeforeSHA field if it's non-nil, zero value otherwise.

func (*CheckSuite) GetConclusion ¶ Uses

❖

func (c *CheckSuite) GetConclusion() string

GetConclusion returns the Conclusion field if it's non-nil, zero value otherwise.

func (*CheckSuite) GetHeadBranch ¶ Uses

❖

func (c *CheckSuite) GetHeadBranch() string

GetHeadBranch returns the HeadBranch field if it's non-nil, zero value otherwise.

func (*CheckSuite) GetHeadSHA ¶ Uses

❖

func (c *CheckSuite) GetHeadSHA() string

GetHeadSHA returns the HeadSHA field if it's non-nil, zero value otherwise.

func (*CheckSuite) GetID ¶ Uses

❖

func (c *CheckSuite) GetID() int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*CheckSuite) GetNodeID ¶ Uses

❖

func (c *CheckSuite) GetNodeID() string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*CheckSuite) GetRepository ¶ Uses

❖

func (c *CheckSuite) GetRepository() *Repository

GetRepository returns the Repository field.

func (*CheckSuite) GetStatus ¶ Uses

❖

func (c *CheckSuite) GetStatus() string

GetStatus returns the Status field if it's non-nil, zero value otherwise.

func (*CheckSuite) GetURL ¶ Uses

❖

func (c *CheckSuite) GetURL() string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (CheckSuite) String ¶ Uses

❖

func (c CheckSuite) String() string

type CheckSuiteEvent ¶ Uses

❖

type CheckSuiteEvent struct {
    CheckSuite *CheckSuite `json:"check_suite,omitempty"`
    // The action performed. Can be "completed", "requested" or "re-requested".
    Action *string `json:"action,omitempty"`

    // The following fields are only populated by Webhook events.
    Repo         *Repository   `json:"repository,omitempty"`
    Org          *Organization `json:"organization,omitempty"`
    Sender       *User         `json:"sender,omitempty"`
    Installation *Installation `json:"installation,omitempty"`
}

CheckSuiteEvent is triggered when a check suite is "completed", "requested", or "re-requested". The Webhook event name is "check_suite".

GitHub API docs: https://developer.github.com/v3/activity/events/types/#checksuiteevent

func (*CheckSuiteEvent) GetAction ¶ Uses

❖

func (c *CheckSuiteEvent) GetAction() string

GetAction returns the Action field if it's non-nil, zero value otherwise.

func (*CheckSuiteEvent) GetCheckSuite ¶ Uses

❖

func (c *CheckSuiteEvent) GetCheckSuite() *CheckSuite

GetCheckSuite returns the CheckSuite field.

func (*CheckSuiteEvent) GetInstallation ¶ Uses

❖

func (c *CheckSuiteEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*CheckSuiteEvent) GetOrg ¶ Uses

❖

func (c *CheckSuiteEvent) GetOrg() *Organization

GetOrg returns the Org field.

func (*CheckSuiteEvent) GetRepo ¶ Uses

❖

func (c *CheckSuiteEvent) GetRepo() *Repository

GetRepo returns the Repo field.

func (*CheckSuiteEvent) GetSender ¶ Uses

❖

func (c *CheckSuiteEvent) GetSender() *User

GetSender returns the Sender field.

type CheckSuitePreferenceOptions ¶ Uses

❖

type CheckSuitePreferenceOptions struct {
    PreferenceList *PreferenceList `json:"auto_trigger_checks,omitempty"` // A list of auto trigger checks that can be set for a check suite in a repository.
}

CheckSuitePreferenceOptions set options for check suite preferences for a repository.

func (*CheckSuitePreferenceOptions) GetPreferenceList ¶ Uses

❖

func (c *CheckSuitePreferenceOptions) GetPreferenceList() *PreferenceList

GetPreferenceList returns the PreferenceList field.

type CheckSuitePreferenceResults ¶ Uses

❖

type CheckSuitePreferenceResults struct {
    Preferences *PreferenceList `json:"preferences,omitempty"`
    Repository  *Repository     `json:"repository,omitempty"`
}

CheckSuitePreferenceResults represents the results of the preference set operation.

func (*CheckSuitePreferenceResults) GetPreferences ¶ Uses

❖

func (c *CheckSuitePreferenceResults) GetPreferences() *PreferenceList

GetPreferences returns the Preferences field.

func (*CheckSuitePreferenceResults) GetRepository ¶ Uses

❖

func (c *CheckSuitePreferenceResults) GetRepository() *Repository

GetRepository returns the Repository field.

type ChecksService ¶ Uses

❖

type ChecksService service

ChecksService provides access to the Checks API in the GitHub API.

GitHub API docs: https://developer.github.com/v3/checks/

func (*ChecksService) CreateCheckRun ¶ Uses

❖

func (s *ChecksService) CreateCheckRun(ctx context.Context, owner, repo string, opt CreateCheckRunOptions) (*CheckRun, *Response, error)

CreateCheckRun creates a check run for repository.

GitHub API docs: https://developer.github.com/v3/checks/runs/#create-a-check-run

func (*ChecksService) CreateCheckSuite ¶ Uses

❖

func (s *ChecksService) CreateCheckSuite(ctx context.Context, owner, repo string, opt CreateCheckSuiteOptions) (*CheckSuite, *Response, error)

CreateCheckSuite manually creates a check suite for a repository.

GitHub API docs: https://developer.github.com/v3/checks/suites/#create-a-check-suite

func (*ChecksService) GetCheckRun ¶ Uses

❖

func (s *ChecksService) GetCheckRun(ctx context.Context, owner, repo string, checkRunID int64) (*CheckRun, *Response, error)

GetCheckRun gets a check-run for a repository.

GitHub API docs: https://developer.github.com/v3/checks/runs/#get-a-single-check-run

func (*ChecksService) GetCheckSuite ¶ Uses

❖

func (s *ChecksService) GetCheckSuite(ctx context.Context, owner, repo string, checkSuiteID int64) (*CheckSuite, *Response, error)

GetCheckSuite gets a single check suite.

GitHub API docs: https://developer.github.com/v3/checks/suites/#get-a-single-check-suite

func (*ChecksService) ListCheckRunAnnotations ¶ Uses

❖

func (s *ChecksService) ListCheckRunAnnotations(ctx context.Context, owner, repo string, checkRunID int64, opt *ListOptions) ([]*CheckRunAnnotation, *Response, error)

ListCheckRunAnnotations lists the annotations for a check run.

GitHub API docs: https://developer.github.com/v3/checks/runs/#list-annotations-for-a-check-run

func (*ChecksService) ListCheckRunsCheckSuite ¶ Uses

❖

func (s *ChecksService) ListCheckRunsCheckSuite(ctx context.Context, owner, repo string, checkSuiteID int64, opt *ListCheckRunsOptions) (*ListCheckRunsResults, *Response, error)

ListCheckRunsCheckSuite lists check runs for a check suite.

GitHub API docs: https://developer.github.com/v3/checks/runs/#list-check-runs-in-a-check-suite

func (*ChecksService) ListCheckRunsForRef ¶ Uses

❖

func (s *ChecksService) ListCheckRunsForRef(ctx context.Context, owner, repo, ref string, opt *ListCheckRunsOptions) (*ListCheckRunsResults, *Response, error)

ListCheckRunsForRef lists check runs for a specific ref.

GitHub API docs: https://developer.github.com/v3/checks/runs/#list-check-runs-for-a-specific-ref

func (*ChecksService) ListCheckSuitesForRef ¶ Uses

❖

func (s *ChecksService) ListCheckSuitesForRef(ctx context.Context, owner, repo, ref string, opt *ListCheckSuiteOptions) (*ListCheckSuiteResults, *Response, error)

ListCheckSuitesForRef lists check suite for a specific ref.

GitHub API docs: https://developer.github.com/v3/checks/suites/#list-check-suites-for-a-specific-ref

func (*ChecksService) ReRequestCheckSuite ¶ Uses

❖

func (s *ChecksService) ReRequestCheckSuite(ctx context.Context, owner, repo string, checkSuiteID int64) (*Response, error)

ReRequestCheckSuite triggers GitHub to rerequest an existing check suite, without pushing new code to a repository.

GitHub API docs: https://developer.github.com/v3/checks/suites/#rerequest-check-suite

func (*ChecksService) SetCheckSuitePreferences ¶ Uses

❖

func (s *ChecksService) SetCheckSuitePreferences(ctx context.Context, owner, repo string, opt CheckSuitePreferenceOptions) (*CheckSuitePreferenceResults, *Response, error)

SetCheckSuitePreferences changes the default automatic flow when creating check suites.

GitHub API docs: https://developer.github.com/v3/checks/suites/#set-preferences-for-check-suites-on-a-repository

func (*ChecksService) UpdateCheckRun ¶ Uses

❖

func (s *ChecksService) UpdateCheckRun(ctx context.Context, owner, repo string, checkRunID int64, opt UpdateCheckRunOptions) (*CheckRun, *Response, error)

UpdateCheckRun updates a check run for a specific commit in a repository.

GitHub API docs: https://developer.github.com/v3/checks/runs/#update-a-check-run

type Client ¶ Uses

❖

type Client struct {

    // Base URL for API requests. Defaults to the public GitHub API, but can be
    // set to a domain endpoint to use with GitHub Enterprise. BaseURL should
    // always be specified with a trailing slash.
    BaseURL *url.URL

    // Base URL for uploading files.
    UploadURL *url.URL

    // User agent used when communicating with the GitHub API.
    UserAgent string

    // Services used for talking to different parts of the GitHub API.
    Activity       *ActivityService
    Admin          *AdminService
    Apps           *AppsService
    Authorizations *AuthorizationsService
    Checks         *ChecksService
    Gists          *GistsService
    Git            *GitService
    Gitignores     *GitignoresService
    Interactions   *InteractionsService
    Issues         *IssuesService
    Licenses       *LicensesService
    Marketplace    *MarketplaceService
    Migrations     *MigrationService
    Organizations  *OrganizationsService
    Projects       *ProjectsService
    PullRequests   *PullRequestsService
    Reactions      *ReactionsService
    Repositories   *RepositoriesService
    Search         *SearchService
    Teams          *TeamsService
    Users          *UsersService
    // contains filtered or unexported fields
}

A Client manages communication with the GitHub API.

func NewClient ¶ Uses

❖

func NewClient(httpClient *http.Client) *Client

NewClient returns a new GitHub API client. If a nil httpClient is provided, http.DefaultClient will be used. To use API methods which require authentication, provide an http.Client that will perform the authentication for you (such as that provided by the golang.org/x/oauth2 library).

func NewEnterpriseClient ¶ Uses

❖

func NewEnterpriseClient(baseURL, uploadURL string, httpClient *http.Client) (*Client, error)

NewEnterpriseClient returns a new GitHub API client with provided base URL and upload URL (often the same URL). If either URL does not have a trailing slash, one is added automatically. If a nil httpClient is provided, http.DefaultClient will be used.

Note that NewEnterpriseClient is a convenience helper only; its behavior is equivalent to using NewClient, followed by setting the BaseURL and UploadURL fields.

func (*Client) APIMeta ¶ Uses

❖

func (c *Client) APIMeta(ctx context.Context) (*APIMeta, *Response, error)

APIMeta returns information about GitHub.com, the service. Or, if you access this endpoint on your organization’s GitHub Enterprise installation, this endpoint provides information about that installation.

GitHub API docs: https://developer.github.com/v3/meta/

func (*Client) Do ¶ Uses

❖

func (c *Client) Do(ctx context.Context, req *http.Request, v interface{}) (*Response, error)

Do sends an API request and returns the API response. The API response is JSON decoded and stored in the value pointed to by v, or returned as an error if an API error has occurred. If v implements the io.Writer interface, the raw response body will be written to v, without attempting to first decode it. If rate limit is exceeded and reset time is in the future, Do returns *RateLimitError immediately without making a network API call.

The provided ctx must be non-nil. If it is canceled or times out, ctx.Err() will be returned.

func (*Client) GetCodeOfConduct ¶ Uses

❖

func (c *Client) GetCodeOfConduct(ctx context.Context, key string) (*CodeOfConduct, *Response, error)

GetCodeOfConduct returns an individual code of conduct.

https://developer.github.com/v3/codes_of_conduct/#get-an-individual-code-of-conduct

func (*Client) ListCodesOfConduct ¶ Uses

❖

func (c *Client) ListCodesOfConduct(ctx context.Context) ([]*CodeOfConduct, *Response, error)

ListCodesOfConduct returns all codes of conduct.

GitHub API docs: https://developer.github.com/v3/codes_of_conduct/#list-all-codes-of-conduct

func (*Client) ListEmojis ¶ Uses

❖

func (c *Client) ListEmojis(ctx context.Context) (map[string]string, *Response, error)

ListEmojis returns the emojis available to use on GitHub.

GitHub API docs: https://developer.github.com/v3/emojis/

func (*Client) ListServiceHooks ¶ Uses

❖

func (c *Client) ListServiceHooks(ctx context.Context) ([]*ServiceHook, *Response, error)

ListServiceHooks lists all of the available service hooks.

GitHub API docs: https://developer.github.com/webhooks/#services

func (*Client) Markdown ¶ Uses

❖

func (c *Client) Markdown(ctx context.Context, text string, opt *MarkdownOptions) (string, *Response, error)

Markdown renders an arbitrary Markdown document.

GitHub API docs: https://developer.github.com/v3/markdown/

Example

Code:

client := github.NewClient(nil)

input := "# heading #\n\nLink to issue #1"
opt := &github.MarkdownOptions{Mode: "gfm", Context: "google/go-github"}

output, _, err := client.Markdown(context.Background(), input, opt)
if err != nil {
    fmt.Println(err)
}

fmt.Println(output)

func (*Client) NewRequest ¶ Uses

❖

func (c *Client) NewRequest(method, urlStr string, body interface{}) (*http.Request, error)

NewRequest creates an API request. A relative URL can be provided in urlStr, in which case it is resolved relative to the BaseURL of the Client. Relative URLs should always be specified without a preceding slash. If specified, the value pointed to by body is JSON encoded and included as the request body.

func (*Client) NewUploadRequest ¶ Uses

❖

func (c *Client) NewUploadRequest(urlStr string, reader io.Reader, size int64, mediaType string) (*http.Request, error)

NewUploadRequest creates an upload request. A relative URL can be provided in urlStr, in which case it is resolved relative to the UploadURL of the Client. Relative URLs should always be specified without a preceding slash.

func (*Client) Octocat ¶ Uses

❖

func (c *Client) Octocat(ctx context.Context, message string) (string, *Response, error)

Octocat returns an ASCII art octocat with the specified message in a speech bubble. If message is empty, a random zen phrase is used.

func (*Client) RateLimits ¶ Uses

❖

func (c *Client) RateLimits(ctx context.Context) (*RateLimits, *Response, error)

RateLimits returns the rate limits for the current client.

func (*Client) Zen ¶ Uses

❖

func (c *Client) Zen(ctx context.Context) (string, *Response, error)

Zen returns a random line from The Zen of GitHub.

type CodeOfConduct ¶ Uses

❖

type CodeOfConduct struct {
    Name *string `json:"name,omitempty"`
    Key  *string `json:"key,omitempty"`
    URL  *string `json:"url,omitempty"`
    Body *string `json:"body,omitempty"`
}

CodeOfConduct represents a code of conduct.

func (*CodeOfConduct) GetBody ¶ Uses

❖

func (c *CodeOfConduct) GetBody() string

GetBody returns the Body field if it's non-nil, zero value otherwise.

func (*CodeOfConduct) GetKey ¶ Uses

❖

func (c *CodeOfConduct) GetKey() string

GetKey returns the Key field if it's non-nil, zero value otherwise.

func (*CodeOfConduct) GetName ¶ Uses

❖

func (c *CodeOfConduct) GetName() string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*CodeOfConduct) GetURL ¶ Uses

❖

func (c *CodeOfConduct) GetURL() string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*CodeOfConduct) String ¶ Uses

❖

func (c *CodeOfConduct) String() string

type CodeResult ¶ Uses

❖

type CodeResult struct {
    Name        *string     `json:"name,omitempty"`
    Path        *string     `json:"path,omitempty"`
    SHA         *string     `json:"sha,omitempty"`
    HTMLURL     *string     `json:"html_url,omitempty"`
    Repository  *Repository `json:"repository,omitempty"`
    TextMatches []TextMatch `json:"text_matches,omitempty"`
}

CodeResult represents a single search result.

func (*CodeResult) GetHTMLURL ¶ Uses

❖

func (c *CodeResult) GetHTMLURL() string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*CodeResult) GetName ¶ Uses

❖

func (c *CodeResult) GetName() string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*CodeResult) GetPath ¶ Uses

❖

func (c *CodeResult) GetPath() string

GetPath returns the Path field if it's non-nil, zero value otherwise.

func (*CodeResult) GetRepository ¶ Uses

❖

func (c *CodeResult) GetRepository() *Repository

GetRepository returns the Repository field.

func (*CodeResult) GetSHA ¶ Uses

❖

func (c *CodeResult) GetSHA() string

GetSHA returns the SHA field if it's non-nil, zero value otherwise.

func (CodeResult) String ¶ Uses

❖

func (c CodeResult) String() string

type CodeSearchResult ¶ Uses

❖

type CodeSearchResult struct {
    Total             *int         `json:"total_count,omitempty"`
    IncompleteResults *bool        `json:"incomplete_results,omitempty"`
    CodeResults       []CodeResult `json:"items,omitempty"`
}

CodeSearchResult represents the result of a code search.

func (*CodeSearchResult) GetIncompleteResults ¶ Uses

❖

func (c *CodeSearchResult) GetIncompleteResults() bool

GetIncompleteResults returns the IncompleteResults field if it's non-nil, zero value otherwise.

func (*CodeSearchResult) GetTotal ¶ Uses

❖

func (c *CodeSearchResult) GetTotal() int

GetTotal returns the Total field if it's non-nil, zero value otherwise.

type CombinedStatus ¶ Uses

❖

type CombinedStatus struct {
    // State is the combined state of the repository. Possible values are:
    // failure, pending, or success.
    State *string `json:"state,omitempty"`

    Name       *string      `json:"name,omitempty"`
    SHA        *string      `json:"sha,omitempty"`
    TotalCount *int         `json:"total_count,omitempty"`
    Statuses   []RepoStatus `json:"statuses,omitempty"`

    CommitURL     *string `json:"commit_url,omitempty"`
    RepositoryURL *string `json:"repository_url,omitempty"`
}

CombinedStatus represents the combined status of a repository at a particular reference.

func (*CombinedStatus) GetCommitURL ¶ Uses

❖

func (c *CombinedStatus) GetCommitURL() string

GetCommitURL returns the CommitURL field if it's non-nil, zero value otherwise.

func (*CombinedStatus) GetName ¶ Uses

❖

func (c *CombinedStatus) GetName() string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*CombinedStatus) GetRepositoryURL ¶ Uses

❖

func (c *CombinedStatus) GetRepositoryURL() string

GetRepositoryURL returns the RepositoryURL field if it's non-nil, zero value otherwise.

func (*CombinedStatus) GetSHA ¶ Uses

❖

func (c *CombinedStatus) GetSHA() string

GetSHA returns the SHA field if it's non-nil, zero value otherwise.

func (*CombinedStatus) GetState ¶ Uses

❖

func (c *CombinedStatus) GetState() string

GetState returns the State field if it's non-nil, zero value otherwise.

func (*CombinedStatus) GetTotalCount ¶ Uses

❖

func (c *CombinedStatus) GetTotalCount() int

GetTotalCount returns the TotalCount field if it's non-nil, zero value otherwise.

func (CombinedStatus) String ¶ Uses

❖

func (s CombinedStatus) String() string

type CommentStats ¶ Uses

❖

type CommentStats struct {
    TotalCommitComments      *int `json:"total_commit_comments,omitempty"`
    TotalGistComments        *int `json:"total_gist_comments,omitempty"`
    TotalIssueComments       *int `json:"total_issue_comments,omitempty"`
    TotalPullRequestComments *int `json:"total_pull_request_comments,omitempty"`
}

CommentStats represents the number of total comments on commits, gists, issues and pull requests.

func (*CommentStats) GetTotalCommitComments ¶ Uses

❖

func (c *CommentStats) GetTotalCommitComments() int

GetTotalCommitComments returns the TotalCommitComments field if it's non-nil, zero value otherwise.

func (*CommentStats) GetTotalGistComments ¶ Uses

❖

func (c *CommentStats) GetTotalGistComments() int

GetTotalGistComments returns the TotalGistComments field if it's non-nil, zero value otherwise.

func (*CommentStats) GetTotalIssueComments ¶ Uses

❖

func (c *CommentStats) GetTotalIssueComments() int

GetTotalIssueComments returns the TotalIssueComments field if it's non-nil, zero value otherwise.

func (*CommentStats) GetTotalPullRequestComments ¶ Uses

❖

func (c *CommentStats) GetTotalPullRequestComments() int

GetTotalPullRequestComments returns the TotalPullRequestComments field if it's non-nil, zero value otherwise.

func (CommentStats) String ¶ Uses

❖

func (s CommentStats) String() string

type Commit ¶ Uses

❖

type Commit struct {
    SHA          *string                `json:"sha,omitempty"`
    Author       *CommitAuthor          `json:"author,omitempty"`
    Committer    *CommitAuthor          `json:"committer,omitempty"`
    Message      *string                `json:"message,omitempty"`
    Tree         *Tree                  `json:"tree,omitempty"`
    Parents      []Commit               `json:"parents,omitempty"`
    Stats        *CommitStats           `json:"stats,omitempty"`
    HTMLURL      *string                `json:"html_url,omitempty"`
    URL          *string                `json:"url,omitempty"`
    Verification *SignatureVerification `json:"verification,omitempty"`
    NodeID       *string                `json:"node_id,omitempty"`

    // CommentCount is the number of GitHub comments on the commit. This
    // is only populated for requests that fetch GitHub data like
    // Pulls.ListCommits, Repositories.ListCommits, etc.
    CommentCount *int `json:"comment_count,omitempty"`
}

Commit represents a GitHub commit.

func (*Commit) GetAuthor ¶ Uses

❖

func (c *Commit) GetAuthor() *CommitAuthor

GetAuthor returns the Author field.

func (*Commit) GetCommentCount ¶ Uses

❖

func (c *Commit) GetCommentCount() int

GetCommentCount returns the CommentCount field if it's non-nil, zero value otherwise.

func (*Commit) GetCommitter ¶ Uses

❖

func (c *Commit) GetCommitter() *CommitAuthor

GetCommitter returns the Committer field.

func (*Commit) GetHTMLURL ¶ Uses

❖

func (c *Commit) GetHTMLURL() string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*Commit) GetMessage ¶ Uses

❖

func (c *Commit) GetMessage() string

GetMessage returns the Message field if it's non-nil, zero value otherwise.

func (*Commit) GetNodeID ¶ Uses

❖

func (c *Commit) GetNodeID() string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*Commit) GetSHA ¶ Uses

❖

func (c *Commit) GetSHA() string

GetSHA returns the SHA field if it's non-nil, zero value otherwise.

func (*Commit) GetStats ¶ Uses

❖

func (c *Commit) GetStats() *CommitStats

GetStats returns the Stats field.

func (*Commit) GetTree ¶ Uses

❖

func (c *Commit) GetTree() *Tree

GetTree returns the Tree field.

func (*Commit) GetURL ¶ Uses

❖

func (c *Commit) GetURL() string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*Commit) GetVerification ¶ Uses

❖

func (c *Commit) GetVerification() *SignatureVerification

GetVerification returns the Verification field.

func (Commit) String ¶ Uses

❖

func (c Commit) String() string

type CommitAuthor ¶ Uses

❖

type CommitAuthor struct {
    Date  *time.Time `json:"date,omitempty"`
    Name  *string    `json:"name,omitempty"`
    Email *string    `json:"email,omitempty"`

    // The following fields are only populated by Webhook events.
    Login *string `json:"username,omitempty"` // Renamed for go-github consistency.
}

CommitAuthor represents the author or committer of a commit. The commit author may not correspond to a GitHub User.

func (*CommitAuthor) GetDate ¶ Uses

❖

func (c *CommitAuthor) GetDate() time.Time

GetDate returns the Date field if it's non-nil, zero value otherwise.

func (*CommitAuthor) GetEmail ¶ Uses

❖

func (c *CommitAuthor) GetEmail() string

GetEmail returns the Email field if it's non-nil, zero value otherwise.

func (*CommitAuthor) GetLogin ¶ Uses

❖

func (c *CommitAuthor) GetLogin() string

GetLogin returns the Login field if it's non-nil, zero value otherwise.

func (*CommitAuthor) GetName ¶ Uses

❖

func (c *CommitAuthor) GetName() string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (CommitAuthor) String ¶ Uses

❖

func (c CommitAuthor) String() string

type CommitCommentEvent ¶ Uses

❖

type CommitCommentEvent struct {
    Comment *RepositoryComment `json:"comment,omitempty"`

    // The following fields are only populated by Webhook events.
    Action       *string       `json:"action,omitempty"`
    Repo         *Repository   `json:"repository,omitempty"`
    Sender       *User         `json:"sender,omitempty"`
    Installation *Installation `json:"installation,omitempty"`
}

CommitCommentEvent is triggered when a commit comment is created. The Webhook event name is "commit_comment".

GitHub API docs: https://developer.github.com/v3/activity/events/types/#commitcommentevent

func (*CommitCommentEvent) GetAction ¶ Uses

❖

func (c *CommitCommentEvent) GetAction() string

GetAction returns the Action field if it's non-nil, zero value otherwise.

func (*CommitCommentEvent) GetComment ¶ Uses

❖

func (c *CommitCommentEvent) GetComment() *RepositoryComment

GetComment returns the Comment field.

func (*CommitCommentEvent) GetInstallation ¶ Uses

❖

func (c *CommitCommentEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*CommitCommentEvent) GetRepo ¶ Uses

❖

func (c *CommitCommentEvent) GetRepo() *Repository

GetRepo returns the Repo field.

func (*CommitCommentEvent) GetSender ¶ Uses

❖

func (c *CommitCommentEvent) GetSender() *User

GetSender returns the Sender field.

type CommitFile ¶ Uses

❖

type CommitFile struct {
    SHA              *string `json:"sha,omitempty"`
    Filename         *string `json:"filename,omitempty"`
    Additions        *int    `json:"additions,omitempty"`
    Deletions        *int    `json:"deletions,omitempty"`
    Changes          *int    `json:"changes,omitempty"`
    Status           *string `json:"status,omitempty"`
    Patch            *string `json:"patch,omitempty"`
    BlobURL          *string `json:"blob_url,omitempty"`
    RawURL           *string `json:"raw_url,omitempty"`
    ContentsURL      *string `json:"contents_url,omitempty"`
    PreviousFilename *string `json:"previous_filename,omitempty"`
}

CommitFile represents a file modified in a commit.

func (*CommitFile) GetAdditions ¶ Uses

❖

func (c *CommitFile) GetAdditions() int

GetAdditions returns the Additions field if it's non-nil, zero value otherwise.

func (*CommitFile) GetBlobURL ¶ Uses

❖

func (c *CommitFile) GetBlobURL() string

GetBlobURL returns the BlobURL field if it's non-nil, zero value otherwise.

func (*CommitFile) GetChanges ¶ Uses

❖

func (c *CommitFile) GetChanges() int

GetChanges returns the Changes field if it's non-nil, zero value otherwise.

func (*CommitFile) GetContentsURL ¶ Uses

❖

func (c *CommitFile) GetContentsURL() string

GetContentsURL returns the ContentsURL field if it's non-nil, zero value otherwise.

func (*CommitFile) GetDeletions ¶ Uses

❖

func (c *CommitFile) GetDeletions() int

GetDeletions returns the Deletions field if it's non-nil, zero value otherwise.

func (*CommitFile) GetFilename ¶ Uses

❖

func (c *CommitFile) GetFilename() string

GetFilename returns the Filename field if it's non-nil, zero value otherwise.

func (*CommitFile) GetPatch ¶ Uses

❖

func (c *CommitFile) GetPatch() string

GetPatch returns the Patch field if it's non-nil, zero value otherwise.

func (*CommitFile) GetPreviousFilename ¶ Uses

❖

func (c *CommitFile) GetPreviousFilename() string

GetPreviousFilename returns the PreviousFilename field if it's non-nil, zero value otherwise.

func (*CommitFile) GetRawURL ¶ Uses

❖

func (c *CommitFile) GetRawURL() string

GetRawURL returns the RawURL field if it's non-nil, zero value otherwise.

func (*CommitFile) GetSHA ¶ Uses

❖

func (c *CommitFile) GetSHA() string

GetSHA returns the SHA field if it's non-nil, zero value otherwise.

func (*CommitFile) GetStatus ¶ Uses

❖

func (c *CommitFile) GetStatus() string

GetStatus returns the Status field if it's non-nil, zero value otherwise.

func (CommitFile) String ¶ Uses

❖

func (c CommitFile) String() string

type CommitResult ¶ Uses

❖

type CommitResult struct {
    SHA         *string   `json:"sha,omitempty"`
    Commit      *Commit   `json:"commit,omitempty"`
    Author      *User     `json:"author,omitempty"`
    Committer   *User     `json:"committer,omitempty"`
    Parents     []*Commit `json:"parents,omitempty"`
    HTMLURL     *string   `json:"html_url,omitempty"`
    URL         *string   `json:"url,omitempty"`
    CommentsURL *string   `json:"comments_url,omitempty"`

    Repository *Repository `json:"repository,omitempty"`
    Score      *float64    `json:"score,omitempty"`
}

CommitResult represents a commit object as returned in commit search endpoint response.

func (*CommitResult) GetAuthor ¶ Uses

❖

func (c *CommitResult) GetAuthor() *User

GetAuthor returns the Author field.

func (*CommitResult) GetCommentsURL ¶ Uses

❖

func (c *CommitResult) GetCommentsURL() string

GetCommentsURL returns the CommentsURL field if it's non-nil, zero value otherwise.

func (*CommitResult) GetCommit ¶ Uses

❖

func (c *CommitResult) GetCommit() *Commit

GetCommit returns the Commit field.

func (*CommitResult) GetCommitter ¶ Uses

❖

func (c *CommitResult) GetCommitter() *User

GetCommitter returns the Committer field.

func (*CommitResult) GetHTMLURL ¶ Uses

❖

func (c *CommitResult) GetHTMLURL() string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*CommitResult) GetRepository ¶ Uses

❖

func (c *CommitResult) GetRepository() *Repository

GetRepository returns the Repository field.

func (*CommitResult) GetSHA ¶ Uses

❖

func (c *CommitResult) GetSHA() string

GetSHA returns the SHA field if it's non-nil, zero value otherwise.

func (*CommitResult) GetScore ¶ Uses

❖

func (c *CommitResult) GetScore() *float64

GetScore returns the Score field.

func (*CommitResult) GetURL ¶ Uses

❖

func (c *CommitResult) GetURL() string

GetURL returns the URL field if it's non-nil, zero value otherwise.

type CommitStats ¶ Uses

❖

type CommitStats struct {
    Additions *int `json:"additions,omitempty"`
    Deletions *int `json:"deletions,omitempty"`
    Total     *int `json:"total,omitempty"`
}

CommitStats represents the number of additions / deletions from a file in a given RepositoryCommit or GistCommit.

func (*CommitStats) GetAdditions ¶ Uses

❖

func (c *CommitStats) GetAdditions() int

GetAdditions returns the Additions field if it's non-nil, zero value otherwise.

func (*CommitStats) GetDeletions ¶ Uses

❖

func (c *CommitStats) GetDeletions() int

GetDeletions returns the Deletions field if it's non-nil, zero value otherwise.

func (*CommitStats) GetTotal ¶ Uses

❖

func (c *CommitStats) GetTotal() int

GetTotal returns the Total field if it's non-nil, zero value otherwise.

func (CommitStats) String ¶ Uses

❖

func (c CommitStats) String() string

type CommitsComparison ¶ Uses

❖

type CommitsComparison struct {
    BaseCommit      *RepositoryCommit `json:"base_commit,omitempty"`
    MergeBaseCommit *RepositoryCommit `json:"merge_base_commit,omitempty"`

    // Head can be 'behind' or 'ahead'
    Status       *string `json:"status,omitempty"`
    AheadBy      *int    `json:"ahead_by,omitempty"`
    BehindBy     *int    `json:"behind_by,omitempty"`
    TotalCommits *int    `json:"total_commits,omitempty"`

    Commits []RepositoryCommit `json:"commits,omitempty"`

    Files []CommitFile `json:"files,omitempty"`

    HTMLURL      *string `json:"html_url,omitempty"`
    PermalinkURL *string `json:"permalink_url,omitempty"`
    DiffURL      *string `json:"diff_url,omitempty"`
    PatchURL     *string `json:"patch_url,omitempty"`
    URL          *string `json:"url,omitempty"` // API URL.
}

CommitsComparison is the result of comparing two commits. See CompareCommits() for details.

func (*CommitsComparison) GetAheadBy ¶ Uses

❖

func (c *CommitsComparison) GetAheadBy() int

GetAheadBy returns the AheadBy field if it's non-nil, zero value otherwise.

func (*CommitsComparison) GetBaseCommit ¶ Uses

❖

func (c *CommitsComparison) GetBaseCommit() *RepositoryCommit

GetBaseCommit returns the BaseCommit field.

func (*CommitsComparison) GetBehindBy ¶ Uses

❖

func (c *CommitsComparison) GetBehindBy() int

GetBehindBy returns the BehindBy field if it's non-nil, zero value otherwise.

func (*CommitsComparison) GetDiffURL ¶ Uses

❖

func (c *CommitsComparison) GetDiffURL() string

GetDiffURL returns the DiffURL field if it's non-nil, zero value otherwise.

func (*CommitsComparison) GetHTMLURL ¶ Uses

❖

func (c *CommitsComparison) GetHTMLURL() string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*CommitsComparison) GetMergeBaseCommit ¶ Uses

❖

func (c *CommitsComparison) GetMergeBaseCommit() *RepositoryCommit

GetMergeBaseCommit returns the MergeBaseCommit field.

func (*CommitsComparison) GetPatchURL ¶ Uses

❖

func (c *CommitsComparison) GetPatchURL() string

GetPatchURL returns the PatchURL field if it's non-nil, zero value otherwise.

func (*CommitsComparison) GetPermalinkURL ¶ Uses

❖

func (c *CommitsComparison) GetPermalinkURL() string

GetPermalinkURL returns the PermalinkURL field if it's non-nil, zero value otherwise.

func (*CommitsComparison) GetStatus ¶ Uses

❖

func (c *CommitsComparison) GetStatus() string

GetStatus returns the Status field if it's non-nil, zero value otherwise.

func (*CommitsComparison) GetTotalCommits ¶ Uses

❖

func (c *CommitsComparison) GetTotalCommits() int

GetTotalCommits returns the TotalCommits field if it's non-nil, zero value otherwise.

func (*CommitsComparison) GetURL ¶ Uses

❖

func (c *CommitsComparison) GetURL() string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (CommitsComparison) String ¶ Uses

❖

func (c CommitsComparison) String() string

type CommitsListOptions ¶ Uses

❖

type CommitsListOptions struct {
    // SHA or branch to start listing Commits from.
    SHA string `url:"sha,omitempty"`

    // Path that should be touched by the returned Commits.
    Path string `url:"path,omitempty"`

    // Author of by which to filter Commits.
    Author string `url:"author,omitempty"`

    // Since when should Commits be included in the response.
    Since time.Time `url:"since,omitempty"`

    // Until when should Commits be included in the response.
    Until time.Time `url:"until,omitempty"`

    ListOptions
}

CommitsListOptions specifies the optional parameters to the RepositoriesService.ListCommits method.

type CommitsSearchResult ¶ Uses

❖

type CommitsSearchResult struct {
    Total             *int            `json:"total_count,omitempty"`
    IncompleteResults *bool           `json:"incomplete_results,omitempty"`
    Commits           []*CommitResult `json:"items,omitempty"`
}

CommitsSearchResult represents the result of a commits search.

func (*CommitsSearchResult) GetIncompleteResults ¶ Uses

❖

func (c *CommitsSearchResult) GetIncompleteResults() bool

GetIncompleteResults returns the IncompleteResults field if it's non-nil, zero value otherwise.

func (*CommitsSearchResult) GetTotal ¶ Uses

❖

func (c *CommitsSearchResult) GetTotal() int

GetTotal returns the Total field if it's non-nil, zero value otherwise.

type CommunityHealthFiles ¶ Uses

❖

type CommunityHealthFiles struct {
    CodeOfConduct       *Metric `json:"code_of_conduct"`
    Contributing        *Metric `json:"contributing"`
    IssueTemplate       *Metric `json:"issue_template"`
    PullRequestTemplate *Metric `json:"pull_request_template"`
    License             *Metric `json:"license"`
    Readme              *Metric `json:"readme"`
}

CommunityHealthFiles represents the different files in the community health metrics response.

func (*CommunityHealthFiles) GetCodeOfConduct ¶ Uses

❖

func (c *CommunityHealthFiles) GetCodeOfConduct() *Metric

GetCodeOfConduct returns the CodeOfConduct field.

func (*CommunityHealthFiles) GetContributing ¶ Uses

❖

func (c *CommunityHealthFiles) GetContributing() *Metric

GetContributing returns the Contributing field.

func (*CommunityHealthFiles) GetIssueTemplate ¶ Uses

❖

func (c *CommunityHealthFiles) GetIssueTemplate() *Metric

GetIssueTemplate returns the IssueTemplate field.

func (*CommunityHealthFiles) GetLicense ¶ Uses

❖

func (c *CommunityHealthFiles) GetLicense() *Metric

GetLicense returns the License field.

func (*CommunityHealthFiles) GetPullRequestTemplate ¶ Uses

❖

func (c *CommunityHealthFiles) GetPullRequestTemplate() *Metric

GetPullRequestTemplate returns the PullRequestTemplate field.

func (*CommunityHealthFiles) GetReadme ¶ Uses

❖

func (c *CommunityHealthFiles) GetReadme() *Metric

GetReadme returns the Readme field.

type CommunityHealthMetrics ¶ Uses

❖

type CommunityHealthMetrics struct {
    HealthPercentage *int                  `json:"health_percentage"`
    Files            *CommunityHealthFiles `json:"files"`
    UpdatedAt        *time.Time            `json:"updated_at"`
}

CommunityHealthMetrics represents a response containing the community metrics of a repository.

func (*CommunityHealthMetrics) GetFiles ¶ Uses

❖

func (c *CommunityHealthMetrics) GetFiles() *CommunityHealthFiles

GetFiles returns the Files field.

func (*CommunityHealthMetrics) GetHealthPercentage ¶ Uses

❖

func (c *CommunityHealthMetrics) GetHealthPercentage() int

GetHealthPercentage returns the HealthPercentage field if it's non-nil, zero value otherwise.

func (*CommunityHealthMetrics) GetUpdatedAt ¶ Uses

❖

func (c *CommunityHealthMetrics) GetUpdatedAt() time.Time

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

type Contributor ¶ Uses

❖

type Contributor struct {
    Login             *string `json:"login,omitempty"`
    ID                *int64  `json:"id,omitempty"`
    AvatarURL         *string `json:"avatar_url,omitempty"`
    GravatarID        *string `json:"gravatar_id,omitempty"`
    URL               *string `json:"url,omitempty"`
    HTMLURL           *string `json:"html_url,omitempty"`
    FollowersURL      *string `json:"followers_url,omitempty"`
    FollowingURL      *string `json:"following_url,omitempty"`
    GistsURL          *string `json:"gists_url,omitempty"`
    StarredURL        *string `json:"starred_url,omitempty"`
    SubscriptionsURL  *string `json:"subscriptions_url,omitempty"`
    OrganizationsURL  *string `json:"organizations_url,omitempty"`
    ReposURL          *string `json:"repos_url,omitempty"`
    EventsURL         *string `json:"events_url,omitempty"`
    ReceivedEventsURL *string `json:"received_events_url,omitempty"`
    Type              *string `json:"type,omitempty"`
    SiteAdmin         *bool   `json:"site_admin,omitempty"`
    Contributions     *int    `json:"contributions,omitempty"`
}

Contributor represents a repository contributor

func (*Contributor) GetAvatarURL ¶ Uses

❖

func (c *Contributor) GetAvatarURL() string

GetAvatarURL returns the AvatarURL field if it's non-nil, zero value otherwise.

func (*Contributor) GetContributions ¶ Uses

❖

func (c *Contributor) GetContributions() int

GetContributions returns the Contributions field if it's non-nil, zero value otherwise.

func (*Contributor) GetEventsURL ¶ Uses

❖

func (c *Contributor) GetEventsURL() string

GetEventsURL returns the EventsURL field if it's non-nil, zero value otherwise.

func (*Contributor) GetFollowersURL ¶ Uses

❖

func (c *Contributor) GetFollowersURL() string

GetFollowersURL returns the FollowersURL field if it's non-nil, zero value otherwise.

func (*Contributor) GetFollowingURL ¶ Uses

❖

func (c *Contributor) GetFollowingURL() string

GetFollowingURL returns the FollowingURL field if it's non-nil, zero value otherwise.

func (*Contributor) GetGistsURL ¶ Uses

❖

func (c *Contributor) GetGistsURL() string

GetGistsURL returns the GistsURL field if it's non-nil, zero value otherwise.

func (*Contributor) GetGravatarID ¶ Uses

❖

func (c *Contributor) GetGravatarID() string

GetGravatarID returns the GravatarID field if it's non-nil, zero value otherwise.

func (*Contributor) GetHTMLURL ¶ Uses

❖

func (c *Contributor) GetHTMLURL() string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*Contributor) GetID ¶ Uses

❖

func (c *Contributor) GetID() int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*Contributor) GetLogin ¶ Uses

❖

func (c *Contributor) GetLogin() string

GetLogin returns the Login field if it's non-nil, zero value otherwise.

func (*Contributor) GetOrganizationsURL ¶ Uses

❖

func (c *Contributor) GetOrganizationsURL() string

GetOrganizationsURL returns the OrganizationsURL field if it's non-nil, zero value otherwise.

func (*Contributor) GetReceivedEventsURL ¶ Uses

❖

func (c *Contributor) GetReceivedEventsURL() string

GetReceivedEventsURL returns the ReceivedEventsURL field if it's non-nil, zero value otherwise.

func (*Contributor) GetReposURL ¶ Uses

❖

func (c *Contributor) GetReposURL() string

GetReposURL returns the ReposURL field if it's non-nil, zero value otherwise.

func (*Contributor) GetSiteAdmin ¶ Uses

❖

func (c *Contributor) GetSiteAdmin() bool

GetSiteAdmin returns the SiteAdmin field if it's non-nil, zero value otherwise.

func (*Contributor) GetStarredURL ¶ Uses

❖

func (c *Contributor) GetStarredURL() string

GetStarredURL returns the StarredURL field if it's non-nil, zero value otherwise.

func (*Contributor) GetSubscriptionsURL ¶ Uses

❖

func (c *Contributor) GetSubscriptionsURL() string

GetSubscriptionsURL returns the SubscriptionsURL field if it's non-nil, zero value otherwise.

func (*Contributor) GetType ¶ Uses

❖

func (c *Contributor) GetType() string

GetType returns the Type field if it's non-nil, zero value otherwise.

func (*Contributor) GetURL ¶ Uses

❖

func (c *Contributor) GetURL() string

GetURL returns the URL field if it's non-nil, zero value otherwise.

type ContributorStats ¶ Uses

❖

type ContributorStats struct {
    Author *Contributor  `json:"author,omitempty"`
    Total  *int          `json:"total,omitempty"`
    Weeks  []WeeklyStats `json:"weeks,omitempty"`
}

ContributorStats represents a contributor to a repository and their weekly contributions to a given repo.

func (*ContributorStats) GetAuthor ¶ Uses

❖

func (c *ContributorStats) GetAuthor() *Contributor

GetAuthor returns the Author field.

func (*ContributorStats) GetTotal ¶ Uses

❖

func (c *ContributorStats) GetTotal() int

GetTotal returns the Total field if it's non-nil, zero value otherwise.

func (ContributorStats) String ¶ Uses

❖

func (c ContributorStats) String() string

type CreateCheckRunOptions ¶ Uses

❖

type CreateCheckRunOptions struct {
    Name        string            `json:"name"`                   // The name of the check (e.g., "code-coverage"). (Required.)
    HeadBranch  string            `json:"head_branch"`            // The name of the branch to perform a check against. (Required.)
    HeadSHA     string            `json:"head_sha"`               // The SHA of the commit. (Required.)
    DetailsURL  *string           `json:"details_url,omitempty"`  // The URL of the integrator's site that has the full details of the check. (Optional.)
    ExternalID  *string           `json:"external_id,omitempty"`  // A reference for the run on the integrator's system. (Optional.)
    Status      *string           `json:"status,omitempty"`       // The current status. Can be one of "queued", "in_progress", or "completed". Default: "queued". (Optional.)
    Conclusion  *string           `json:"conclusion,omitempty"`   // Can be one of "success", "failure", "neutral", "cancelled", "timed_out", or "action_required". (Optional. Required if you provide a status of "completed".)
    StartedAt   *Timestamp        `json:"started_at,omitempty"`   // The time that the check run began. (Optional.)
    CompletedAt *Timestamp        `json:"completed_at,omitempty"` // The time the check completed. (Optional. Required if you provide conclusion.)
    Output      *CheckRunOutput   `json:"output,omitempty"`       // Provide descriptive details about the run. (Optional)
    Actions     []*CheckRunAction `json:"actions,omitempty"`      // Possible further actions the integrator can perform, which a user may trigger. (Optional.)
}

CreateCheckRunOptions sets up parameters needed to create a CheckRun.

func (*CreateCheckRunOptions) GetCompletedAt ¶ Uses

❖

func (c *CreateCheckRunOptions) GetCompletedAt() Timestamp

GetCompletedAt returns the CompletedAt field if it's non-nil, zero value otherwise.

func (*CreateCheckRunOptions) GetConclusion ¶ Uses

❖

func (c *CreateCheckRunOptions) GetConclusion() string

GetConclusion returns the Conclusion field if it's non-nil, zero value otherwise.

func (*CreateCheckRunOptions) GetDetailsURL ¶ Uses

❖

func (c *CreateCheckRunOptions) GetDetailsURL() string

GetDetailsURL returns the DetailsURL field if it's non-nil, zero value otherwise.

func (*CreateCheckRunOptions) GetExternalID ¶ Uses

❖

func (c *CreateCheckRunOptions) GetExternalID() string

GetExternalID returns the ExternalID field if it's non-nil, zero value otherwise.

func (*CreateCheckRunOptions) GetOutput ¶ Uses

❖

func (c *CreateCheckRunOptions) GetOutput() *CheckRunOutput

GetOutput returns the Output field.

func (*CreateCheckRunOptions) GetStartedAt ¶ Uses

❖

func (c *CreateCheckRunOptions) GetStartedAt() Timestamp

GetStartedAt returns the StartedAt field if it's non-nil, zero value otherwise.

func (*CreateCheckRunOptions) GetStatus ¶ Uses

❖

func (c *CreateCheckRunOptions) GetStatus() string

GetStatus returns the Status field if it's non-nil, zero value otherwise.

type CreateCheckSuiteOptions ¶ Uses

❖

type CreateCheckSuiteOptions struct {
    HeadSHA    string  `json:"head_sha"`              // The sha of the head commit. (Required.)
    HeadBranch *string `json:"head_branch,omitempty"` // The name of the head branch where the code changes are implemented.
}

CreateCheckSuiteOptions sets up parameters to manually create a check suites

func (*CreateCheckSuiteOptions) GetHeadBranch ¶ Uses

❖

func (c *CreateCheckSuiteOptions) GetHeadBranch() string

GetHeadBranch returns the HeadBranch field if it's non-nil, zero value otherwise.

type CreateEvent ¶ Uses

❖

type CreateEvent struct {
    Ref *string `json:"ref,omitempty"`
    // RefType is the object that was created. Possible values are: "repository", "branch", "tag".
    RefType      *string `json:"ref_type,omitempty"`
    MasterBranch *string `json:"master_branch,omitempty"`
    Description  *string `json:"description,omitempty"`

    // The following fields are only populated by Webhook events.
    PusherType   *string       `json:"pusher_type,omitempty"`
    Repo         *Repository   `json:"repository,omitempty"`
    Sender       *User         `json:"sender,omitempty"`
    Installation *Installation `json:"installation,omitempty"`
}

CreateEvent represents a created repository, branch, or tag. The Webhook event name is "create".

Note: webhooks will not receive this event for created repositories. Additionally, webhooks will not receive this event for tags if more than three tags are pushed at once.

GitHub API docs: https://developer.github.com/v3/activity/events/types/#createevent

func (*CreateEvent) GetDescription ¶ Uses

❖

func (c *CreateEvent) GetDescription() string

GetDescription returns the Description field if it's non-nil, zero value otherwise.

func (*CreateEvent) GetInstallation ¶ Uses

❖

func (c *CreateEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*CreateEvent) GetMasterBranch ¶ Uses

❖

func (c *CreateEvent) GetMasterBranch() string

GetMasterBranch returns the MasterBranch field if it's non-nil, zero value otherwise.

func (*CreateEvent) GetPusherType ¶ Uses

❖

func (c *CreateEvent) GetPusherType() string

GetPusherType returns the PusherType field if it's non-nil, zero value otherwise.

func (*CreateEvent) GetRef ¶ Uses

❖

func (c *CreateEvent) GetRef() string

GetRef returns the Ref field if it's non-nil, zero value otherwise.

func (*CreateEvent) GetRefType ¶ Uses

❖

func (c *CreateEvent) GetRefType() string

GetRefType returns the RefType field if it's non-nil, zero value otherwise.

func (*CreateEvent) GetRepo ¶ Uses

❖

func (c *CreateEvent) GetRepo() *Repository

GetRepo returns the Repo field.

func (*CreateEvent) GetSender ¶ Uses

❖

func (c *CreateEvent) GetSender() *User

GetSender returns the Sender field.

type CreateOrgInvitationOptions ¶ Uses

❖

type CreateOrgInvitationOptions struct {
    // GitHub user ID for the person you are inviting. Not required if you provide Email.
    InviteeID *int64 `json:"invitee_id,omitempty"`
    // Email address of the person you are inviting, which can be an existing GitHub user.
    // Not required if you provide InviteeID
    Email *string `json:"email,omitempty"`
    // Specify role for new member. Can be one of:
    // * admin - Organization owners with full administrative rights to the
    // 	 organization and complete access to all repositories and teams.
    // * direct_member - Non-owner organization members with ability to see
    //   other members and join teams by invitation.
    // * billing_manager - Non-owner organization members with ability to
    //   manage the billing settings of your organization.
    // Default is "direct_member".
    Role   *string `json:"role"`
    TeamID []int64 `json:"team_ids"`
}

CreateOrgInvitationOptions specifies the parameters to the OrganizationService.Invite method.

func (*CreateOrgInvitationOptions) GetEmail ¶ Uses

❖

func (c *CreateOrgInvitationOptions) GetEmail() string

GetEmail returns the Email field if it's non-nil, zero value otherwise.

func (*CreateOrgInvitationOptions) GetInviteeID ¶ Uses

❖

func (c *CreateOrgInvitationOptions) GetInviteeID() int64

GetInviteeID returns the InviteeID field if it's non-nil, zero value otherwise.

func (*CreateOrgInvitationOptions) GetRole ¶ Uses

❖

func (c *CreateOrgInvitationOptions) GetRole() string

GetRole returns the Role field if it's non-nil, zero value otherwise.

type DeleteEvent ¶ Uses

❖

type DeleteEvent struct {
    Ref *string `json:"ref,omitempty"`
    // RefType is the object that was deleted. Possible values are: "branch", "tag".
    RefType *string `json:"ref_type,omitempty"`

    // The following fields are only populated by Webhook events.
    PusherType   *string       `json:"pusher_type,omitempty"`
    Repo         *Repository   `json:"repository,omitempty"`
    Sender       *User         `json:"sender,omitempty"`
    Installation *Installation `json:"installation,omitempty"`
}

DeleteEvent represents a deleted branch or tag. The Webhook event name is "delete".

Note: webhooks will not receive this event for tags if more than three tags are deleted at once.

GitHub API docs: https://developer.github.com/v3/activity/events/types/#deleteevent

func (*DeleteEvent) GetInstallation ¶ Uses

❖

func (d *DeleteEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*DeleteEvent) GetPusherType ¶ Uses

❖

func (d *DeleteEvent) GetPusherType() string

GetPusherType returns the PusherType field if it's non-nil, zero value otherwise.

func (*DeleteEvent) GetRef ¶ Uses

❖

func (d *DeleteEvent) GetRef() string

GetRef returns the Ref field if it's non-nil, zero value otherwise.

func (*DeleteEvent) GetRefType ¶ Uses

❖

func (d *DeleteEvent) GetRefType() string

GetRefType returns the RefType field if it's non-nil, zero value otherwise.

func (*DeleteEvent) GetRepo ¶ Uses

❖

func (d *DeleteEvent) GetRepo() *Repository

GetRepo returns the Repo field.

func (*DeleteEvent) GetSender ¶ Uses

❖

func (d *DeleteEvent) GetSender() *User

GetSender returns the Sender field.

type Deployment ¶ Uses

❖

type Deployment struct {
    URL           *string         `json:"url,omitempty"`
    ID            *int64          `json:"id,omitempty"`
    SHA           *string         `json:"sha,omitempty"`
    Ref           *string         `json:"ref,omitempty"`
    Task          *string         `json:"task,omitempty"`
    Payload       json.RawMessage `json:"payload,omitempty"`
    Environment   *string         `json:"environment,omitempty"`
    Description   *string         `json:"description,omitempty"`
    Creator       *User           `json:"creator,omitempty"`
    CreatedAt     *Timestamp      `json:"created_at,omitempty"`
    UpdatedAt     *Timestamp      `json:"updated_at,omitempty"`
    StatusesURL   *string         `json:"statuses_url,omitempty"`
    RepositoryURL *string         `json:"repository_url,omitempty"`
    NodeID        *string         `json:"node_id,omitempty"`
}

Deployment represents a deployment in a repo

func (*Deployment) GetCreatedAt ¶ Uses

❖

func (d *Deployment) GetCreatedAt() Timestamp

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*Deployment) GetCreator ¶ Uses

❖

func (d *Deployment) GetCreator() *User

GetCreator returns the Creator field.

func (*Deployment) GetDescription ¶ Uses

❖

func (d *Deployment) GetDescription() string

GetDescription returns the Description field if it's non-nil, zero value otherwise.

func (*Deployment) GetEnvironment ¶ Uses

❖

func (d *Deployment) GetEnvironment() string

GetEnvironment returns the Environment field if it's non-nil, zero value otherwise.

func (*Deployment) GetID ¶ Uses

❖

func (d *Deployment) GetID() int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*Deployment) GetNodeID ¶ Uses

❖

func (d *Deployment) GetNodeID() string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*Deployment) GetRef ¶ Uses

❖

func (d *Deployment) GetRef() string

GetRef returns the Ref field if it's non-nil, zero value otherwise.

func (*Deployment) GetRepositoryURL ¶ Uses

❖

func (d *Deployment) GetRepositoryURL() string

GetRepositoryURL returns the RepositoryURL field if it's non-nil, zero value otherwise.

func (*Deployment) GetSHA ¶ Uses

❖

func (d *Deployment) GetSHA() string

GetSHA returns the SHA field if it's non-nil, zero value otherwise.

func (*Deployment) GetStatusesURL ¶ Uses

❖

func (d *Deployment) GetStatusesURL() string

GetStatusesURL returns the StatusesURL field if it's non-nil, zero value otherwise.

func (*Deployment) GetTask ¶ Uses

❖

func (d *Deployment) GetTask() string

GetTask returns the Task field if it's non-nil, zero value otherwise.

func (*Deployment) GetURL ¶ Uses

❖

func (d *Deployment) GetURL() string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*Deployment) GetUpdatedAt ¶ Uses

❖

func (d *Deployment) GetUpdatedAt() Timestamp

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

type DeploymentEvent ¶ Uses

❖

type DeploymentEvent struct {
    Deployment *Deployment `json:"deployment,omitempty"`
    Repo       *Repository `json:"repository,omitempty"`

    // The following fields are only populated by Webhook events.
    Sender       *User         `json:"sender,omitempty"`
    Installation *Installation `json:"installation,omitempty"`
}

DeploymentEvent represents a deployment. The Webhook event name is "deployment".

Events of this type are not visible in timelines, they are only used to trigger hooks.

GitHub API docs: https://developer.github.com/v3/activity/events/types/#deploymentevent

func (*DeploymentEvent) GetDeployment ¶ Uses

❖

func (d *DeploymentEvent) GetDeployment() *Deployment

GetDeployment returns the Deployment field.

func (*DeploymentEvent) GetInstallation ¶ Uses

❖

func (d *DeploymentEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*DeploymentEvent) GetRepo ¶ Uses

❖

func (d *DeploymentEvent) GetRepo() *Repository

GetRepo returns the Repo field.

func (*DeploymentEvent) GetSender ¶ Uses

❖

func (d *DeploymentEvent) GetSender() *User

GetSender returns the Sender field.

type DeploymentRequest ¶ Uses

❖

type DeploymentRequest struct {
    Ref                   *string   `json:"ref,omitempty"`
    Task                  *string   `json:"task,omitempty"`
    AutoMerge             *bool     `json:"auto_merge,omitempty"`
    RequiredContexts      *[]string `json:"required_contexts,omitempty"`
    Payload               *string   `json:"payload,omitempty"`
    Environment           *string   `json:"environment,omitempty"`
    Description           *string   `json:"description,omitempty"`
    TransientEnvironment  *bool     `json:"transient_environment,omitempty"`
    ProductionEnvironment *bool     `json:"production_environment,omitempty"`
}

DeploymentRequest represents a deployment request

func (*DeploymentRequest) GetAutoMerge ¶ Uses

❖

func (d *DeploymentRequest) GetAutoMerge() bool

GetAutoMerge returns the AutoMerge field if it's non-nil, zero value otherwise.

func (*DeploymentRequest) GetDescription ¶ Uses

❖

func (d *DeploymentRequest) GetDescription() string

GetDescription returns the Description field if it's non-nil, zero value otherwise.

func (*DeploymentRequest) GetEnvironment ¶ Uses

❖

func (d *DeploymentRequest) GetEnvironment() string

GetEnvironment returns the Environment field if it's non-nil, zero value otherwise.

func (*DeploymentRequest) GetPayload ¶ Uses

❖

func (d *DeploymentRequest) GetPayload() string

GetPayload returns the Payload field if it's non-nil, zero value otherwise.

func (*DeploymentRequest) GetProductionEnvironment ¶ Uses

❖

func (d *DeploymentRequest) GetProductionEnvironment() bool

GetProductionEnvironment returns the ProductionEnvironment field if it's non-nil, zero value otherwise.

func (*DeploymentRequest) GetRef ¶ Uses

❖

func (d *DeploymentRequest) GetRef() string

GetRef returns the Ref field if it's non-nil, zero value otherwise.

func (*DeploymentRequest) GetRequiredContexts ¶ Uses

❖

func (d *DeploymentRequest) GetRequiredContexts() []string

GetRequiredContexts returns the RequiredContexts field if it's non-nil, zero value otherwise.

func (*DeploymentRequest) GetTask ¶ Uses

❖

func (d *DeploymentRequest) GetTask() string

GetTask returns the Task field if it's non-nil, zero value otherwise.

func (*DeploymentRequest) GetTransientEnvironment ¶ Uses

❖

func (d *DeploymentRequest) GetTransientEnvironment() bool

GetTransientEnvironment returns the TransientEnvironment field if it's non-nil, zero value otherwise.

type DeploymentStatus ¶ Uses

❖

type DeploymentStatus struct {
    ID  *int64 `json:"id,omitempty"`
    // State is the deployment state.
    // Possible values are: "pending", "success", "failure", "error", "inactive".
    State         *string    `json:"state,omitempty"`
    Creator       *User      `json:"creator,omitempty"`
    Description   *string    `json:"description,omitempty"`
    TargetURL     *string    `json:"target_url,omitempty"`
    CreatedAt     *Timestamp `json:"created_at,omitempty"`
    UpdatedAt     *Timestamp `json:"updated_at,omitempty"`
    DeploymentURL *string    `json:"deployment_url,omitempty"`
    RepositoryURL *string    `json:"repository_url,omitempty"`
    NodeID        *string    `json:"node_id,omitempty"`
}

DeploymentStatus represents the status of a particular deployment.

func (*DeploymentStatus) GetCreatedAt ¶ Uses

❖

func (d *DeploymentStatus) GetCreatedAt() Timestamp

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*DeploymentStatus) GetCreator ¶ Uses

❖

func (d *DeploymentStatus) GetCreator() *User

GetCreator returns the Creator field.

func (*DeploymentStatus) GetDeploymentURL ¶ Uses

❖

func (d *DeploymentStatus) GetDeploymentURL() string

GetDeploymentURL returns the DeploymentURL field if it's non-nil, zero value otherwise.

func (*DeploymentStatus) GetDescription ¶ Uses

❖

func (d *DeploymentStatus) GetDescription() string

GetDescription returns the Description field if it's non-nil, zero value otherwise.

func (*DeploymentStatus) GetID ¶ Uses

❖

func (d *DeploymentStatus) GetID() int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*DeploymentStatus) GetNodeID ¶ Uses

❖

func (d *DeploymentStatus) GetNodeID() string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*DeploymentStatus) GetRepositoryURL ¶ Uses

❖

func (d *DeploymentStatus) GetRepositoryURL() string

GetRepositoryURL returns the RepositoryURL field if it's non-nil, zero value otherwise.

func (*DeploymentStatus) GetState ¶ Uses

❖

func (d *DeploymentStatus) GetState() string

GetState returns the State field if it's non-nil, zero value otherwise.

func (*DeploymentStatus) GetTargetURL ¶ Uses

❖

func (d *DeploymentStatus) GetTargetURL() string

GetTargetURL returns the TargetURL field if it's non-nil, zero value otherwise.

func (*DeploymentStatus) GetUpdatedAt ¶ Uses

❖

func (d *DeploymentStatus) GetUpdatedAt() Timestamp

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

type DeploymentStatusEvent ¶ Uses

❖

type DeploymentStatusEvent struct {
    Deployment       *Deployment       `json:"deployment,omitempty"`
    DeploymentStatus *DeploymentStatus `json:"deployment_status,omitempty"`
    Repo             *Repository       `json:"repository,omitempty"`

    // The following fields are only populated by Webhook events.
    Sender       *User         `json:"sender,omitempty"`
    Installation *Installation `json:"installation,omitempty"`
}

DeploymentStatusEvent represents a deployment status. The Webhook event name is "deployment_status".

Events of this type are not visible in timelines, they are only used to trigger hooks.

GitHub API docs: https://developer.github.com/v3/activity/events/types/#deploymentstatusevent

func (*DeploymentStatusEvent) GetDeployment ¶ Uses

❖

func (d *DeploymentStatusEvent) GetDeployment() *Deployment

GetDeployment returns the Deployment field.

func (*DeploymentStatusEvent) GetDeploymentStatus ¶ Uses

❖

func (d *DeploymentStatusEvent) GetDeploymentStatus() *DeploymentStatus

GetDeploymentStatus returns the DeploymentStatus field.

func (*DeploymentStatusEvent) GetInstallation ¶ Uses

❖

func (d *DeploymentStatusEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*DeploymentStatusEvent) GetRepo ¶ Uses

❖

func (d *DeploymentStatusEvent) GetRepo() *Repository

GetRepo returns the Repo field.

func (*DeploymentStatusEvent) GetSender ¶ Uses

❖

func (d *DeploymentStatusEvent) GetSender() *User

GetSender returns the Sender field.

type DeploymentStatusRequest ¶ Uses

❖

type DeploymentStatusRequest struct {
    State          *string `json:"state,omitempty"`
    LogURL         *string `json:"log_url,omitempty"`
    Description    *string `json:"description,omitempty"`
    Environment    *string `json:"environment,omitempty"`
    EnvironmentURL *string `json:"environment_url,omitempty"`
    AutoInactive   *bool   `json:"auto_inactive,omitempty"`
}

DeploymentStatusRequest represents a deployment request

func (*DeploymentStatusRequest) GetAutoInactive ¶ Uses

❖

func (d *DeploymentStatusRequest) GetAutoInactive() bool

GetAutoInactive returns the AutoInactive field if it's non-nil, zero value otherwise.

func (*DeploymentStatusRequest) GetDescription ¶ Uses

❖

func (d *DeploymentStatusRequest) GetDescription() string

GetDescription returns the Description field if it's non-nil, zero value otherwise.

func (*DeploymentStatusRequest) GetEnvironment ¶ Uses

❖

func (d *DeploymentStatusRequest) GetEnvironment() string

GetEnvironment returns the Environment field if it's non-nil, zero value otherwise.

func (*DeploymentStatusRequest) GetEnvironmentURL ¶ Uses

❖

func (d *DeploymentStatusRequest) GetEnvironmentURL() string

GetEnvironmentURL returns the EnvironmentURL field if it's non-nil, zero value otherwise.

func (*DeploymentStatusRequest) GetLogURL ¶ Uses

❖

func (d *DeploymentStatusRequest) GetLogURL() string

GetLogURL returns the LogURL field if it's non-nil, zero value otherwise.

func (*DeploymentStatusRequest) GetState ¶ Uses

❖

func (d *DeploymentStatusRequest) GetState() string

GetState returns the State field if it's non-nil, zero value otherwise.

type DeploymentsListOptions ¶ Uses

❖

type DeploymentsListOptions struct {
    // SHA of the Deployment.
    SHA string `url:"sha,omitempty"`

    // List deployments for a given ref.
    Ref string `url:"ref,omitempty"`

    // List deployments for a given task.
    Task string `url:"task,omitempty"`

    // List deployments for a given environment.
    Environment string `url:"environment,omitempty"`

    ListOptions
}

DeploymentsListOptions specifies the optional parameters to the RepositoriesService.ListDeployments method.

type DiscussionComment ¶ Uses

❖

type DiscussionComment struct {
    Author        *User      `json:"author,omitempty"`
    Body          *string    `json:"body,omitempty"`
    BodyHTML      *string    `json:"body_html,omitempty"`
    BodyVersion   *string    `json:"body_version,omitempty"`
    CreatedAt     *Timestamp `json:"created_at,omitempty"`
    LastEditedAt  *Timestamp `json:"last_edited_at,omitempty"`
    DiscussionURL *string    `json:"discussion_url,omitempty"`
    HTMLURL       *string    `json:"html_url,omitempty"`
    NodeID        *string    `json:"node_id,omitempty"`
    Number        *int       `json:"number,omitempty"`
    UpdatedAt     *Timestamp `json:"updated_at,omitempty"`
    URL           *string    `json:"url,omitempty"`
    Reactions     *Reactions `json:"reactions,omitempty"`
}

DiscussionComment represents a GitHub dicussion in a team.

func (*DiscussionComment) GetAuthor ¶ Uses

❖

func (d *DiscussionComment) GetAuthor() *User

GetAuthor returns the Author field.

func (*DiscussionComment) GetBody ¶ Uses

❖

func (d *DiscussionComment) GetBody() string

GetBody returns the Body field if it's non-nil, zero value otherwise.

func (*DiscussionComment) GetBodyHTML ¶ Uses

❖

func (d *DiscussionComment) GetBodyHTML() string

GetBodyHTML returns the BodyHTML field if it's non-nil, zero value otherwise.

func (*DiscussionComment) GetBodyVersion ¶ Uses

❖

func (d *DiscussionComment) GetBodyVersion() string

GetBodyVersion returns the BodyVersion field if it's non-nil, zero value otherwise.

func (*DiscussionComment) GetCreatedAt ¶ Uses

❖

func (d *DiscussionComment) GetCreatedAt() Timestamp

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*DiscussionComment) GetDiscussionURL ¶ Uses

❖

func (d *DiscussionComment) GetDiscussionURL() string

GetDiscussionURL returns the DiscussionURL field if it's non-nil, zero value otherwise.

func (*DiscussionComment) GetHTMLURL ¶ Uses

❖

func (d *DiscussionComment) GetHTMLURL() string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*DiscussionComment) GetLastEditedAt ¶ Uses

❖

func (d *DiscussionComment) GetLastEditedAt() Timestamp

GetLastEditedAt returns the LastEditedAt field if it's non-nil, zero value otherwise.

func (*DiscussionComment) GetNodeID ¶ Uses

❖

func (d *DiscussionComment) GetNodeID() string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*DiscussionComment) GetNumber ¶ Uses

❖

func (d *DiscussionComment) GetNumber() int

GetNumber returns the Number field if it's non-nil, zero value otherwise.

func (*DiscussionComment) GetReactions ¶ Uses

❖

func (d *DiscussionComment) GetReactions() *Reactions

GetReactions returns the Reactions field.

func (*DiscussionComment) GetURL ¶ Uses

❖

func (d *DiscussionComment) GetURL() string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*DiscussionComment) GetUpdatedAt ¶ Uses

❖

func (d *DiscussionComment) GetUpdatedAt() Timestamp

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

func (DiscussionComment) String ¶ Uses

❖

func (c DiscussionComment) String() string

type DiscussionCommentListOptions ¶ Uses

❖

type DiscussionCommentListOptions struct {
    // Sorts the discussion comments by the date they were created.
    // Accepted values are asc and desc. Default is desc.
    Direction string `url:"direction,omitempty"`
}

DiscussionCommentListOptions specifies optional parameters to the TeamServices.ListComments method.

type DiscussionListOptions ¶ Uses

❖

type DiscussionListOptions struct {
    // Sorts the discussion by the date they were created.
    // Accepted values are asc and desc. Default is desc.
    Direction string `url:"direction,omitempty"`
}

DiscussionListOptions specifies optional parameters to the TeamServices.ListDiscussions method.

type DismissalRestrictions ¶ Uses

❖

type DismissalRestrictions struct {
    // The list of users who can dimiss pull request reviews.
    Users []*User `json:"users"`
    // The list of teams which can dismiss pull request reviews.
    Teams []*Team `json:"teams"`
}

DismissalRestrictions specifies which users and teams can dismiss pull request reviews.

type DismissalRestrictionsRequest ¶ Uses

❖

type DismissalRestrictionsRequest struct {
    // The list of user logins who can dismiss pull request reviews. (Required; use nil to disable dismissal_restrictions or &[]string{} otherwise.)
    Users *[]string `json:"users,omitempty"`
    // The list of team slugs which can dismiss pull request reviews. (Required; use nil to disable dismissal_restrictions or &[]string{} otherwise.)
    Teams *[]string `json:"teams,omitempty"`
}

DismissalRestrictionsRequest represents the request to create/edit the restriction to allows only specific users or teams to dimiss pull request reviews. It is separate from DismissalRestrictions above because the request structure is different from the response structure. Note: Both Users and Teams must be nil, or both must be non-nil.

func (*DismissalRestrictionsRequest) GetTeams ¶ Uses

❖

func (d *DismissalRestrictionsRequest) GetTeams() []string

GetTeams returns the Teams field if it's non-nil, zero value otherwise.

func (*DismissalRestrictionsRequest) GetUsers ¶ Uses

❖

func (d *DismissalRestrictionsRequest) GetUsers() []string

GetUsers returns the Users field if it's non-nil, zero value otherwise.

type DraftReviewComment ¶ Uses

❖

type DraftReviewComment struct {
    Path     *string `json:"path,omitempty"`
    Position *int    `json:"position,omitempty"`
    Body     *string `json:"body,omitempty"`
}

DraftReviewComment represents a comment part of the review.

func (*DraftReviewComment) GetBody ¶ Uses

❖

func (d *DraftReviewComment) GetBody() string

GetBody returns the Body field if it's non-nil, zero value otherwise.

func (*DraftReviewComment) GetPath ¶ Uses

❖

func (d *DraftReviewComment) GetPath() string

GetPath returns the Path field if it's non-nil, zero value otherwise.

func (*DraftReviewComment) GetPosition ¶ Uses

❖

func (d *DraftReviewComment) GetPosition() int

GetPosition returns the Position field if it's non-nil, zero value otherwise.

func (DraftReviewComment) String ¶ Uses

❖

func (c DraftReviewComment) String() string

type EditChange ¶ Uses

❖

type EditChange struct {
    Title *struct {
        From *string `json:"from,omitempty"`
    }   `json:"title,omitempty"`
    Body *struct {
        From *string `json:"from,omitempty"`
    }   `json:"body,omitempty"`
}

EditChange represents the changes when an issue, pull request, or comment has been edited.

type Error ¶ Uses

❖

type Error struct {
    Resource string `json:"resource"` // resource on which the error occurred
    Field    string `json:"field"`    // field on which the error occurred
    Code     string `json:"code"`     // validation error code
    Message  string `json:"message"`  // Message describing the error. Errors with Code == "custom" will always have this set.
}

An Error reports more details on an individual error in an ErrorResponse. These are the possible validation error codes:

missing:
    resource does not exist
missing_field:
    a required field on a resource has not been set
invalid:
    the formatting of a field is invalid
already_exists:
    another resource has the same valid as this field
custom:
    some resources return this (e.g. github.User.CreateKey()), additional
    information is set in the Message field of the Error

GitHub API docs: https://developer.github.com/v3/#client-errors

func (*Error) Error ¶ Uses

❖

func (e *Error) Error() string

type ErrorResponse ¶ Uses

❖

type ErrorResponse struct {
    Response *http.Response // HTTP response that caused this error
    Message  string         `json:"message"` // error message
    Errors   []Error        `json:"errors"`  // more detail on individual errors
    // Block is only populated on certain types of errors such as code 451.
    // See https://developer.github.com/changes/2016-03-17-the-451-status-code-is-now-supported/
    // for more information.
    Block *struct {
        Reason    string     `json:"reason,omitempty"`
        CreatedAt *Timestamp `json:"created_at,omitempty"`
    }   `json:"block,omitempty"`
    // Most errors will also include a documentation_url field pointing
    // to some content that might help you resolve the error, see
    // https://developer.github.com/v3/#client-errors
    DocumentationURL string `json:"documentation_url,omitempty"`
}

An ErrorResponse reports one or more errors caused by an API request.

GitHub API docs: https://developer.github.com/v3/#client-errors

func (*ErrorResponse) Error ¶ Uses

❖

func (r *ErrorResponse) Error() string

type Event ¶ Uses

❖

type Event struct {
    Type       *string          `json:"type,omitempty"`
    Public     *bool            `json:"public,omitempty"`
    RawPayload *json.RawMessage `json:"payload,omitempty"`
    Repo       *Repository      `json:"repo,omitempty"`
    Actor      *User            `json:"actor,omitempty"`
    Org        *Organization    `json:"org,omitempty"`
    CreatedAt  *time.Time       `json:"created_at,omitempty"`
    ID         *string          `json:"id,omitempty"`
}

Event represents a GitHub event.

func (*Event) GetActor ¶ Uses

❖

func (e *Event) GetActor() *User

GetActor returns the Actor field.

func (*Event) GetCreatedAt ¶ Uses

❖

func (e *Event) GetCreatedAt() time.Time

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*Event) GetID ¶ Uses

❖

func (e *Event) GetID() string

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*Event) GetOrg ¶ Uses

❖

func (e *Event) GetOrg() *Organization

GetOrg returns the Org field.

func (*Event) GetPublic ¶ Uses

❖

func (e *Event) GetPublic() bool

GetPublic returns the Public field if it's non-nil, zero value otherwise.

func (*Event) GetRawPayload ¶ Uses

❖

func (e *Event) GetRawPayload() json.RawMessage

GetRawPayload returns the RawPayload field if it's non-nil, zero value otherwise.

func (*Event) GetRepo ¶ Uses

❖

func (e *Event) GetRepo() *Repository

GetRepo returns the Repo field.

func (*Event) GetType ¶ Uses

❖

func (e *Event) GetType() string

GetType returns the Type field if it's non-nil, zero value otherwise.

func (*Event) ParsePayload ¶ Uses

❖

func (e *Event) ParsePayload() (payload interface{}, err error)

ParsePayload parses the event payload. For recognized event types, a value of the corresponding struct type will be returned.

func (*Event) Payload ¶ Uses

❖

func (e *Event) Payload() (payload interface{})

Payload returns the parsed event payload. For recognized event types, a value of the corresponding struct type will be returned.

Deprecated: Use ParsePayload instead, which returns an error rather than panics if JSON unmarshaling raw payload fails.

func (Event) String ¶ Uses

❖

func (e Event) String() string

type FeedLink ¶ Uses

❖

type FeedLink struct {
    HRef *string `json:"href,omitempty"`
    Type *string `json:"type,omitempty"`
}

FeedLink represents a link to a related resource.

func (*FeedLink) GetHRef ¶ Uses

❖

func (f *FeedLink) GetHRef() string

GetHRef returns the HRef field if it's non-nil, zero value otherwise.

func (*FeedLink) GetType ¶ Uses

❖

func (f *FeedLink) GetType() string

GetType returns the Type field if it's non-nil, zero value otherwise.

type Feeds ¶ Uses

❖

type Feeds struct {
    TimelineURL                 *string  `json:"timeline_url,omitempty"`
    UserURL                     *string  `json:"user_url,omitempty"`
    CurrentUserPublicURL        *string  `json:"current_user_public_url,omitempty"`
    CurrentUserURL              *string  `json:"current_user_url,omitempty"`
    CurrentUserActorURL         *string  `json:"current_user_actor_url,omitempty"`
    CurrentUserOrganizationURL  *string  `json:"current_user_organization_url,omitempty"`
    CurrentUserOrganizationURLs []string `json:"current_user_organization_urls,omitempty"`
    Links                       *struct {
        Timeline                 *FeedLink  `json:"timeline,omitempty"`
        User                     *FeedLink  `json:"user,omitempty"`
        CurrentUserPublic        *FeedLink  `json:"current_user_public,omitempty"`
        CurrentUser              *FeedLink  `json:"current_user,omitempty"`
        CurrentUserActor         *FeedLink  `json:"current_user_actor,omitempty"`
        CurrentUserOrganization  *FeedLink  `json:"current_user_organization,omitempty"`
        CurrentUserOrganizations []FeedLink `json:"current_user_organizations,omitempty"`
    }   `json:"_links,omitempty"`
}

Feeds represents timeline resources in Atom format.

func (*Feeds) GetCurrentUserActorURL ¶ Uses

❖

func (f *Feeds) GetCurrentUserActorURL() string

GetCurrentUserActorURL returns the CurrentUserActorURL field if it's non-nil, zero value otherwise.

func (*Feeds) GetCurrentUserOrganizationURL ¶ Uses

❖

func (f *Feeds) GetCurrentUserOrganizationURL() string

GetCurrentUserOrganizationURL returns the CurrentUserOrganizationURL field if it's non-nil, zero value otherwise.

func (*Feeds) GetCurrentUserPublicURL ¶ Uses

❖

func (f *Feeds) GetCurrentUserPublicURL() string

GetCurrentUserPublicURL returns the CurrentUserPublicURL field if it's non-nil, zero value otherwise.

func (*Feeds) GetCurrentUserURL ¶ Uses

❖

func (f *Feeds) GetCurrentUserURL() string

GetCurrentUserURL returns the CurrentUserURL field if it's non-nil, zero value otherwise.

func (*Feeds) GetTimelineURL ¶ Uses

❖

func (f *Feeds) GetTimelineURL() string

GetTimelineURL returns the TimelineURL field if it's non-nil, zero value otherwise.

func (*Feeds) GetUserURL ¶ Uses

❖

func (f *Feeds) GetUserURL() string

GetUserURL returns the UserURL field if it's non-nil, zero value otherwise.

type ForkEvent ¶ Uses

❖

type ForkEvent struct {
    // Forkee is the created repository.
    Forkee *Repository `json:"forkee,omitempty"`

    // The following fields are only populated by Webhook events.
    Repo         *Repository   `json:"repository,omitempty"`
    Sender       *User         `json:"sender,omitempty"`
    Installation *Installation `json:"installation,omitempty"`
}

ForkEvent is triggered when a user forks a repository. The Webhook event name is "fork".

GitHub API docs: https://developer.github.com/v3/activity/events/types/#forkevent

func (*ForkEvent) GetForkee ¶ Uses

❖

func (f *ForkEvent) GetForkee() *Repository

GetForkee returns the Forkee field.

func (*ForkEvent) GetInstallation ¶ Uses

❖

func (f *ForkEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*ForkEvent) GetRepo ¶ Uses

❖

func (f *ForkEvent) GetRepo() *Repository

GetRepo returns the Repo field.

func (*ForkEvent) GetSender ¶ Uses

❖

func (f *ForkEvent) GetSender() *User

GetSender returns the Sender field.

type GPGEmail ¶ Uses

❖

type GPGEmail struct {
    Email    *string `json:"email,omitempty"`
    Verified *bool   `json:"verified,omitempty"`
}

GPGEmail represents an email address associated to a GPG key.

func (*GPGEmail) GetEmail ¶ Uses

❖

func (g *GPGEmail) GetEmail() string

GetEmail returns the Email field if it's non-nil, zero value otherwise.

func (*GPGEmail) GetVerified ¶ Uses

❖

func (g *GPGEmail) GetVerified() bool

GetVerified returns the Verified field if it's non-nil, zero value otherwise.

type GPGKey ¶ Uses

❖

type GPGKey struct {
    ID                *int64     `json:"id,omitempty"`
    PrimaryKeyID      *int64     `json:"primary_key_id,omitempty"`
    KeyID             *string    `json:"key_id,omitempty"`
    PublicKey         *string    `json:"public_key,omitempty"`
    Emails            []GPGEmail `json:"emails,omitempty"`
    Subkeys           []GPGKey   `json:"subkeys,omitempty"`
    CanSign           *bool      `json:"can_sign,omitempty"`
    CanEncryptComms   *bool      `json:"can_encrypt_comms,omitempty"`
    CanEncryptStorage *bool      `json:"can_encrypt_storage,omitempty"`
    CanCertify        *bool      `json:"can_certify,omitempty"`
    CreatedAt         *time.Time `json:"created_at,omitempty"`
    ExpiresAt         *time.Time `json:"expires_at,omitempty"`
}

GPGKey represents a GitHub user's public GPG key used to verify GPG signed commits and tags.

https://developer.github.com/changes/2016-04-04-git-signing-api-preview/

func (*GPGKey) GetCanCertify ¶ Uses

❖

func (g *GPGKey) GetCanCertify() bool

GetCanCertify returns the CanCertify field if it's non-nil, zero value otherwise.

func (*GPGKey) GetCanEncryptComms ¶ Uses

❖

func (g *GPGKey) GetCanEncryptComms() bool

GetCanEncryptComms returns the CanEncryptComms field if it's non-nil, zero value otherwise.

func (*GPGKey) GetCanEncryptStorage ¶ Uses

❖

func (g *GPGKey) GetCanEncryptStorage() bool

GetCanEncryptStorage returns the CanEncryptStorage field if it's non-nil, zero value otherwise.

func (*GPGKey) GetCanSign ¶ Uses

❖

func (g *GPGKey) GetCanSign() bool

GetCanSign returns the CanSign field if it's non-nil, zero value otherwise.

func (*GPGKey) GetCreatedAt ¶ Uses

❖

func (g *GPGKey) GetCreatedAt() time.Time

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*GPGKey) GetExpiresAt ¶ Uses

❖

func (g *GPGKey) GetExpiresAt() time.Time

GetExpiresAt returns the ExpiresAt field if it's non-nil, zero value otherwise.

func (*GPGKey) GetID ¶ Uses

❖

func (g *GPGKey) GetID() int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*GPGKey) GetKeyID ¶ Uses

❖

func (g *GPGKey) GetKeyID() string

GetKeyID returns the KeyID field if it's non-nil, zero value otherwise.

func (*GPGKey) GetPrimaryKeyID ¶ Uses

❖

func (g *GPGKey) GetPrimaryKeyID() int64

GetPrimaryKeyID returns the PrimaryKeyID field if it's non-nil, zero value otherwise.

func (*GPGKey) GetPublicKey ¶ Uses

❖

func (g *GPGKey) GetPublicKey() string

GetPublicKey returns the PublicKey field if it's non-nil, zero value otherwise.

func (GPGKey) String ¶ Uses

❖

func (k GPGKey) String() string

String stringifies a GPGKey.

type Gist ¶ Uses

❖

type Gist struct {
    ID          *string                   `json:"id,omitempty"`
    Description *string                   `json:"description,omitempty"`
    Public      *bool                     `json:"public,omitempty"`
    Owner       *User                     `json:"owner,omitempty"`
    Files       map[GistFilename]GistFile `json:"files,omitempty"`
    Comments    *int                      `json:"comments,omitempty"`
    HTMLURL     *string                   `json:"html_url,omitempty"`
    GitPullURL  *string                   `json:"git_pull_url,omitempty"`
    GitPushURL  *string                   `json:"git_push_url,omitempty"`
    CreatedAt   *time.Time                `json:"created_at,omitempty"`
    UpdatedAt   *time.Time                `json:"updated_at,omitempty"`
    NodeID      *string                   `json:"node_id,omitempty"`
}

Gist represents a GitHub's gist.

func (*Gist) GetComments ¶ Uses

❖

func (g *Gist) GetComments() int

GetComments returns the Comments field if it's non-nil, zero value otherwise.

func (*Gist) GetCreatedAt ¶ Uses

❖

func (g *Gist) GetCreatedAt() time.Time

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*Gist) GetDescription ¶ Uses

❖

func (g *Gist) GetDescription() string

GetDescription returns the Description field if it's non-nil, zero value otherwise.

func (*Gist) GetGitPullURL ¶ Uses

❖

func (g *Gist) GetGitPullURL() string

GetGitPullURL returns the GitPullURL field if it's non-nil, zero value otherwise.

func (*Gist) GetGitPushURL ¶ Uses

❖

func (g *Gist) GetGitPushURL() string

GetGitPushURL returns the GitPushURL field if it's non-nil, zero value otherwise.

func (*Gist) GetHTMLURL ¶ Uses

❖

func (g *Gist) GetHTMLURL() string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*Gist) GetID ¶ Uses

❖

func (g *Gist) GetID() string

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*Gist) GetNodeID ¶ Uses

❖

func (g *Gist) GetNodeID() string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*Gist) GetOwner ¶ Uses

❖

func (g *Gist) GetOwner() *User

GetOwner returns the Owner field.

func (*Gist) GetPublic ¶ Uses

❖

func (g *Gist) GetPublic() bool

GetPublic returns the Public field if it's non-nil, zero value otherwise.

func (*Gist) GetUpdatedAt ¶ Uses

❖

func (g *Gist) GetUpdatedAt() time.Time

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

func (Gist) String ¶ Uses

❖

func (g Gist) String() string

type GistComment ¶ Uses

❖

type GistComment struct {
    ID        *int64     `json:"id,omitempty"`
    URL       *string    `json:"url,omitempty"`
    Body      *string    `json:"body,omitempty"`
    User      *User      `json:"user,omitempty"`
    CreatedAt *time.Time `json:"created_at,omitempty"`
}

GistComment represents a Gist comment.

func (*GistComment) GetBody ¶ Uses

❖

func (g *GistComment) GetBody() string

GetBody returns the Body field if it's non-nil, zero value otherwise.

func (*GistComment) GetCreatedAt ¶ Uses

❖

func (g *GistComment) GetCreatedAt() time.Time

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*GistComment) GetID ¶ Uses

❖

func (g *GistComment) GetID() int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*GistComment) GetURL ¶ Uses

❖

func (g *GistComment) GetURL() string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*GistComment) GetUser ¶ Uses

❖

func (g *GistComment) GetUser() *User

GetUser returns the User field.

func (GistComment) String ¶ Uses

❖

func (g GistComment) String() string

type GistCommit ¶ Uses

❖

type GistCommit struct {
    URL          *string      `json:"url,omitempty"`
    Version      *string      `json:"version,omitempty"`
    User         *User        `json:"user,omitempty"`
    ChangeStatus *CommitStats `json:"change_status,omitempty"`
    CommittedAt  *Timestamp   `json:"committed_at,omitempty"`
    NodeID       *string      `json:"node_id,omitempty"`
}

GistCommit represents a commit on a gist.

func (*GistCommit) GetChangeStatus ¶ Uses

❖

func (g *GistCommit) GetChangeStatus() *CommitStats

GetChangeStatus returns the ChangeStatus field.

func (*GistCommit) GetCommittedAt ¶ Uses

❖

func (g *GistCommit) GetCommittedAt() Timestamp

GetCommittedAt returns the CommittedAt field if it's non-nil, zero value otherwise.

func (*GistCommit) GetNodeID ¶ Uses

❖

func (g *GistCommit) GetNodeID() string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*GistCommit) GetURL ¶ Uses

❖

func (g *GistCommit) GetURL() string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*GistCommit) GetUser ¶ Uses

❖

func (g *GistCommit) GetUser() *User

GetUser returns the User field.

func (*GistCommit) GetVersion ¶ Uses

❖

func (g *GistCommit) GetVersion() string

GetVersion returns the Version field if it's non-nil, zero value otherwise.

func (GistCommit) String ¶ Uses

❖

func (gc GistCommit) String() string

type GistFile ¶ Uses

❖

type GistFile struct {
    Size     *int    `json:"size,omitempty"`
    Filename *string `json:"filename,omitempty"`
    Language *string `json:"language,omitempty"`
    Type     *string `json:"type,omitempty"`
    RawURL   *string `json:"raw_url,omitempty"`
    Content  *string `json:"content,omitempty"`
}

GistFile represents a file on a gist.

func (*GistFile) GetContent ¶ Uses

❖

func (g *GistFile) GetContent() string

GetContent returns the Content field if it's non-nil, zero value otherwise.

func (*GistFile) GetFilename ¶ Uses

❖

func (g *GistFile) GetFilename() string

GetFilename returns the Filename field if it's non-nil, zero value otherwise.

func (*GistFile) GetLanguage ¶ Uses

❖

func (g *GistFile) GetLanguage() string

GetLanguage returns the Language field if it's non-nil, zero value otherwise.

func (*GistFile) GetRawURL ¶ Uses

❖

func (g *GistFile) GetRawURL() string

GetRawURL returns the RawURL field if it's non-nil, zero value otherwise.

func (*GistFile) GetSize ¶ Uses

❖

func (g *GistFile) GetSize() int

GetSize returns the Size field if it's non-nil, zero value otherwise.

func (*GistFile) GetType ¶ Uses

❖

func (g *GistFile) GetType() string

GetType returns the Type field if it's non-nil, zero value otherwise.

func (GistFile) String ¶ Uses

❖

func (g GistFile) String() string

type GistFilename ¶ Uses

❖

type GistFilename string

GistFilename represents filename on a gist.

type GistFork ¶ Uses

❖

type GistFork struct {
    URL       *string    `json:"url,omitempty"`
    User      *User      `json:"user,omitempty"`
    ID        *string    `json:"id,omitempty"`
    CreatedAt *Timestamp `json:"created_at,omitempty"`
    UpdatedAt *Timestamp `json:"updated_at,omitempty"`
    NodeID    *string    `json:"node_id,omitempty"`
}

GistFork represents a fork of a gist.

func (*GistFork) GetCreatedAt ¶ Uses

❖

func (g *GistFork) GetCreatedAt() Timestamp

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*GistFork) GetID ¶ Uses

❖

func (g *GistFork) GetID() string

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*GistFork) GetNodeID ¶ Uses

❖

func (g *GistFork) GetNodeID() string

GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.

func (*GistFork) GetURL ¶ Uses

❖

func (g *GistFork) GetURL() string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*GistFork) GetUpdatedAt ¶ Uses

❖

func (g *GistFork) GetUpdatedAt() Timestamp

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

func (*GistFork) GetUser ¶ Uses

❖

func (g *GistFork) GetUser() *User

GetUser returns the User field.

func (GistFork) String ¶ Uses

❖

func (gf GistFork) String() string

type GistListOptions ¶ Uses

❖

type GistListOptions struct {
    // Since filters Gists by time.
    Since time.Time `url:"since,omitempty"`

    ListOptions
}

GistListOptions specifies the optional parameters to the GistsService.List, GistsService.ListAll, and GistsService.ListStarred methods.

type GistStats ¶ Uses

❖

type GistStats struct {
    TotalGists   *int `json:"total_gists,omitempty"`
    PrivateGists *int `json:"private_gists,omitempty"`
    PublicGists  *int `json:"public_gists,omitempty"`
}

GistStats represents the number of total, private and public gists.

func (*GistStats) GetPrivateGists ¶ Uses

❖

func (g *GistStats) GetPrivateGists() int

GetPrivateGists returns the PrivateGists field if it's non-nil, zero value otherwise.

func (*GistStats) GetPublicGists ¶ Uses

❖

func (g *GistStats) GetPublicGists() int

GetPublicGists returns the PublicGists field if it's non-nil, zero value otherwise.

func (*GistStats) GetTotalGists ¶ Uses

❖

func (g *GistStats) GetTotalGists() int

GetTotalGists returns the TotalGists field if it's non-nil, zero value otherwise.

func (GistStats) String ¶ Uses

❖

func (s GistStats) String() string

type GistsService ¶ Uses

❖

type GistsService service

GistsService handles communication with the Gist related methods of the GitHub API.

GitHub API docs: https://developer.github.com/v3/gists/

func (*GistsService) Create ¶ Uses

❖

func (s *GistsService) Create(ctx context.Context, gist *Gist) (*Gist, *Response, error)

Create a gist for authenticated user.

GitHub API docs: https://developer.github.com/v3/gists/#create-a-gist

func (*GistsService) CreateComment ¶ Uses

❖

func (s *GistsService) CreateComment(ctx context.Context, gistID string, comment *GistComment) (*GistComment, *Response, error)

CreateComment creates a comment for a gist.

GitHub API docs: https://developer.github.com/v3/gists/comments/#create-a-comment

func (*GistsService) Delete ¶ Uses

❖

func (s *GistsService) Delete(ctx context.Context, id string) (*Response, error)

Delete a gist.

GitHub API docs: https://developer.github.com/v3/gists/#delete-a-gist

func (*GistsService) DeleteComment ¶ Uses

❖

func (s *GistsService) DeleteComment(ctx context.Context, gistID string, commentID int64) (*Response, error)

DeleteComment deletes a gist comment.

GitHub API docs: https://developer.github.com/v3/gists/comments/#delete-a-comment

func (*GistsService) Edit ¶ Uses

❖

func (s *GistsService) Edit(ctx context.Context, id string, gist *Gist) (*Gist, *Response, error)

Edit a gist.

GitHub API docs: https://developer.github.com/v3/gists/#edit-a-gist

func (*GistsService) EditComment ¶ Uses

❖

func (s *GistsService) EditComment(ctx context.Context, gistID string, commentID int64, comment *GistComment) (*GistComment, *Response, error)

EditComment edits an existing gist comment.

GitHub API docs: https://developer.github.com/v3/gists/comments/#edit-a-comment

func (*GistsService) Fork ¶ Uses

❖

func (s *GistsService) Fork(ctx context.Context, id string) (*Gist, *Response, error)

Fork a gist.

GitHub API docs: https://developer.github.com/v3/gists/#fork-a-gist

func (*GistsService) Get ¶ Uses

❖

func (s *GistsService) Get(ctx context.Context, id string) (*Gist, *Response, error)

Get a single gist.

GitHub API docs: https://developer.github.com/v3/gists/#get-a-single-gist

func (*GistsService) GetComment ¶ Uses

❖

func (s *GistsService) GetComment(ctx context.Context, gistID string, commentID int64) (*GistComment, *Response, error)

GetComment retrieves a single comment from a gist.

GitHub API docs: https://developer.github.com/v3/gists/comments/#get-a-single-comment

func (*GistsService) GetRevision ¶ Uses

❖

func (s *GistsService) GetRevision(ctx context.Context, id, sha string) (*Gist, *Response, error)

GetRevision gets a specific revision of a gist.

GitHub API docs: https://developer.github.com/v3/gists/#get-a-specific-revision-of-a-gist

func (*GistsService) IsStarred ¶ Uses

❖

func (s *GistsService) IsStarred(ctx context.Context, id string) (bool, *Response, error)

IsStarred checks if a gist is starred by authenticated user.

GitHub API docs: https://developer.github.com/v3/gists/#check-if-a-gist-is-starred

func (*GistsService) List ¶ Uses

❖

func (s *GistsService) List(ctx context.Context, user string, opt *GistListOptions) ([]*Gist, *Response, error)

List gists for a user. Passing the empty string will list all public gists if called anonymously. However, if the call is authenticated, it will returns all gists for the authenticated user.

GitHub API docs: https://developer.github.com/v3/gists/#list-gists

func (*GistsService) ListAll ¶ Uses

❖

func (s *GistsService) ListAll(ctx context.Context, opt *GistListOptions) ([]*Gist, *Response, error)

ListAll lists all public gists.

GitHub API docs: https://developer.github.com/v3/gists/#list-gists

func (*GistsService) ListComments ¶ Uses

❖

func (s *GistsService) ListComments(ctx context.Context, gistID string, opt *ListOptions) ([]*GistComment, *Response, error)

ListComments lists all comments for a gist.

GitHub API docs: https://developer.github.com/v3/gists/comments/#list-comments-on-a-gist

func (*GistsService) ListCommits ¶ Uses

❖

func (s *GistsService) ListCommits(ctx context.Context, id string, opt *ListOptions) ([]*GistCommit, *Response, error)

ListCommits lists commits of a gist.

GitHub API docs: https://developer.github.com/v3/gists/#list-gist-commits

func (*GistsService) ListForks ¶ Uses

❖

func (s *GistsService) ListForks(ctx context.Context, id string) ([]*GistFork, *Response, error)

ListForks lists forks of a gist.

GitHub API docs: https://developer.github.com/v3/gists/#list-gist-forks

func (*GistsService) ListStarred ¶ Uses

❖

func (s *GistsService) ListStarred(ctx context.Context, opt *GistListOptions) ([]*Gist, *Response, error)

ListStarred lists starred gists of authenticated user.

GitHub API docs: https://developer.github.com/v3/gists/#list-gists

func (*GistsService) Star ¶ Uses

❖

func (s *GistsService) Star(ctx context.Context, id string) (*Response, error)

Star a gist on behalf of authenticated user.

GitHub API docs: https://developer.github.com/v3/gists/#star-a-gist

func (*GistsService) Unstar ¶ Uses

❖

func (s *GistsService) Unstar(ctx context.Context, id string) (*Response, error)

Unstar a gist on a behalf of authenticated user.

GitHub API docs: https://developer.github.com/v3/gists/#unstar-a-gist

type GitHubAppAuthorizationEvent ¶ Uses

❖

type GitHubAppAuthorizationEvent struct {
    // The action performed. Can be "revoked".
    Action *string `json:"action,omitempty"`

    // The following fields are only populated by Webhook events.
    Sender *User `json:"sender,omitempty"`
}

GitHubAppAuthorizationEvent is triggered when a user's authorization for a GitHub Application is revoked.

GitHub API docs: https://developer.github.com/v3/activity/events/types/#githubappauthorizationevent

func (*GitHubAppAuthorizationEvent) GetAction ¶ Uses

❖

func (g *GitHubAppAuthorizationEvent) GetAction() string

GetAction returns the Action field if it's non-nil, zero value otherwise.

func (*GitHubAppAuthorizationEvent) GetSender ¶ Uses

❖

func (g *GitHubAppAuthorizationEvent) GetSender() *User

GetSender returns the Sender field.

type GitObject ¶ Uses

❖

type GitObject struct {
    Type *string `json:"type"`
    SHA  *string `json:"sha"`
    URL  *string `json:"url"`
}

GitObject represents a Git object.

func (*GitObject) GetSHA ¶ Uses

❖

func (g *GitObject) GetSHA() string

GetSHA returns the SHA field if it's non-nil, zero value otherwise.

func (*GitObject) GetType ¶ Uses

❖

func (g *GitObject) GetType() string

GetType returns the Type field if it's non-nil, zero value otherwise.

func (*GitObject) GetURL ¶ Uses

❖

func (g *GitObject) GetURL() string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (GitObject) String ¶ Uses

❖

func (o GitObject) String() string

type GitService ¶ Uses

❖

type GitService service

GitService handles communication with the git data related methods of the GitHub API.

GitHub API docs: https://developer.github.com/v3/git/

func (*GitService) CreateBlob ¶ Uses

❖

func (s *GitService) CreateBlob(ctx context.Context, owner string, repo string, blob *Blob) (*Blob, *Response, error)

CreateBlob creates a blob object.

GitHub API docs: https://developer.github.com/v3/git/blobs/#create-a-blob

func (*GitService) CreateCommit ¶ Uses

❖

func (s *GitService) CreateCommit(ctx context.Context, owner string, repo string, commit *Commit) (*Commit, *Response, error)

CreateCommit creates a new commit in a repository. commit must not be nil.

The commit.Committer is optional and will be filled with the commit.Author data if omitted. If the commit.Author is omitted, it will be filled in with the authenticated user’s information and the current date.

GitHub API docs: https://developer.github.com/v3/git/commits/#create-a-commit

func (*GitService) CreateRef ¶ Uses

❖

func (s *GitService) CreateRef(ctx context.Context, owner string, repo string, ref *Reference) (*Reference, *Response, error)

CreateRef creates a new ref in a repository.

GitHub API docs: https://developer.github.com/v3/git/refs/#create-a-reference

func (*GitService) CreateTag ¶ Uses

❖

func (s *GitService) CreateTag(ctx context.Context, owner string, repo string, tag *Tag) (*Tag, *Response, error)

CreateTag creates a tag object.

GitHub API docs: https://developer.github.com/v3/git/tags/#create-a-tag-object

func (*GitService) CreateTree ¶ Uses

❖

func (s *GitService) CreateTree(ctx context.Context, owner string, repo string, baseTree string, entries []TreeEntry) (*Tree, *Response, error)

CreateTree creates a new tree in a repository. If both a tree and a nested path modifying that tree are specified, it will overwrite the contents of that tree with the new path contents and write a new tree out.

GitHub API docs: https://developer.github.com/v3/git/trees/#create-a-tree

func (*GitService) DeleteRef ¶ Uses

❖

func (s *GitService) DeleteRef(ctx context.Context, owner string, repo string, ref string) (*Response, error)

DeleteRef deletes a ref from a repository.

GitHub API docs: https://developer.github.com/v3/git/refs/#delete-a-reference

func (*GitService) GetBlob ¶ Uses

❖

func (s *GitService) GetBlob(ctx context.Context, owner string, repo string, sha string) (*Blob, *Response, error)

GetBlob fetches a blob from a repo given a SHA.

GitHub API docs: https://developer.github.com/v3/git/blobs/#get-a-blob

func (*GitService) GetBlobRaw ¶ Uses

❖

func (s *GitService) GetBlobRaw(ctx context.Context, owner, repo, sha string) ([]byte, *Response, error)

GetBlobRaw fetches a blob's contents from a repo. Unlike GetBlob, it returns the raw bytes rather than the base64-encoded data.

GitHub API docs: https://developer.github.com/v3/git/blobs/#get-a-blob

func (*GitService) GetCommit ¶ Uses

❖

func (s *GitService) GetCommit(ctx context.Context, owner string, repo string, sha string) (*Commit, *Response, error)

GetCommit fetches the Commit object for a given SHA.

GitHub API docs: https://developer.github.com/v3/git/commits/#get-a-commit

func (*GitService) GetRef ¶ Uses

❖

func (s *GitService) GetRef(ctx context.Context, owner string, repo string, ref string) (*Reference, *Response, error)

GetRef fetches a single Reference object for a given Git ref. If there is no exact match, GetRef will return an error.

Note: The GitHub API can return multiple matches. If you wish to use this functionality please use the GetRefs() method.

GitHub API docs: https://developer.github.com/v3/git/refs/#get-a-reference

func (*GitService) GetRefs ¶ Uses

❖

func (s *GitService) GetRefs(ctx context.Context, owner string, repo string, ref string) ([]*Reference, *Response, error)

GetRefs fetches a slice of Reference objects for a given Git ref. If there is an exact match, only that ref is returned. If there is no exact match, GitHub returns all refs that start with ref. If returned error is nil, there will be at least 1 ref returned. For example:

"heads/featureA" -> ["refs/heads/featureA"]                         // Exact match, single ref is returned.
"heads/feature"  -> ["refs/heads/featureA", "refs/heads/featureB"]  // All refs that start with ref.
"heads/notexist" -> []                                              // Returns an error.

GitHub API docs: https://developer.github.com/v3/git/refs/#get-a-reference

func (*GitService) GetTag ¶ Uses

❖

func (s *GitService) GetTag(ctx context.Context, owner string, repo string, sha string) (*Tag, *Response, error)

GetTag fetches a tag from a repo given a SHA.

GitHub API docs: https://developer.github.com/v3/git/tags/#get-a-tag

func (*GitService) GetTree ¶ Uses

❖

func (s *GitService) GetTree(ctx context.Context, owner string, repo string, sha string, recursive bool) (*Tree, *Response, error)

GetTree fetches the Tree object for a given sha hash from a repository.

GitHub API docs: https://developer.github.com/v3/git/trees/#get-a-tree

func (*GitService) ListRefs ¶ Uses

❖

func (s *GitService) ListRefs(ctx context.Context, owner, repo string, opt *ReferenceListOptions) ([]*Reference, *Response, error)

ListRefs lists all refs in a repository.

GitHub API docs: https://developer.github.com/v3/git/refs/#get-all-references

func (*GitService) UpdateRef ¶ Uses

❖

func (s *GitService) UpdateRef(ctx context.Context, owner string, repo string, ref *Reference, force bool) (*Reference, *Response, error)

UpdateRef updates an existing ref in a repository.

GitHub API docs: https://developer.github.com/v3/git/refs/#update-a-reference

type Gitignore ¶ Uses

❖

type Gitignore struct {
    Name   *string `json:"name,omitempty"`
    Source *string `json:"source,omitempty"`
}

Gitignore represents a .gitignore file as returned by the GitHub API.

func (*Gitignore) GetName ¶ Uses

❖

func (g *Gitignore) GetName() string

GetName returns the Name field if it's non-nil, zero value otherwise.

func (*Gitignore) GetSource ¶ Uses

❖

func (g *Gitignore) GetSource() string

GetSource returns the Source field if it's non-nil, zero value otherwise.

func (Gitignore) String ¶ Uses

❖

func (g Gitignore) String() string

type GitignoresService ¶ Uses

❖

type GitignoresService service

GitignoresService provides access to the gitignore related functions in the GitHub API.

GitHub API docs: https://developer.github.com/v3/gitignore/

func (GitignoresService) Get ¶ Uses

❖

func (s GitignoresService) Get(ctx context.Context, name string) (*Gitignore, *Response, error)

Get a Gitignore by name.

GitHub API docs: https://developer.github.com/v3/gitignore/#get-a-single-template

func (GitignoresService) List ¶ Uses

❖

func (s GitignoresService) List(ctx context.Context) ([]string, *Response, error)

List all available Gitignore templates.

GitHub API docs: https://developer.github.com/v3/gitignore/#listing-available-templates

type GollumEvent ¶ Uses

❖

type GollumEvent struct {
    Pages []*Page `json:"pages,omitempty"`

    // The following fields are only populated by Webhook events.
    Repo         *Repository   `json:"repository,omitempty"`
    Sender       *User         `json:"sender,omitempty"`
    Installation *Installation `json:"installation,omitempty"`
}

GollumEvent is triggered when a Wiki page is created or updated. The Webhook event name is "gollum".

GitHub API docs: https://developer.github.com/v3/activity/events/types/#gollumevent

func (*GollumEvent) GetInstallation ¶ Uses

❖

func (g *GollumEvent) GetInstallation() *Installation

GetInstallation returns the Installation field.

func (*GollumEvent) GetRepo ¶ Uses

❖

func (g *GollumEvent) GetRepo() *Repository

GetRepo returns the Repo field.

func (*GollumEvent) GetSender ¶ Uses

❖

func (g *GollumEvent) GetSender() *User

GetSender returns the Sender field.

type Grant ¶ Uses

❖

type Grant struct {
    ID        *int64            `json:"id,omitempty"`
    URL       *string           `json:"url,omitempty"`
    App       *AuthorizationApp `json:"app,omitempty"`
    CreatedAt *Timestamp        `json:"created_at,omitempty"`
    UpdatedAt *Timestamp        `json:"updated_at,omitempty"`
    Scopes    []string          `json:"scopes,omitempty"`
}

Grant represents an OAuth application that has been granted access to an account.

func (*Grant) GetApp ¶ Uses

❖

func (g *Grant) GetApp() *AuthorizationApp

GetApp returns the App field.

func (*Grant) GetCreatedAt ¶ Uses

❖

func (g *Grant) GetCreatedAt() Timestamp

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*Grant) GetID ¶ Uses

❖

func (g *Grant) GetID() int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*Grant) GetURL ¶ Uses

❖

func (g *Grant) GetURL() string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*Grant) GetUpdatedAt ¶ Uses

❖

func (g *Grant) GetUpdatedAt() Timestamp

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

func (Grant) String ¶ Uses

❖

func (g Grant) String() string

type Hook ¶ Uses

❖

type Hook struct {
    CreatedAt *time.Time `json:"created_at,omitempty"`
    UpdatedAt *time.Time `json:"updated_at,omitempty"`
    URL       *string    `json:"url,omitempty"`
    ID        *int64     `json:"id,omitempty"`

    // Only the following fields are used when creating a hook.
    // Config is required.
    Config map[string]interface{} `json:"config,omitempty"`
    Events []string               `json:"events,omitempty"`
    Active *bool                  `json:"active,omitempty"`
}

Hook represents a GitHub (web and service) hook for a repository.

func (*Hook) GetActive ¶ Uses

❖

func (h *Hook) GetActive() bool

GetActive returns the Active field if it's non-nil, zero value otherwise.

func (*Hook) GetCreatedAt ¶ Uses

❖

func (h *Hook) GetCreatedAt() time.Time

GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.

func (*Hook) GetID ¶ Uses

❖

func (h *Hook) GetID() int64

GetID returns the ID field if it's non-nil, zero value otherwise.

func (*Hook) GetURL ¶ Uses

❖

func (h *Hook) GetURL() string

GetURL returns the URL field if it's non-nil, zero value otherwise.

func (*Hook) GetUpdatedAt ¶ Uses

❖

func (h *Hook) GetUpdatedAt() time.Time

GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.

func (Hook) String ¶ Uses

❖

func (h Hook) String() string

type HookStats ¶ Uses

❖

type HookStats struct {
    TotalHooks    *int `json:"total_hooks,omitempty"`
    ActiveHooks   *int `json:"active_hooks,omitempty"`
    InactiveHooks *int `json:"inactive_hooks,omitempty"`
}

HookStats represents the number of total, active and inactive hooks.

func (*HookStats) GetActiveHooks ¶ Uses

❖

func (h *HookStats) GetActiveHooks() int

GetActiveHooks returns the ActiveHooks field if it's non-nil, zero value otherwise.

func (*HookStats) GetInactiveHooks ¶ Uses

❖

func (h *HookStats) GetInactiveHooks() int

GetInactiveHooks returns the InactiveHooks field if it's non-nil, zero value otherwise.

func (*HookStats) GetTotalHooks ¶ Uses

❖

func (h *HookStats) GetTotalHooks() int

GetTotalHooks returns the TotalHooks field if it's non-nil, zero value otherwise.

func (HookStats) String ¶ Uses

❖

func (s HookStats) String() string

❖

type Hovercard struct {
    Contexts []*UserContext `json:"contexts,omitempty"`
}

Hovercard represents hovercard information about a user.

type HovercardOptions ¶ Uses

❖

type HovercardOptions struct {
    // SubjectType specifies the additional information to be received about the hovercard.
    // Possible values are: organization, repository, issue, pull_request. (Required when using subject_id.)
    SubjectType string `url:"subject_type"`

    // SubjectID specifies the ID for the SubjectType. (Required when using subject_type.)
    SubjectID string `url:"subject_id"`
}

HovercardOptions specifies optional parameters to the UsersService.GetHovercard method.

type Import ¶ Uses

❖

type Import struct {
    // The URL of the originating repository.
    VCSURL *string `json:"vcs_url,omitempty"`
    // The originating VCS type. Can be one of 'subversion', 'git',
    // 'mercurial', or 'tfvc'. Without this parameter, the import job will
    // take additional time to detect the VCS type before beginning the
    // import. This detection step will be reflected in the response.
    VCS *string `json:"vcs,omitempty"`
    // VCSUsername and VCSPassword are only used for StartImport calls that
    // are importing a password-protected repository.
    VCSUsername *string `json:"vcs_username,omitempty"`
    VCSPassword *string `json:"vcs_password,omitempty"`
    // For a tfvc import, the name of the project that is being imported.
    TFVCProject *string `json:"tfvc_project,omitempty"`

    // Describes whether the import has been opted in or out of using Git
    // LFS. The value can be 'opt_in', 'opt_out', or 'undecided' if no
    // action has been taken.
    UseLFS *string `json:"use_lfs,omitempty"`
    // Describes whether files larger than 100MB were found during the
    // importing step.
    HasLargeFiles *bool `json:"has_large_files,omitempty"`
    // The total size in gigabytes of files larger than 100MB found in the
    // originating repository.
    LargeFilesSize *int `json:"large_files_size,omitempty"`
    // The total number of files larger than 100MB found in the originating
    // repository. To see a list of these files, call LargeFiles.
    LargeFilesCount *int `json:"large_files_count,omitempty"`

    // Identifies the current status of an import. An import that does not
    // have errors will progress through these steps:
    //
    //     detecting - the "detection" step of the import is in progress
    //         because the request did not include a VCS parameter. The
    //         import is identifying the type of source control present at
    //         the URL.
    //     importing - the "raw" step of the import is in progress. This is
    //         where commit data is fetched from the original repository.
    //         The import progress response will include CommitCount (the
    //         total number of raw commits that will be imported) and
    //         Percent (0 - 100, the current progress through the import).
    //     mapping - the "rewrite" step of the import is in progress. This
    //         is where SVN branches are converted to Git branches, and
    //         where author updates are applied. The import progress
    //         response does not include progress information.
    //     pushing - the "push" step of the import is in progress. This is
    //         where the importer updates the repository on GitHub. The
    //         import progress response will include PushPercent, which is
    //         the percent value reported by git push when it is "Writing
    //         objects".
    //     complete - the import is complete, and the repository is ready
    //         on GitHub.
    //
    // If there are problems, you will see one of these in the status field:
    //
    //     auth_failed - the import requires authentication in order to
    //         connect to the original repository. Make an UpdateImport
    //         request, and include VCSUsername and VCSPassword.
    //     error - the import encountered an error. The import progress
    //         response will include the FailedStep and an error message.
    //         Contact GitHub support for more information.
    //     detection_needs_auth - the importer requires authentication for
    //         the originating repository to continue detection. Make an
    //         UpdatImport request, and include VCSUsername and
    //         VCSPassword.
    //     detection_found_nothing - the importer didn't recognize any
    //         source control at the URL.
    //     detection_found_multiple - the importer found several projects
    //         or repositories at the provided URL. When this is the case,
    //         the Import Progress response will also include a
    //         ProjectChoices field with the possible project choices as
    //         values. Make an UpdateImport request, and include VCS and
    //         (if applicable) TFVCProject.
    Status        *string `json:"status,omitempty"`
    CommitCount   *int    `json:"commit_count,omitempty"`
    StatusText    *string `json:"status_text,omitempty"`
    AuthorsCount  *int    `json:"authors_count,omitempty"`
    Percent       *int    `json:"percent,omitempty"`
    PushPercent   *int    `json:"push_percent,omitempty"`
    URL           *string `json:"url,omitempty"`
    HTMLURL       *string `json:"html_url,omitempty"`
    AuthorsURL    *string `json:"authors_url,omitempty"`
    RepositoryURL *string `json:"repository_url,omitempty"`
    Message       *string `json:"message,omitempty"`
    FailedStep    *string `json:"failed_step,omitempty"`

    // Human readable display name, provided when the Import appears as
    // part of ProjectChoices.
    HumanName *string `json:"human_name,omitempty"`

    // When the importer finds several projects or repositories at the
    // provided URLs, this will identify the available choices. Call
    // UpdateImport with the selected Import value.
    ProjectChoices []Import `json:"project_choices,omitempty"`
}

Import represents a repository import request.

func (*Import) GetAuthorsCount ¶ Uses

❖

func (i *Import) GetAuthorsCount() int

GetAuthorsCount returns the AuthorsCount field if it's non-nil, zero value otherwise.

func (*Import) GetAuthorsURL ¶ Uses

❖

func (i *Import) GetAuthorsURL() string

GetAuthorsURL returns the AuthorsURL field if it's non-nil, zero value otherwise.

func (*Import) GetCommitCount ¶ Uses

❖

func (i *Import) GetCommitCount() int

GetCommitCount returns the CommitCount field if it's non-nil, zero value otherwise.

func (*Import) GetFailedStep ¶ Uses

❖

func (i *Import) GetFailedStep() string

GetFailedStep returns the FailedStep field if it's non-nil, zero value otherwise.

func (*Import) GetHTMLURL ¶ Uses

❖

func (i *Import) GetHTMLURL() string

GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.

func (*Import) GetHasLargeFiles ¶ Uses

❖

func (i *Import) GetHasLargeFiles() bool

GetHasLargeFiles returns the HasLargeFiles field if it's non-nil, zero value otherwise.

func (*Import) GetHumanName ¶ Uses

❖

func (i *Import) GetHumanName() string

GetHumanName returns the HumanName field if it's non-nil, zero value otherwise.

func (*Import) GetLargeFilesCount ¶ Uses

❖

func (i *Import) GetLargeFilesCount() int

GetLargeFilesCount returns the LargeFilesCount field if it's non-nil, zero value otherwise.

func (*Import) GetLargeFilesSize ¶ Uses

❖

func (i *Import) GetLargeFilesSize() int

GetLargeFilesSize returns the LargeFilesSize field if it's non-nil, zero value otherwise.

func (*Import) GetMessage ¶ Uses

❖

func (i *Import) GetMessage() string

GetMessage returns the Message field if it's non-nil, zero value otherwise.

func (*Import) GetPercent ¶ Uses

❖

func (i *Import) GetPercent() int

GetPercent returns the Percent field if it's non-nil, zero value otherwise.

func (*Import) GetPushPercent ¶ Uses

❖

func (i *Import) GetPushPercent() int

GetPushPercent returns the PushPercent field if it's non-nil, zero value otherwise.

func (*Import) GetRepositoryURL ¶ Uses

❖

func (i *Import) GetRepositoryURL() string

GetRepositoryURL returns the RepositoryURL field if it's non-nil, zero value otherwise.

func (*Import) GetStatus ¶ Uses

❖

func (i *Import) GetStatus() string

GetStatus returns the Status field if it's non-nil, zero value otherwise.

func (*Import) GetStatusText ¶ Uses

❖

func (i *Import) GetStatusText() string

GetStatusText returns the StatusText field if it's non-nil, zero value otherwise.

func (*Import) GetTFVCProject ¶ Uses

❖

func (i *Import) GetTFVCProject() string

GetTFVCProject returns the TFVCProject field if it's non-nil, zero value otherwise.

func (*Import) GetURL ¶ Uses

❖

func (i *Import) GetURL() s

package github

Authentication ¶

Rate Limiting ¶

Accepted Status ¶

Conditional Requests ¶

Creating and Updating Resources ¶

Pagination ¶

Index ¶

Examples ¶

Package Files ¶

Constants ¶

func Bool ¶ Uses

func CheckResponse ¶ Uses

func DeliveryID ¶ Uses

func Int ¶ Uses

func Int64 ¶ Uses

func ParseWebHook ¶ Uses

func String ¶ Uses

func Stringify ¶ Uses

func ValidatePayload ¶ Uses

func ValidateSignature ¶ Uses

func WebHookType ¶ Uses

type APIMeta ¶ Uses

func (*APIMeta) GetVerifiablePasswordAuthentication ¶ Uses

type AbuseRateLimitError ¶ Uses

func (*AbuseRateLimitError) Error ¶ Uses

func (*AbuseRateLimitError) GetRetryAfter ¶ Uses

type AcceptedError ¶ Uses

func (*AcceptedError) Error ¶ Uses

type ActivityListStarredOptions ¶ Uses

type ActivityService ¶ Uses

func (*ActivityService) DeleteRepositorySubscription ¶ Uses

func (*ActivityService) DeleteThreadSubscription ¶ Uses

func (*ActivityService) GetRepositorySubscription ¶ Uses

func (*ActivityService) GetThread ¶ Uses

func (*ActivityService) GetThreadSubscription ¶ Uses

func (*ActivityService) IsStarred ¶ Uses

func (*ActivityService) ListEvents ¶ Uses

func (*ActivityService) ListEventsForOrganization ¶ Uses

func (*ActivityService) ListEventsForRepoNetwork ¶ Uses

func (*ActivityService) ListEventsPerformedByUser ¶ Uses

func (*ActivityService) ListEventsReceivedByUser ¶ Uses

func (*ActivityService) ListFeeds ¶ Uses

func (*ActivityService) ListIssueEventsForRepository ¶ Uses

func (*ActivityService) ListNotifications ¶ Uses

func (*ActivityService) ListRepositoryEvents ¶ Uses

func (*ActivityService) ListRepositoryNotifications ¶ Uses

func (*ActivityService) ListStargazers ¶ Uses

func (*ActivityService) ListStarred ¶ Uses

func (*ActivityService) ListUserEventsForOrganization ¶ Uses

func (*ActivityService) ListWatched ¶ Uses

func (*ActivityService) ListWatchers ¶ Uses

func (*ActivityService) MarkNotificationsRead ¶ Uses

func (*ActivityService) MarkRepositoryNotificationsRead ¶ Uses

func (*ActivityService) MarkThreadRead ¶ Uses

func (*ActivityService) SetRepositorySubscription ¶ Uses

func (*ActivityService) SetThreadSubscription ¶ Uses

func (*ActivityService) Star ¶ Uses

func (*ActivityService) Unstar ¶ Uses

type AdminEnforcement ¶ Uses

func (*AdminEnforcement) GetURL ¶ Uses

type AdminService ¶ Uses

func (*AdminService) GetAdminStats ¶ Uses

func (*AdminService) UpdateTeamLDAPMapping ¶ Uses

func (*AdminService) UpdateUserLDAPMapping ¶ Uses

type AdminStats ¶ Uses

func (*AdminStats) GetComments ¶ Uses

func (*AdminStats) GetGists ¶ Uses

func (*AdminStats) GetHooks ¶ Uses

func (*AdminStats) GetIssues ¶ Uses

func (*AdminStats) GetMilestones ¶ Uses

func (*AdminStats) GetOrgs ¶ Uses

func (*AdminStats) GetPages ¶ Uses

func (*AdminStats) GetPulls ¶ Uses

func (*AdminStats) GetRepos ¶ Uses

func (*AdminStats) GetUsers ¶ Uses

func (AdminStats) String ¶ Uses

type App ¶ Uses

func (*App) GetCreatedAt ¶ Uses

func (*App) GetDescription ¶ Uses