💾 Archived View for godocs.io › github.com › google › go-github › github captured on 2023-11-14 at 07:55:15. Gemini links have been rewritten to link to archived content
⬅️ Previous capture (2023-11-04)
➡️ Next capture (2024-02-05)
-=-=-=-=-=-=-
import "github.com/google/go-github/github"
Package github provides a client for using the GitHub API.
Usage:
import "github.com/google/go-github/github"
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.
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...
}
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.
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")
}
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.
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(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(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(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(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(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(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(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(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(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 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 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 (a *APIMeta) GetVerifiablePasswordAuthentication() bool
GetVerifiablePasswordAuthentication returns the VerifiablePasswordAuthentication field if it's non-nil, zero value otherwise.
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 (r *AbuseRateLimitError) Error() string
func (a *AbuseRateLimitError) GetRetryAfter() time.Duration
GetRetryAfter returns the RetryAfter field if it's non-nil, zero value otherwise.
type AcceptedError struct{}
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() string
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 service
ActivityService handles communication with the activity related methods of the GitHub API.
GitHub API docs: https://developer.github.com/v3/activity/
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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 struct {
URL *string `json:"url,omitempty"`
Enabled bool `json:"enabled"`
}
AdminEnforcement represents the configuration to enforce required status checks for repository administrators.
func (a *AdminEnforcement) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
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 (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 (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 (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 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 (a *AdminStats) GetComments() *CommentStats
GetComments returns the Comments field.
func (a *AdminStats) GetGists() *GistStats
GetGists returns the Gists field.
func (a *AdminStats) GetHooks() *HookStats
GetHooks returns the Hooks field.
func (a *AdminStats) GetIssues() *IssueStats
GetIssues returns the Issues field.
func (a *AdminStats) GetMilestones() *MilestoneStats
GetMilestones returns the Milestones field.
func (a *AdminStats) GetOrgs() *OrgStats
GetOrgs returns the Orgs field.
func (a *AdminStats) GetPages() *PageStats
GetPages returns the Pages field.
func (a *AdminStats) GetPulls() *PullStats
GetPulls returns the Pulls field.
func (a *AdminStats) GetRepos() *RepoStats
GetRepos returns the Repos field.
func (a *AdminStats) GetUsers() *UserStats
GetUsers returns the Users field.
func (s AdminStats) String() string
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 (a *App) GetCreatedAt() time.Time
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (a *App) GetDescription() string
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (a *App) GetExternalURL() string
GetExternalURL returns the ExternalURL field if it's non-nil, zero value otherwise.
func (a *App) GetHTMLURL() string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (a *App) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (a *App) GetName() string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (a *App) GetNodeID() string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (a *App) GetOwner() *User
GetOwner returns the Owner field.
func (a *App) GetUpdatedAt() time.Time
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 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 (a *Authorization) GetApp() *AuthorizationApp
GetApp returns the App field.
func (a *Authorization) GetCreatedAt() Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (a *Authorization) GetFingerprint() string
GetFingerprint returns the Fingerprint field if it's non-nil, zero value otherwise.
func (a *Authorization) GetHashedToken() string
GetHashedToken returns the HashedToken field if it's non-nil, zero value otherwise.
func (a *Authorization) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (a *Authorization) GetNote() string
GetNote returns the Note field if it's non-nil, zero value otherwise.
func (a *Authorization) GetNoteURL() string
GetNoteURL returns the NoteURL field if it's non-nil, zero value otherwise.
func (a *Authorization) GetToken() string
GetToken returns the Token field if it's non-nil, zero value otherwise.
func (a *Authorization) GetTokenLastEight() string
GetTokenLastEight returns the TokenLastEight field if it's non-nil, zero value otherwise.
func (a *Authorization) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (a *Authorization) GetUpdatedAt() Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (a *Authorization) GetUser() *User
GetUser returns the User field.
func (a Authorization) String() string
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 (a *AuthorizationApp) GetClientID() string
GetClientID returns the ClientID field if it's non-nil, zero value otherwise.
func (a *AuthorizationApp) GetName() string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (a *AuthorizationApp) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (a AuthorizationApp) String() string
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 (a *AuthorizationRequest) GetClientID() string
GetClientID returns the ClientID field if it's non-nil, zero value otherwise.
func (a *AuthorizationRequest) GetClientSecret() string
GetClientSecret returns the ClientSecret field if it's non-nil, zero value otherwise.
func (a *AuthorizationRequest) GetFingerprint() string
GetFingerprint returns the Fingerprint field if it's non-nil, zero value otherwise.
func (a *AuthorizationRequest) GetNote() string
GetNote returns the Note field if it's non-nil, zero value otherwise.
func (a *AuthorizationRequest) GetNoteURL() string
GetNoteURL returns the NoteURL field if it's non-nil, zero value otherwise.
func (a AuthorizationRequest) String() string
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 (a *AuthorizationUpdateRequest) GetFingerprint() string
GetFingerprint returns the Fingerprint field if it's non-nil, zero value otherwise.
func (a *AuthorizationUpdateRequest) GetNote() string
GetNote returns the Note field if it's non-nil, zero value otherwise.
func (a *AuthorizationUpdateRequest) GetNoteURL() string
GetNoteURL returns the NoteURL field if it's non-nil, zero value otherwise.
func (a AuthorizationUpdateRequest) String() string
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 (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 (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 (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/2.5/v3/users/administration/#create-an-impersonation-oauth-token
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 (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 (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/2.5/v3/users/administration/#delete-an-impersonation-oauth-token
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 (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 (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 (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 (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 (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 (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 (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 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 (a *AutoTriggerCheck) GetAppID() int64
GetAppID returns the AppID field if it's non-nil, zero value otherwise.
func (a *AutoTriggerCheck) GetSetting() bool
GetSetting returns the Setting field if it's non-nil, zero value otherwise.
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 (t *BasicAuthTransport) Client() *http.Client
Client returns an *http.Client that makes requests that are authenticated using HTTP Basic Authentication.
func (t *BasicAuthTransport) RoundTrip(req *http.Request) (*http.Response, error)
RoundTrip implements the RoundTripper interface.
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 (b *Blob) GetContent() string
GetContent returns the Content field if it's non-nil, zero value otherwise.
func (b *Blob) GetEncoding() string
GetEncoding returns the Encoding field if it's non-nil, zero value otherwise.
func (b *Blob) GetNodeID() string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (b *Blob) GetSHA() string
GetSHA returns the SHA field if it's non-nil, zero value otherwise.
func (b *Blob) GetSize() int
GetSize returns the Size field if it's non-nil, zero value otherwise.
func (b *Blob) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
type Branch struct {
Name *string `json:"name,omitempty"`
Commit *RepositoryCommit `json:"commit,omitempty"`
Protected *bool `json:"protected,omitempty"`
}
Branch represents a repository branch
func (b *Branch) GetCommit() *RepositoryCommit
GetCommit returns the Commit field.
func (b *Branch) GetName() string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (b *Branch) GetProtected() bool
GetProtected returns the Protected field if it's non-nil, zero value otherwise.
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 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 struct {
ID *int64 `json:"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"`
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 (c *CheckRun) GetApp() *App
GetApp returns the App field.
func (c *CheckRun) GetCheckSuite() *CheckSuite
GetCheckSuite returns the CheckSuite field.
func (c *CheckRun) GetCompletedAt() Timestamp
GetCompletedAt returns the CompletedAt field if it's non-nil, zero value otherwise.
func (c *CheckRun) GetConclusion() string
GetConclusion returns the Conclusion field if it's non-nil, zero value otherwise.
func (c *CheckRun) GetExternalID() string
GetExternalID returns the ExternalID field if it's non-nil, zero value otherwise.
func (c *CheckRun) GetHTMLURL() string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (c *CheckRun) GetHeadSHA() string
GetHeadSHA returns the HeadSHA field if it's non-nil, zero value otherwise.
func (c *CheckRun) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (c *CheckRun) GetName() string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (c *CheckRun) GetOutput() *CheckRunOutput
GetOutput returns the Output field.
func (c *CheckRun) GetStartedAt() Timestamp
GetStartedAt returns the StartedAt field if it's non-nil, zero value otherwise.
func (c *CheckRun) GetStatus() string
GetStatus returns the Status field if it's non-nil, zero value otherwise.
func (c *CheckRun) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (c CheckRun) String() string
type CheckRunAnnotation struct {
FileName *string `json:"filename,omitempty"`
BlobHRef *string `json:"blob_href,omitempty"`
StartLine *int `json:"start_line,omitempty"`
EndLine *int `json:"end_line,omitempty"`
WarningLevel *string `json:"warning_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 (c *CheckRunAnnotation) GetBlobHRef() string
GetBlobHRef returns the BlobHRef field if it's non-nil, zero value otherwise.
func (c *CheckRunAnnotation) GetEndLine() int
GetEndLine returns the EndLine field if it's non-nil, zero value otherwise.
func (c *CheckRunAnnotation) GetFileName() string
GetFileName returns the FileName field if it's non-nil, zero value otherwise.
func (c *CheckRunAnnotation) GetMessage() string
GetMessage returns the Message field if it's non-nil, zero value otherwise.
func (c *CheckRunAnnotation) GetRawDetails() string
GetRawDetails returns the RawDetails field if it's non-nil, zero value otherwise.
func (c *CheckRunAnnotation) GetStartLine() int
GetStartLine returns the StartLine field if it's non-nil, zero value otherwise.
func (c *CheckRunAnnotation) GetTitle() string
GetTitle returns the Title field if it's non-nil, zero value otherwise.
func (c *CheckRunAnnotation) GetWarningLevel() string
GetWarningLevel returns the WarningLevel field if it's non-nil, zero value otherwise.
type CheckRunEvent struct {
CheckRun *CheckRun `json:"check_run,omitempty"`
// The action performed. Can be "created", "updated" 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"`
}
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 (c *CheckRunEvent) GetAction() string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (c *CheckRunEvent) GetCheckRun() *CheckRun
GetCheckRun returns the CheckRun field.
func (c *CheckRunEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (c *CheckRunEvent) GetOrg() *Organization
GetOrg returns the Org field.
func (c *CheckRunEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (c *CheckRunEvent) GetSender() *User
GetSender returns the Sender field.
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 (c *CheckRunImage) GetAlt() string
GetAlt returns the Alt field if it's non-nil, zero value otherwise.
func (c *CheckRunImage) GetCaption() string
GetCaption returns the Caption field if it's non-nil, zero value otherwise.
func (c *CheckRunImage) GetImageURL() string
GetImageURL returns the ImageURL field if it's non-nil, zero value otherwise.
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 (c *CheckRunOutput) GetAnnotationsCount() int
GetAnnotationsCount returns the AnnotationsCount field if it's non-nil, zero value otherwise.
func (c *CheckRunOutput) GetAnnotationsURL() string
GetAnnotationsURL returns the AnnotationsURL field if it's non-nil, zero value otherwise.
func (c *CheckRunOutput) GetSummary() string
GetSummary returns the Summary field if it's non-nil, zero value otherwise.
func (c *CheckRunOutput) GetText() string
GetText returns the Text field if it's non-nil, zero value otherwise.
func (c *CheckRunOutput) GetTitle() string
GetTitle returns the Title field if it's non-nil, zero value otherwise.
type CheckSuite struct {
ID *int64 `json:"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 (c *CheckSuite) GetAfterSHA() string
GetAfterSHA returns the AfterSHA field if it's non-nil, zero value otherwise.
func (c *CheckSuite) GetApp() *App
GetApp returns the App field.
func (c *CheckSuite) GetBeforeSHA() string
GetBeforeSHA returns the BeforeSHA field if it's non-nil, zero value otherwise.
func (c *CheckSuite) GetConclusion() string
GetConclusion returns the Conclusion field if it's non-nil, zero value otherwise.
func (c *CheckSuite) GetHeadBranch() string
GetHeadBranch returns the HeadBranch field if it's non-nil, zero value otherwise.
func (c *CheckSuite) GetHeadSHA() string
GetHeadSHA returns the HeadSHA field if it's non-nil, zero value otherwise.
func (c *CheckSuite) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (c *CheckSuite) GetRepository() *Repository
GetRepository returns the Repository field.
func (c *CheckSuite) GetStatus() string
GetStatus returns the Status field if it's non-nil, zero value otherwise.
func (c *CheckSuite) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (c CheckSuite) String() string
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 (c *CheckSuiteEvent) GetAction() string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (c *CheckSuiteEvent) GetCheckSuite() *CheckSuite
GetCheckSuite returns the CheckSuite field.
func (c *CheckSuiteEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (c *CheckSuiteEvent) GetOrg() *Organization
GetOrg returns the Org field.
func (c *CheckSuiteEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (c *CheckSuiteEvent) GetSender() *User
GetSender returns the Sender field.
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 (c *CheckSuitePreferenceOptions) GetPreferenceList() *PreferenceList
GetPreferenceList returns the PreferenceList field.
type CheckSuitePreferenceResults struct {
Preferences *PreferenceList `json:"preferences,omitempty"`
Repository *Repository `json:"repository,omitempty"`
}
CheckSuitePreferenceResults represents the results of the preference set operation.
func (c *CheckSuitePreferenceResults) GetPreferences() *PreferenceList
GetPreferences returns the Preferences field.
func (c *CheckSuitePreferenceResults) GetRepository() *Repository
GetRepository returns the Repository field.
type ChecksService service
ChecksService provides access to the Checks API in the GitHub API.
GitHub API docs: https://developer.github.com/v3/checks/
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 (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 (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 (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 (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 (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 (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 (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 (s *ChecksService) RequestCheckSuite(ctx context.Context, owner, repo string, opt RequestCheckSuiteOptions) (*Response, error)
RequestCheckSuite triggers GitHub to create a new check suite, without pushing new code to a repository.
GitHub API docs: https://developer.github.com/v3/checks/suites/#request-check-suites
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 (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 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
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(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(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 (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 (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 (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 (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 (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 (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 (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/
Code:
package main
import (
"context"
"fmt"
"github.com/google/go-github/github"
)
func main() {
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 (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 (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 (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 (c *Client) RateLimits(ctx context.Context) (*RateLimits, *Response, error)
RateLimits returns the rate limits for the current client.
func (c *Client) Zen(ctx context.Context) (string, *Response, error)
Zen returns a random line from The Zen of GitHub.
see also: http://warpspire.com/posts/taste/
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 (c *CodeOfConduct) GetBody() string
GetBody returns the Body field if it's non-nil, zero value otherwise.
func (c *CodeOfConduct) GetKey() string
GetKey returns the Key field if it's non-nil, zero value otherwise.
func (c *CodeOfConduct) GetName() string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (c *CodeOfConduct) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (c *CodeOfConduct) String() string
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 (c *CodeResult) GetHTMLURL() string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (c *CodeResult) GetName() string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (c *CodeResult) GetPath() string
GetPath returns the Path field if it's non-nil, zero value otherwise.
func (c *CodeResult) GetRepository() *Repository
GetRepository returns the Repository field.
func (c *CodeResult) GetSHA() string
GetSHA returns the SHA field if it's non-nil, zero value otherwise.
func (c CodeResult) String() string
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 (c *CodeSearchResult) GetIncompleteResults() bool
GetIncompleteResults returns the IncompleteResults field if it's non-nil, zero value otherwise.
func (c *CodeSearchResult) GetTotal() int
GetTotal returns the Total field if it's non-nil, zero value otherwise.
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 (c *CombinedStatus) GetCommitURL() string
GetCommitURL returns the CommitURL field if it's non-nil, zero value otherwise.
func (c *CombinedStatus) GetName() string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (c *CombinedStatus) GetRepositoryURL() string
GetRepositoryURL returns the RepositoryURL field if it's non-nil, zero value otherwise.
func (c *CombinedStatus) GetSHA() string
GetSHA returns the SHA field if it's non-nil, zero value otherwise.
func (c *CombinedStatus) GetState() string
GetState returns the State field if it's non-nil, zero value otherwise.
func (c *CombinedStatus) GetTotalCount() int
GetTotalCount returns the TotalCount field if it's non-nil, zero value otherwise.
func (s CombinedStatus) String() string
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 (c *CommentStats) GetTotalCommitComments() int
GetTotalCommitComments returns the TotalCommitComments field if it's non-nil, zero value otherwise.
func (c *CommentStats) GetTotalGistComments() int
GetTotalGistComments returns the TotalGistComments field if it's non-nil, zero value otherwise.
func (c *CommentStats) GetTotalIssueComments() int
GetTotalIssueComments returns the TotalIssueComments field if it's non-nil, zero value otherwise.
func (c *CommentStats) GetTotalPullRequestComments() int
GetTotalPullRequestComments returns the TotalPullRequestComments field if it's non-nil, zero value otherwise.
func (s CommentStats) String() string
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 (c *Commit) GetAuthor() *CommitAuthor
GetAuthor returns the Author field.
func (c *Commit) GetCommentCount() int
GetCommentCount returns the CommentCount field if it's non-nil, zero value otherwise.
func (c *Commit) GetCommitter() *CommitAuthor
GetCommitter returns the Committer field.
func (c *Commit) GetHTMLURL() string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (c *Commit) GetMessage() string
GetMessage returns the Message field if it's non-nil, zero value otherwise.
func (c *Commit) GetNodeID() string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (c *Commit) GetSHA() string
GetSHA returns the SHA field if it's non-nil, zero value otherwise.
func (c *Commit) GetStats() *CommitStats
GetStats returns the Stats field.
func (c *Commit) GetTree() *Tree
GetTree returns the Tree field.
func (c *Commit) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (c *Commit) GetVerification() *SignatureVerification
GetVerification returns the Verification field.
func (c Commit) String() string
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 (c *CommitAuthor) GetDate() time.Time
GetDate returns the Date field if it's non-nil, zero value otherwise.
func (c *CommitAuthor) GetEmail() string
GetEmail returns the Email field if it's non-nil, zero value otherwise.
func (c *CommitAuthor) GetLogin() string
GetLogin returns the Login field if it's non-nil, zero value otherwise.
func (c *CommitAuthor) GetName() string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (c CommitAuthor) String() string
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 (c *CommitCommentEvent) GetAction() string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (c *CommitCommentEvent) GetComment() *RepositoryComment
GetComment returns the Comment field.
func (c *CommitCommentEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (c *CommitCommentEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (c *CommitCommentEvent) GetSender() *User
GetSender returns the Sender field.
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"`
}
CommitFile represents a file modified in a commit.
func (c *CommitFile) GetAdditions() int
GetAdditions returns the Additions field if it's non-nil, zero value otherwise.
func (c *CommitFile) GetBlobURL() string
GetBlobURL returns the BlobURL field if it's non-nil, zero value otherwise.
func (c *CommitFile) GetChanges() int
GetChanges returns the Changes field if it's non-nil, zero value otherwise.
func (c *CommitFile) GetContentsURL() string
GetContentsURL returns the ContentsURL field if it's non-nil, zero value otherwise.
func (c *CommitFile) GetDeletions() int
GetDeletions returns the Deletions field if it's non-nil, zero value otherwise.
func (c *CommitFile) GetFilename() string
GetFilename returns the Filename field if it's non-nil, zero value otherwise.
func (c *CommitFile) GetPatch() string
GetPatch returns the Patch field if it's non-nil, zero value otherwise.
func (c *CommitFile) GetRawURL() string
GetRawURL returns the RawURL field if it's non-nil, zero value otherwise.
func (c *CommitFile) GetSHA() string
GetSHA returns the SHA field if it's non-nil, zero value otherwise.
func (c *CommitFile) GetStatus() string
GetStatus returns the Status field if it's non-nil, zero value otherwise.
func (c CommitFile) String() string
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 (c *CommitResult) GetAuthor() *User
GetAuthor returns the Author field.
func (c *CommitResult) GetCommentsURL() string
GetCommentsURL returns the CommentsURL field if it's non-nil, zero value otherwise.
func (c *CommitResult) GetCommit() *Commit
GetCommit returns the Commit field.
func (c *CommitResult) GetCommitter() *User
GetCommitter returns the Committer field.
func (c *CommitResult) GetHTMLURL() string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (c *CommitResult) GetRepository() *Repository
GetRepository returns the Repository field.
func (c *CommitResult) GetSHA() string
GetSHA returns the SHA field if it's non-nil, zero value otherwise.
func (c *CommitResult) GetScore() *float64
GetScore returns the Score field.
func (c *CommitResult) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
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 (c *CommitStats) GetAdditions() int
GetAdditions returns the Additions field if it's non-nil, zero value otherwise.
func (c *CommitStats) GetDeletions() int
GetDeletions returns the Deletions field if it's non-nil, zero value otherwise.
func (c *CommitStats) GetTotal() int
GetTotal returns the Total field if it's non-nil, zero value otherwise.
func (c CommitStats) String() string
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 (c *CommitsComparison) GetAheadBy() int
GetAheadBy returns the AheadBy field if it's non-nil, zero value otherwise.
func (c *CommitsComparison) GetBaseCommit() *RepositoryCommit
GetBaseCommit returns the BaseCommit field.
func (c *CommitsComparison) GetBehindBy() int
GetBehindBy returns the BehindBy field if it's non-nil, zero value otherwise.
func (c *CommitsComparison) GetDiffURL() string
GetDiffURL returns the DiffURL field if it's non-nil, zero value otherwise.
func (c *CommitsComparison) GetHTMLURL() string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (c *CommitsComparison) GetMergeBaseCommit() *RepositoryCommit
GetMergeBaseCommit returns the MergeBaseCommit field.
func (c *CommitsComparison) GetPatchURL() string
GetPatchURL returns the PatchURL field if it's non-nil, zero value otherwise.
func (c *CommitsComparison) GetPermalinkURL() string
GetPermalinkURL returns the PermalinkURL field if it's non-nil, zero value otherwise.
func (c *CommitsComparison) GetStatus() string
GetStatus returns the Status field if it's non-nil, zero value otherwise.
func (c *CommitsComparison) GetTotalCommits() int
GetTotalCommits returns the TotalCommits field if it's non-nil, zero value otherwise.
func (c *CommitsComparison) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (c CommitsComparison) String() string
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 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 (c *CommitsSearchResult) GetIncompleteResults() bool
GetIncompleteResults returns the IncompleteResults field if it's non-nil, zero value otherwise.
func (c *CommitsSearchResult) GetTotal() int
GetTotal returns the Total field if it's non-nil, zero value otherwise.
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 (c *CommunityHealthFiles) GetCodeOfConduct() *Metric
GetCodeOfConduct returns the CodeOfConduct field.
func (c *CommunityHealthFiles) GetContributing() *Metric
GetContributing returns the Contributing field.
func (c *CommunityHealthFiles) GetIssueTemplate() *Metric
GetIssueTemplate returns the IssueTemplate field.
func (c *CommunityHealthFiles) GetLicense() *Metric
GetLicense returns the License field.
func (c *CommunityHealthFiles) GetPullRequestTemplate() *Metric
GetPullRequestTemplate returns the PullRequestTemplate field.
func (c *CommunityHealthFiles) GetReadme() *Metric
GetReadme returns the Readme field.
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 (c *CommunityHealthMetrics) GetFiles() *CommunityHealthFiles
GetFiles returns the Files field.
func (c *CommunityHealthMetrics) GetHealthPercentage() int
GetHealthPercentage returns the HealthPercentage field if it's non-nil, zero value otherwise.
func (c *CommunityHealthMetrics) GetUpdatedAt() time.Time
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
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 (c *Contributor) GetAvatarURL() string
GetAvatarURL returns the AvatarURL field if it's non-nil, zero value otherwise.
func (c *Contributor) GetContributions() int
GetContributions returns the Contributions field if it's non-nil, zero value otherwise.
func (c *Contributor) GetEventsURL() string
GetEventsURL returns the EventsURL field if it's non-nil, zero value otherwise.
func (c *Contributor) GetFollowersURL() string
GetFollowersURL returns the FollowersURL field if it's non-nil, zero value otherwise.
func (c *Contributor) GetFollowingURL() string
GetFollowingURL returns the FollowingURL field if it's non-nil, zero value otherwise.
func (c *Contributor) GetGistsURL() string
GetGistsURL returns the GistsURL field if it's non-nil, zero value otherwise.
func (c *Contributor) GetGravatarID() string
GetGravatarID returns the GravatarID field if it's non-nil, zero value otherwise.
func (c *Contributor) GetHTMLURL() string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (c *Contributor) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (c *Contributor) GetLogin() string
GetLogin returns the Login field if it's non-nil, zero value otherwise.
func (c *Contributor) GetOrganizationsURL() string
GetOrganizationsURL returns the OrganizationsURL field if it's non-nil, zero value otherwise.
func (c *Contributor) GetReceivedEventsURL() string
GetReceivedEventsURL returns the ReceivedEventsURL field if it's non-nil, zero value otherwise.
func (c *Contributor) GetReposURL() string
GetReposURL returns the ReposURL field if it's non-nil, zero value otherwise.
func (c *Contributor) GetSiteAdmin() bool
GetSiteAdmin returns the SiteAdmin field if it's non-nil, zero value otherwise.
func (c *Contributor) GetStarredURL() string
GetStarredURL returns the StarredURL field if it's non-nil, zero value otherwise.
func (c *Contributor) GetSubscriptionsURL() string
GetSubscriptionsURL returns the SubscriptionsURL field if it's non-nil, zero value otherwise.
func (c *Contributor) GetType() string
GetType returns the Type field if it's non-nil, zero value otherwise.
func (c *Contributor) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
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 (c *ContributorStats) GetAuthor() *Contributor
GetAuthor returns the Author field.
func (c *ContributorStats) GetTotal() int
GetTotal returns the Total field if it's non-nil, zero value otherwise.
func (c ContributorStats) String() string
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)
}
CreateCheckRunOptions sets up parameters needed to create a CheckRun.
func (c *CreateCheckRunOptions) GetCompletedAt() Timestamp
GetCompletedAt returns the CompletedAt field if it's non-nil, zero value otherwise.
func (c *CreateCheckRunOptions) GetConclusion() string
GetConclusion returns the Conclusion field if it's non-nil, zero value otherwise.
func (c *CreateCheckRunOptions) GetDetailsURL() string
GetDetailsURL returns the DetailsURL field if it's non-nil, zero value otherwise.
func (c *CreateCheckRunOptions) GetExternalID() string
GetExternalID returns the ExternalID field if it's non-nil, zero value otherwise.
func (c *CreateCheckRunOptions) GetOutput() *CheckRunOutput
GetOutput returns the Output field.
func (c *CreateCheckRunOptions) GetStartedAt() Timestamp
GetStartedAt returns the StartedAt field if it's non-nil, zero value otherwise.
func (c *CreateCheckRunOptions) GetStatus() string
GetStatus returns the Status field if it's non-nil, zero value otherwise.
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 (c *CreateCheckSuiteOptions) GetHeadBranch() string
GetHeadBranch returns the HeadBranch field if it's non-nil, zero value otherwise.
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 (c *CreateEvent) GetDescription() string
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (c *CreateEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (c *CreateEvent) GetMasterBranch() string
GetMasterBranch returns the MasterBranch field if it's non-nil, zero value otherwise.
func (c *CreateEvent) GetPusherType() string
GetPusherType returns the PusherType field if it's non-nil, zero value otherwise.
func (c *CreateEvent) GetRef() string
GetRef returns the Ref field if it's non-nil, zero value otherwise.
func (c *CreateEvent) GetRefType() string
GetRefType returns the RefType field if it's non-nil, zero value otherwise.
func (c *CreateEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (c *CreateEvent) GetSender() *User
GetSender returns the Sender field.
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 (c *CreateOrgInvitationOptions) GetEmail() string
GetEmail returns the Email field if it's non-nil, zero value otherwise.
func (c *CreateOrgInvitationOptions) GetInviteeID() int64
GetInviteeID returns the InviteeID field if it's non-nil, zero value otherwise.
func (c *CreateOrgInvitationOptions) GetRole() string
GetRole returns the Role field if it's non-nil, zero value otherwise.
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 (d *DeleteEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (d *DeleteEvent) GetPusherType() string
GetPusherType returns the PusherType field if it's non-nil, zero value otherwise.
func (d *DeleteEvent) GetRef() string
GetRef returns the Ref field if it's non-nil, zero value otherwise.
func (d *DeleteEvent) GetRefType() string
GetRefType returns the RefType field if it's non-nil, zero value otherwise.
func (d *DeleteEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (d *DeleteEvent) GetSender() *User
GetSender returns the Sender field.
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 (d *Deployment) GetCreatedAt() Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (d *Deployment) GetCreator() *User
GetCreator returns the Creator field.
func (d *Deployment) GetDescription() string
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (d *Deployment) GetEnvironment() string
GetEnvironment returns the Environment field if it's non-nil, zero value otherwise.
func (d *Deployment) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (d *Deployment) GetNodeID() string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (d *Deployment) GetRef() string
GetRef returns the Ref field if it's non-nil, zero value otherwise.
func (d *Deployment) GetRepositoryURL() string
GetRepositoryURL returns the RepositoryURL field if it's non-nil, zero value otherwise.
func (d *Deployment) GetSHA() string
GetSHA returns the SHA field if it's non-nil, zero value otherwise.
func (d *Deployment) GetStatusesURL() string
GetStatusesURL returns the StatusesURL field if it's non-nil, zero value otherwise.
func (d *Deployment) GetTask() string
GetTask returns the Task field if it's non-nil, zero value otherwise.
func (d *Deployment) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (d *Deployment) GetUpdatedAt() Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
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 (d *DeploymentEvent) GetDeployment() *Deployment
GetDeployment returns the Deployment field.
func (d *DeploymentEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (d *DeploymentEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (d *DeploymentEvent) GetSender() *User
GetSender returns the Sender field.
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 (d *DeploymentRequest) GetAutoMerge() bool
GetAutoMerge returns the AutoMerge field if it's non-nil, zero value otherwise.
func (d *DeploymentRequest) GetDescription() string
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (d *DeploymentRequest) GetEnvironment() string
GetEnvironment returns the Environment field if it's non-nil, zero value otherwise.
func (d *DeploymentRequest) GetPayload() string
GetPayload returns the Payload field if it's non-nil, zero value otherwise.
func (d *DeploymentRequest) GetProductionEnvironment() bool
GetProductionEnvironment returns the ProductionEnvironment field if it's non-nil, zero value otherwise.
func (d *DeploymentRequest) GetRef() string
GetRef returns the Ref field if it's non-nil, zero value otherwise.
func (d *DeploymentRequest) GetRequiredContexts() []string
GetRequiredContexts returns the RequiredContexts field if it's non-nil, zero value otherwise.
func (d *DeploymentRequest) GetTask() string
GetTask returns the Task field if it's non-nil, zero value otherwise.
func (d *DeploymentRequest) GetTransientEnvironment() bool
GetTransientEnvironment returns the TransientEnvironment field if it's non-nil, zero value otherwise.
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 (d *DeploymentStatus) GetCreatedAt() Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (d *DeploymentStatus) GetCreator() *User
GetCreator returns the Creator field.
func (d *DeploymentStatus) GetDeploymentURL() string
GetDeploymentURL returns the DeploymentURL field if it's non-nil, zero value otherwise.
func (d *DeploymentStatus) GetDescription() string
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (d *DeploymentStatus) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (d *DeploymentStatus) GetNodeID() string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (d *DeploymentStatus) GetRepositoryURL() string
GetRepositoryURL returns the RepositoryURL field if it's non-nil, zero value otherwise.
func (d *DeploymentStatus) GetState() string
GetState returns the State field if it's non-nil, zero value otherwise.
func (d *DeploymentStatus) GetTargetURL() string
GetTargetURL returns the TargetURL field if it's non-nil, zero value otherwise.
func (d *DeploymentStatus) GetUpdatedAt() Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
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 (d *DeploymentStatusEvent) GetDeployment() *Deployment
GetDeployment returns the Deployment field.
func (d *DeploymentStatusEvent) GetDeploymentStatus() *DeploymentStatus
GetDeploymentStatus returns the DeploymentStatus field.
func (d *DeploymentStatusEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (d *DeploymentStatusEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (d *DeploymentStatusEvent) GetSender() *User
GetSender returns the Sender field.
type DeploymentStatusRequest struct {
State *string `json:"state,omitempty"`
LogURL *string `json:"log_url,omitempty"`
Description *string `json:"description,omitempty"`
EnvironmentURL *string `json:"environment_url,omitempty"`
AutoInactive *bool `json:"auto_inactive,omitempty"`
}
DeploymentStatusRequest represents a deployment request
func (d *DeploymentStatusRequest) GetAutoInactive() bool
GetAutoInactive returns the AutoInactive field if it's non-nil, zero value otherwise.
func (d *DeploymentStatusRequest) GetDescription() string
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (d *DeploymentStatusRequest) GetEnvironmentURL() string
GetEnvironmentURL returns the EnvironmentURL field if it's non-nil, zero value otherwise.
func (d *DeploymentStatusRequest) GetLogURL() string
GetLogURL returns the LogURL field if it's non-nil, zero value otherwise.
func (d *DeploymentStatusRequest) GetState() string
GetState returns the State field if it's non-nil, zero value otherwise.
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 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"`
}
DiscussionComment represents a GitHub dicussion in a team.
func (d *DiscussionComment) GetAuthor() *User
GetAuthor returns the Author field.
func (d *DiscussionComment) GetBody() string
GetBody returns the Body field if it's non-nil, zero value otherwise.
func (d *DiscussionComment) GetBodyHTML() string
GetBodyHTML returns the BodyHTML field if it's non-nil, zero value otherwise.
func (d *DiscussionComment) GetBodyVersion() string
GetBodyVersion returns the BodyVersion field if it's non-nil, zero value otherwise.
func (d *DiscussionComment) GetCreatedAt() Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (d *DiscussionComment) GetDiscussionURL() string
GetDiscussionURL returns the DiscussionURL field if it's non-nil, zero value otherwise.
func (d *DiscussionComment) GetHTMLURL() string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (d *DiscussionComment) GetLastEditedAt() Timestamp
GetLastEditedAt returns the LastEditedAt field if it's non-nil, zero value otherwise.
func (d *DiscussionComment) GetNodeID() string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (d *DiscussionComment) GetNumber() int
GetNumber returns the Number field if it's non-nil, zero value otherwise.
func (d *DiscussionComment) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (d *DiscussionComment) GetUpdatedAt() Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (c DiscussionComment) String() string
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 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 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 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 (d *DismissalRestrictionsRequest) GetTeams() []string
GetTeams returns the Teams field if it's non-nil, zero value otherwise.
func (d *DismissalRestrictionsRequest) GetUsers() []string
GetUsers returns the Users field if it's non-nil, zero value otherwise.
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 (d *DraftReviewComment) GetBody() string
GetBody returns the Body field if it's non-nil, zero value otherwise.
func (d *DraftReviewComment) GetPath() string
GetPath returns the Path field if it's non-nil, zero value otherwise.
func (d *DraftReviewComment) GetPosition() int
GetPosition returns the Position field if it's non-nil, zero value otherwise.
func (c DraftReviewComment) String() string
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 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 (e *Error) Error() string
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 (r *ErrorResponse) Error() string
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 (e *Event) GetActor() *User
GetActor returns the Actor field.
func (e *Event) GetCreatedAt() time.Time
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (e *Event) GetID() string
GetID returns the ID field if it's non-nil, zero value otherwise.
func (e *Event) GetOrg() *Organization
GetOrg returns the Org field.
func (e *Event) GetPublic() bool
GetPublic returns the Public field if it's non-nil, zero value otherwise.
func (e *Event) GetRawPayload() json.RawMessage
GetRawPayload returns the RawPayload field if it's non-nil, zero value otherwise.
func (e *Event) GetRepo() *Repository
GetRepo returns the Repo field.
func (e *Event) GetType() string
GetType returns the Type field if it's non-nil, zero value otherwise.
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 (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 (e Event) String() string
type FeedLink struct {
HRef *string `json:"href,omitempty"`
Type *string `json:"type,omitempty"`
}
FeedLink represents a link to a related resource.
func (f *FeedLink) GetHRef() string
GetHRef returns the HRef field if it's non-nil, zero value otherwise.
func (f *FeedLink) GetType() string
GetType returns the Type field if it's non-nil, zero value otherwise.
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 (f *Feeds) GetCurrentUserActorURL() string
GetCurrentUserActorURL returns the CurrentUserActorURL field if it's non-nil, zero value otherwise.
func (f *Feeds) GetCurrentUserOrganizationURL() string
GetCurrentUserOrganizationURL returns the CurrentUserOrganizationURL field if it's non-nil, zero value otherwise.
func (f *Feeds) GetCurrentUserPublicURL() string
GetCurrentUserPublicURL returns the CurrentUserPublicURL field if it's non-nil, zero value otherwise.
func (f *Feeds) GetCurrentUserURL() string
GetCurrentUserURL returns the CurrentUserURL field if it's non-nil, zero value otherwise.
func (f *Feeds) GetTimelineURL() string
GetTimelineURL returns the TimelineURL field if it's non-nil, zero value otherwise.
func (f *Feeds) GetUserURL() string
GetUserURL returns the UserURL field if it's non-nil, zero value otherwise.
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 (f *ForkEvent) GetForkee() *Repository
GetForkee returns the Forkee field.
func (f *ForkEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (f *ForkEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (f *ForkEvent) GetSender() *User
GetSender returns the Sender field.
type GPGEmail struct {
Email *string `json:"email,omitempty"`
Verified *bool `json:"verified,omitempty"`
}
GPGEmail represents an email address associated to a GPG key.
func (g *GPGEmail) GetEmail() string
GetEmail returns the Email field if it's non-nil, zero value otherwise.
func (g *GPGEmail) GetVerified() bool
GetVerified returns the Verified field if it's non-nil, zero value otherwise.
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 (g *GPGKey) GetCanCertify() bool
GetCanCertify returns the CanCertify field if it's non-nil, zero value otherwise.
func (g *GPGKey) GetCanEncryptComms() bool
GetCanEncryptComms returns the CanEncryptComms field if it's non-nil, zero value otherwise.
func (g *GPGKey) GetCanEncryptStorage() bool
GetCanEncryptStorage returns the CanEncryptStorage field if it's non-nil, zero value otherwise.
func (g *GPGKey) GetCanSign() bool
GetCanSign returns the CanSign field if it's non-nil, zero value otherwise.
func (g *GPGKey) GetCreatedAt() time.Time
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (g *GPGKey) GetExpiresAt() time.Time
GetExpiresAt returns the ExpiresAt field if it's non-nil, zero value otherwise.
func (g *GPGKey) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (g *GPGKey) GetKeyID() string
GetKeyID returns the KeyID field if it's non-nil, zero value otherwise.
func (g *GPGKey) GetPrimaryKeyID() int64
GetPrimaryKeyID returns the PrimaryKeyID field if it's non-nil, zero value otherwise.
func (g *GPGKey) GetPublicKey() string
GetPublicKey returns the PublicKey field if it's non-nil, zero value otherwise.
func (k GPGKey) String() string
String stringifies a GPGKey.
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 (g *Gist) GetComments() int
GetComments returns the Comments field if it's non-nil, zero value otherwise.
func (g *Gist) GetCreatedAt() time.Time
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (g *Gist) GetDescription() string
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (g *Gist) GetGitPullURL() string
GetGitPullURL returns the GitPullURL field if it's non-nil, zero value otherwise.
func (g *Gist) GetGitPushURL() string
GetGitPushURL returns the GitPushURL field if it's non-nil, zero value otherwise.
func (g *Gist) GetHTMLURL() string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (g *Gist) GetID() string
GetID returns the ID field if it's non-nil, zero value otherwise.
func (g *Gist) GetNodeID() string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (g *Gist) GetOwner() *User
GetOwner returns the Owner field.
func (g *Gist) GetPublic() bool
GetPublic returns the Public field if it's non-nil, zero value otherwise.
func (g *Gist) GetUpdatedAt() time.Time
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (g Gist) String() string
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 (g *GistComment) GetBody() string
GetBody returns the Body field if it's non-nil, zero value otherwise.
func (g *GistComment) GetCreatedAt() time.Time
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (g *GistComment) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (g *GistComment) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (g *GistComment) GetUser() *User
GetUser returns the User field.
func (g GistComment) String() string
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 (g *GistCommit) GetChangeStatus() *CommitStats
GetChangeStatus returns the ChangeStatus field.
func (g *GistCommit) GetCommittedAt() Timestamp
GetCommittedAt returns the CommittedAt field if it's non-nil, zero value otherwise.
func (g *GistCommit) GetNodeID() string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (g *GistCommit) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (g *GistCommit) GetUser() *User
GetUser returns the User field.
func (g *GistCommit) GetVersion() string
GetVersion returns the Version field if it's non-nil, zero value otherwise.
func (gc GistCommit) String() string
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 (g *GistFile) GetContent() string
GetContent returns the Content field if it's non-nil, zero value otherwise.
func (g *GistFile) GetFilename() string
GetFilename returns the Filename field if it's non-nil, zero value otherwise.
func (g *GistFile) GetLanguage() string
GetLanguage returns the Language field if it's non-nil, zero value otherwise.
func (g *GistFile) GetRawURL() string
GetRawURL returns the RawURL field if it's non-nil, zero value otherwise.
func (g *GistFile) GetSize() int
GetSize returns the Size field if it's non-nil, zero value otherwise.
func (g *GistFile) GetType() string
GetType returns the Type field if it's non-nil, zero value otherwise.
func (g GistFile) String() string
type GistFilename string
GistFilename represents filename on a gist.
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 (g *GistFork) GetCreatedAt() Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (g *GistFork) GetID() string
GetID returns the ID field if it's non-nil, zero value otherwise.
func (g *GistFork) GetNodeID() string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (g *GistFork) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (g *GistFork) GetUpdatedAt() Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (g *GistFork) GetUser() *User
GetUser returns the User field.
func (gf GistFork) String() string
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 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 (g *GistStats) GetPrivateGists() int
GetPrivateGists returns the PrivateGists field if it's non-nil, zero value otherwise.
func (g *GistStats) GetPublicGists() int
GetPublicGists returns the PublicGists field if it's non-nil, zero value otherwise.
func (g *GistStats) GetTotalGists() int
GetTotalGists returns the TotalGists field if it's non-nil, zero value otherwise.
func (s GistStats) String() string
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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 GitObject struct {
Type *string `json:"type"`
SHA *string `json:"sha"`
URL *string `json:"url"`
}
GitObject represents a Git object.
func (g *GitObject) GetSHA() string
GetSHA returns the SHA field if it's non-nil, zero value otherwise.
func (g *GitObject) GetType() string
GetType returns the Type field if it's non-nil, zero value otherwise.
func (g *GitObject) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (o GitObject) String() string
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 (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 (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 (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 (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 (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 (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 (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 (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 (s *GitService) GetCommit(ctx context.Context, owner string, repo string, sha string) (*Commit, *Response, error)
GetCommit fetchs the Commit object for a given SHA.
GitHub API docs: https://developer.github.com/v3/git/commits/#get-a-commit
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 (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 (s *GitService) GetTag(ctx context.Context, owner string, repo string, sha string) (*Tag, *Response, error)
GetTag fetchs a tag from a repo given a SHA.
GitHub API docs: https://developer.github.com/v3/git/tags/#get-a-tag
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 (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 (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 struct {
Name *string `json:"name,omitempty"`
Source *string `json:"source,omitempty"`
}
Gitignore represents a .gitignore file as returned by the GitHub API.
func (g *Gitignore) GetName() string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (g *Gitignore) GetSource() string
GetSource returns the Source field if it's non-nil, zero value otherwise.
func (g Gitignore) String() string
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 (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 (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 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 (g *GollumEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (g *GollumEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (g *GollumEvent) GetSender() *User
GetSender returns the Sender field.
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 (g *Grant) GetApp() *AuthorizationApp
GetApp returns the App field.
func (g *Grant) GetCreatedAt() Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (g *Grant) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (g *Grant) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (g *Grant) GetUpdatedAt() Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (g Grant) String() string
type Hook struct {
CreatedAt *time.Time `json:"created_at,omitempty"`
UpdatedAt *time.Time `json:"updated_at,omitempty"`
Name *string `json:"name,omitempty"`
URL *string `json:"url,omitempty"`
Events []string `json:"events,omitempty"`
Active *bool `json:"active,omitempty"`
Config map[string]interface{} `json:"config,omitempty"`
ID *int64 `json:"id,omitempty"`
}
Hook represents a GitHub (web and service) hook for a repository.
func (h *Hook) GetActive() bool
GetActive returns the Active field if it's non-nil, zero value otherwise.
func (h *Hook) GetCreatedAt() time.Time
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (h *Hook) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (h *Hook) GetName() string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (h *Hook) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (h *Hook) GetUpdatedAt() time.Time
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (h Hook) String() string
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 (h *HookStats) GetActiveHooks() int
GetActiveHooks returns the ActiveHooks field if it's non-nil, zero value otherwise.
func (h *HookStats) GetInactiveHooks() int
GetInactiveHooks returns the InactiveHooks field if it's non-nil, zero value otherwise.
func (h *HookStats) GetTotalHooks() int
GetTotalHooks returns the TotalHooks field if it's non-nil, zero value otherwise.
func (s HookStats) String() string
type Hovercard struct {
Contexts []*UserContext `json:"contexts,omitempty"`
}
Hovercard represents hovercard information about a user.
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 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 (i *Import) GetAuthorsCount() int
GetAuthorsCount returns the AuthorsCount field if it's non-nil, zero value otherwise.
func (i *Import) GetAuthorsURL() string
GetAuthorsURL returns the AuthorsURL field if it's non-nil, zero value otherwise.
func (i *Import) GetCommitCount() int
GetCommitCount returns the CommitCount field if it's non-nil, zero value otherwise.
func (i *Import) GetFailedStep() string
GetFailedStep returns the FailedStep field if it's non-nil, zero value otherwise.
func (i *Import) GetHTMLURL() string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (i *Import) GetHasLargeFiles() bool
GetHasLargeFiles returns the HasLargeFiles field if it's non-nil, zero value otherwise.
func (i *Import) GetHumanName() string
GetHumanName returns the HumanName field if it's non-nil, zero value otherwise.
func (i *Import) GetLargeFilesCount() int
GetLargeFilesCount returns the LargeFilesCount field if it's non-nil, zero value otherwise.
func (i *Import) GetLargeFilesSize() int
GetLargeFilesSize returns the LargeFilesSize field if it's non-nil, zero value otherwise.
func (i *Import) GetMessage() string
GetMessage returns the Message field if it's non-nil, zero value otherwise.
func (i *Import) GetPercent() int
GetPercent returns the Percent field if it's non-nil, zero value otherwise.
func (i *Import) GetPushPercent() int
GetPushPercent returns the PushPercent field if it's non-nil, zero value otherwise.
func (i *Import) GetRepositoryURL() string
GetRepositoryURL returns the RepositoryURL field if it's non-nil, zero value otherwise.
func (i *Import) GetStatus() string
GetStatus returns the Status field if it's non-nil, zero value otherwise.
func (i *Import) GetStatusText() string
GetStatusText returns the StatusText field if it's non-nil, zero value otherwise.
func (i *Import) GetTFVCProject() string
GetTFVCProject returns the TFVCProject field if it's non-nil, zero value otherwise.
func (i *Import) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (i *Import) GetUseLFS() string
GetUseLFS returns the UseLFS field if it's non-nil, zero value otherwise.
func (i *Import) GetVCS() string
GetVCS returns the VCS field if it's non-nil, zero value otherwise.
func (i *Import) GetVCSPassword() string
GetVCSPassword returns the VCSPassword field if it's non-nil, zero value otherwise.
func (i *Import) GetVCSURL() string
GetVCSURL returns the VCSURL field if it's non-nil, zero value otherwise.
func (i *Import) GetVCSUsername() string
GetVCSUsername returns the VCSUsername field if it's non-nil, zero value otherwise.
func (i Import) String() string
type Installation struct {
ID *int64 `json:"id,omitempty"`
AppID *int64 `json:"app_id,omitempty"`
TargetID *int64 `json:"target_id,omitempty"`
Account *User `json:"account,omitempty"`
AccessTokensURL *string `json:"access_tokens_url,omitempty"`
RepositoriesURL *string `json:"repositories_url,omitempty"`
HTMLURL *string `json:"html_url,omitempty"`
TargetType *string `json:"target_type,omitempty"`
SingleFileName *string `json:"single_file_name,omitempty"`
RepositorySelection *string `json:"repository_selection,omitempty"`
Events []string `json:"events,omitempty"`
Permissions *InstallationPermissions `json:"permissions,omitempty"`
CreatedAt *Timestamp `json:"created_at,omitempty"`
UpdatedAt *Timestamp `json:"updated_at,omitempty"`
}
Installation represents a GitHub Apps installation.
func (i *Installation) GetAccessTokensURL() string
GetAccessTokensURL returns the AccessTokensURL field if it's non-nil, zero value otherwise.
func (i *Installation) GetAccount() *User
GetAccount returns the Account field.
func (i *Installation) GetAppID() int64
GetAppID returns the AppID field if it's non-nil, zero value otherwise.
func (i *Installation) GetCreatedAt() Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (i *Installation) GetHTMLURL() string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (i *Installation) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (i *Installation) GetPermissions() *InstallationPermissions
GetPermissions returns the Permissions field.
func (i *Installation) GetRepositoriesURL() string
GetRepositoriesURL returns the RepositoriesURL field if it's non-nil, zero value otherwise.
func (i *Installation) GetRepositorySelection() string
GetRepositorySelection returns the RepositorySelection field if it's non-nil, zero value otherwise.
func (i *Installation) GetSingleFileName() string
GetSingleFileName returns the SingleFileName field if it's non-nil, zero value otherwise.
func (i *Installation) GetTargetID() int64
GetTargetID returns the TargetID field if it's non-nil, zero value otherwise.
func (i *Installation) GetTargetType() string
GetTargetType returns the TargetType field if it's non-nil, zero value otherwise.
func (i *Installation) GetUpdatedAt() Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (i Installation) String() string
type InstallationEvent struct {
// The action that was performed. Can be either "created" or "deleted".
Action *string `json:"action,omitempty"`
Repositories []*Repository `json:"repositories,omitempty"`
Sender *User `json:"sender,omitempty"`
Installation *Installation `json:"installation,omitempty"`
}
InstallationEvent is triggered when a GitHub App has been installed or uninstalled. The Webhook event name is "installation".
GitHub API docs: https://developer.github.com/v3/activity/events/types/#installationevent
func (i *InstallationEvent) GetAction() string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (i *InstallationEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (i *InstallationEvent) GetSender() *User
GetSender returns the Sender field.
type InstallationPermissions struct {
Metadata *string `json:"metadata,omitempty"`
Contents *string `json:"contents,omitempty"`
Issues *string `json:"issues,omitempty"`
SingleFile *string `json:"single_file,omitempty"`
}
InstallationPermissions lists the permissions for metadata, contents, issues and single file for an installation.
func (i *InstallationPermissions) GetContents() string
GetContents returns the Contents field if it's non-nil, zero value otherwise.
func (i *InstallationPermissions) GetIssues() string
GetIssues returns the Issues field if it's non-nil, zero value otherwise.
func (i *InstallationPermissions) GetMetadata() string
GetMetadata returns the Metadata field if it's non-nil, zero value otherwise.
func (i *InstallationPermissions) GetSingleFile() string
GetSingleFile returns the SingleFile field if it's non-nil, zero value otherwise.
type InstallationRepositoriesEvent struct {
// The action that was performed. Can be either "added" or "removed".
Action *string `json:"action,omitempty"`
RepositoriesAdded []*Repository `json:"repositories_added,omitempty"`
RepositoriesRemoved []*Repository `json:"repositories_removed,omitempty"`
RepositorySelection *string `json:"repository_selection,omitempty"`
Sender *User `json:"sender,omitempty"`
Installation *Installation `json:"installation,omitempty"`
}
InstallationRepositoriesEvent is triggered when a repository is added or removed from an installation. The Webhook event name is "installation_repositories".
GitHub API docs: https://developer.github.com/v3/activity/events/types/#installationrepositoriesevent
func (i *InstallationRepositoriesEvent) GetAction() string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (i *InstallationRepositoriesEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (i *InstallationRepositoriesEvent) GetRepositorySelection() string
GetRepositorySelection returns the RepositorySelection field if it's non-nil, zero value otherwise.
func (i *InstallationRepositoriesEvent) GetSender() *User
GetSender returns the Sender field.
type InstallationToken struct {
Token *string `json:"token,omitempty"`
ExpiresAt *time.Time `json:"expires_at,omitempty"`
}
InstallationToken represents an installation token.
func (i *InstallationToken) GetExpiresAt() time.Time
GetExpiresAt returns the ExpiresAt field if it's non-nil, zero value otherwise.
func (i *InstallationToken) GetToken() string
GetToken returns the Token field if it's non-nil, zero value otherwise.
type Invitation struct {
ID *int64 `json:"id,omitempty"`
Login *string `json:"login,omitempty"`
Email *string `json:"email,omitempty"`
// Role can be one of the values - 'direct_member', 'admin', 'billing_manager', 'hiring_manager', or 'reinstate'.
Role *string `json:"role,omitempty"`
CreatedAt *time.Time `json:"created_at,omitempty"`
Inviter *User `json:"inviter,omitempty"`
TeamCount *int `json:"team_count,omitempty"`
InvitationTeamURL *string `json:"invitation_team_url,omitempty"`
}
Invitation represents a team member's invitation status.
func (i *Invitation) GetCreatedAt() time.Time
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (i *Invitation) GetEmail() string
GetEmail returns the Email field if it's non-nil, zero value otherwise.
func (i *Invitation) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (i *Invitation) GetInvitationTeamURL() string
GetInvitationTeamURL returns the InvitationTeamURL field if it's non-nil, zero value otherwise.
func (i *Invitation) GetInviter() *User
GetInviter returns the Inviter field.
func (i *Invitation) GetLogin() string
GetLogin returns the Login field if it's non-nil, zero value otherwise.
func (i *Invitation) GetRole() string
GetRole returns the Role field if it's non-nil, zero value otherwise.
func (i *Invitation) GetTeamCount() int
GetTeamCount returns the TeamCount field if it's non-nil, zero value otherwise.
func (i Invitation) String() string
type Issue struct {
ID *int64 `json:"id,omitempty"`
Number *int `json:"number,omitempty"`
State *string `json:"state,omitempty"`
Locked *bool `json:"locked,omitempty"`
Title *string `json:"title,omitempty"`
Body *string `json:"body,omitempty"`
User *User `json:"user,omitempty"`
Labels []Label `json:"labels,omitempty"`
Assignee *User `json:"assignee,omitempty"`
Comments *int `json:"comments,omitempty"`
ClosedAt *time.Time `json:"closed_at,omitempty"`
CreatedAt *time.Time `json:"created_at,omitempty"`
UpdatedAt *time.Time `json:"updated_at,omitempty"`
ClosedBy *User `json:"closed_by,omitempty"`
URL *string `json:"url,omitempty"`
HTMLURL *string `json:"html_url,omitempty"`
CommentsURL *string `json:"comments_url,omitempty"`
EventsURL *string `json:"events_url,omitempty"`
LabelsURL *string `json:"labels_url,omitempty"`
RepositoryURL *string `json:"repository_url,omitempty"`
Milestone *Milestone `json:"milestone,omitempty"`
PullRequestLinks *PullRequestLinks `json:"pull_request,omitempty"`
Repository *Repository `json:"repository,omitempty"`
Reactions *Reactions `json:"reactions,omitempty"`
Assignees []*User `json:"assignees,omitempty"`
NodeID *string `json:"node_id,omitempty"`
// TextMatches is only populated from search results that request text matches
// See: search.go and https://developer.github.com/v3/search/#text-match-metadata
TextMatches []TextMatch `json:"text_matches,omitempty"`
// ActiveLockReason is populated only when LockReason is provided while locking the issue.
// Possible values are: "off-topic", "too heated", "resolved", and "spam".
ActiveLockReason *string `json:"active_lock_reason,omitempty"`
}
Issue represents a GitHub issue on a repository.
Note: As far as the GitHub API is concerned, every pull request is an issue, but not every issue is a pull request. Some endpoints, events, and webhooks may also return pull requests via this struct. If PullRequestLinks is nil, this is an issue, and if PullRequestLinks is not nil, this is a pull request. The IsPullRequest helper method can be used to check that.
func (i *Issue) GetActiveLockReason() string
GetActiveLockReason returns the ActiveLockReason field if it's non-nil, zero value otherwise.
func (i *Issue) GetAssignee() *User
GetAssignee returns the Assignee field.
func (i *Issue) GetBody() string
GetBody returns the Body field if it's non-nil, zero value otherwise.
func (i *Issue) GetClosedAt() time.Time
GetClosedAt returns the ClosedAt field if it's non-nil, zero value otherwise.
func (i *Issue) GetClosedBy() *User
GetClosedBy returns the ClosedBy field.
func (i *Issue) GetComments() int
GetComments returns the Comments field if it's non-nil, zero value otherwise.
func (i *Issue) GetCommentsURL() string
GetCommentsURL returns the CommentsURL field if it's non-nil, zero value otherwise.
func (i *Issue) GetCreatedAt() time.Time
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (i *Issue) GetEventsURL() string
GetEventsURL returns the EventsURL field if it's non-nil, zero value otherwise.
func (i *Issue) GetHTMLURL() string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (i *Issue) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (i *Issue) GetLabelsURL() string
GetLabelsURL returns the LabelsURL field if it's non-nil, zero value otherwise.
func (i *Issue) GetLocked() bool
GetLocked returns the Locked field if it's non-nil, zero value otherwise.
func (i *Issue) GetMilestone() *Milestone
GetMilestone returns the Milestone field.
func (i *Issue) GetNodeID() string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (i *Issue) GetNumber() int
GetNumber returns the Number field if it's non-nil, zero value otherwise.
func (i *Issue) GetPullRequestLinks() *PullRequestLinks
GetPullRequestLinks returns the PullRequestLinks field.
func (i *Issue) GetReactions() *Reactions
GetReactions returns the Reactions field.
func (i *Issue) GetRepository() *Repository
GetRepository returns the Repository field.
func (i *Issue) GetRepositoryURL() string
GetRepositoryURL returns the RepositoryURL field if it's non-nil, zero value otherwise.
func (i *Issue) GetState() string
GetState returns the State field if it's non-nil, zero value otherwise.
func (i *Issue) GetTitle() string
GetTitle returns the Title field if it's non-nil, zero value otherwise.
func (i *Issue) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (i *Issue) GetUpdatedAt() time.Time
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (i *Issue) GetUser() *User
GetUser returns the User field.
func (i Issue) IsPullRequest() bool
IsPullRequest reports whether the issue is also a pull request. It uses the method recommended by GitHub's API documentation, which is to check whether PullRequestLinks is non-nil.
func (i Issue) String() string
type IssueComment struct {
ID *int64 `json:"id,omitempty"`
Body *string `json:"body,omitempty"`
User *User `json:"user,omitempty"`
Reactions *Reactions `json:"reactions,omitempty"`
CreatedAt *time.Time `json:"created_at,omitempty"`
UpdatedAt *time.Time `json:"updated_at,omitempty"`
// AuthorAssociation is the comment author's relationship to the issue's repository.
// Possible values are "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MEMBER", "OWNER", or "NONE".
AuthorAssociation *string `json:"author_association,omitempty"`
URL *string `json:"url,omitempty"`
HTMLURL *string `json:"html_url,omitempty"`
IssueURL *string `json:"issue_url,omitempty"`
}
IssueComment represents a comment left on an issue.
func (i *IssueComment) GetAuthorAssociation() string
GetAuthorAssociation returns the AuthorAssociation field if it's non-nil, zero value otherwise.
func (i *IssueComment) GetBody() string
GetBody returns the Body field if it's non-nil, zero value otherwise.
func (i *IssueComment) GetCreatedAt() time.Time
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (i *IssueComment) GetHTMLURL() string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (i *IssueComment) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (i *IssueComment) GetIssueURL() string
GetIssueURL returns the IssueURL field if it's non-nil, zero value otherwise.
func (i *IssueComment) GetReactions() *Reactions
GetReactions returns the Reactions field.
func (i *IssueComment) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (i *IssueComment) GetUpdatedAt() time.Time
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (i *IssueComment) GetUser() *User
GetUser returns the User field.
func (i IssueComment) String() string
type IssueCommentEvent struct {
// Action is the action that was performed on the comment.
// Possible values are: "created", "edited", "deleted".
Action *string `json:"action,omitempty"`
Issue *Issue `json:"issue,omitempty"`
Comment *IssueComment `json:"comment,omitempty"`
// The following fields are only populated by Webhook events.
Changes *EditChange `json:"changes,omitempty"`
Repo *Repository `json:"repository,omitempty"`
Sender *User `json:"sender,omitempty"`
Installation *Installation `json:"installation,omitempty"`
}
IssueCommentEvent is triggered when an issue comment is created on an issue or pull request. The Webhook event name is "issue_comment".
GitHub API docs: https://developer.github.com/v3/activity/events/types/#issuecommentevent
func (i *IssueCommentEvent) GetAction() string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (i *IssueCommentEvent) GetChanges() *EditChange
GetChanges returns the Changes field.
func (i *IssueCommentEvent) GetComment() *IssueComment
GetComment returns the Comment field.
func (i *IssueCommentEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (i *IssueCommentEvent) GetIssue() *Issue
GetIssue returns the Issue field.
func (i *IssueCommentEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (i *IssueCommentEvent) GetSender() *User
GetSender returns the Sender field.
type IssueEvent struct {
ID *int64 `json:"id,omitempty"`
URL *string `json:"url,omitempty"`
// The User that generated this event.
Actor *User `json:"actor,omitempty"`
// Event identifies the actual type of Event that occurred. Possible
// values are:
//
// closed
// The Actor closed the issue.
// If the issue was closed by commit message, CommitID holds the SHA1 hash of the commit.
//
// merged
// The Actor merged into master a branch containing a commit mentioning the issue.
// CommitID holds the SHA1 of the merge commit.
//
// referenced
// The Actor committed to master a commit mentioning the issue in its commit message.
// CommitID holds the SHA1 of the commit.
//
// reopened, unlocked
// The Actor did that to the issue.
//
// locked
// The Actor locked the issue.
// LockReason holds the reason of locking the issue (if provided while locking).
//
// renamed
// The Actor changed the issue title from Rename.From to Rename.To.
//
// mentioned
// Someone unspecified @mentioned the Actor [sic] in an issue comment body.
//
// assigned, unassigned
// The Assigner assigned the issue to or removed the assignment from the Assignee.
//
// labeled, unlabeled
// The Actor added or removed the Label from the issue.
//
// milestoned, demilestoned
// The Actor added or removed the issue from the Milestone.
//
// subscribed, unsubscribed
// The Actor subscribed to or unsubscribed from notifications for an issue.
//
// head_ref_deleted, head_ref_restored
// The pull request’s branch was deleted or restored.
//
Event *string `json:"event,omitempty"`
CreatedAt *time.Time `json:"created_at,omitempty"`
Issue *Issue `json:"issue,omitempty"`
// Only present on certain events; see above.
Assignee *User `json:"assignee,omitempty"`
Assigner *User `json:"assigner,omitempty"`
CommitID *string `json:"commit_id,omitempty"`
Milestone *Milestone `json:"milestone,omitempty"`
Label *Label `json:"label,omitempty"`
Rename *Rename `json:"rename,omitempty"`
LockReason *string `json:"lock_reason,omitempty"`
}
IssueEvent represents an event that occurred around an Issue or Pull Request.
func (i *IssueEvent) GetActor() *User
GetActor returns the Actor field.
func (i *IssueEvent) GetAssignee() *User
GetAssignee returns the Assignee field.
func (i *IssueEvent) GetAssigner() *User
GetAssigner returns the Assigner field.
func (i *IssueEvent) GetCommitID() string
GetCommitID returns the CommitID field if it's non-nil, zero value otherwise.
func (i *IssueEvent) GetCreatedAt() time.Time
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (i *IssueEvent) GetEvent() string
GetEvent returns the Event field if it's non-nil, zero value otherwise.
func (i *IssueEvent) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (i *IssueEvent) GetIssue() *Issue
GetIssue returns the Issue field.
func (i *IssueEvent) GetLabel() *Label
GetLabel returns the Label field.
func (i *IssueEvent) GetLockReason() string
GetLockReason returns the LockReason field if it's non-nil, zero value otherwise.
func (i *IssueEvent) GetMilestone() *Milestone
GetMilestone returns the Milestone field.
func (i *IssueEvent) GetRename() *Rename
GetRename returns the Rename field.
func (i *IssueEvent) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
type IssueListByRepoOptions struct {
// Milestone limits issues for the specified milestone. Possible values are
// a milestone number, "none" for issues with no milestone, "*" for issues
// with any milestone.
Milestone string `url:"milestone,omitempty"`
// State filters issues based on their state. Possible values are: open,
// closed, all. Default is "open".
State string `url:"state,omitempty"`
// Assignee filters issues based on their assignee. Possible values are a
// user name, "none" for issues that are not assigned, "*" for issues with
// any assigned user.
Assignee string `url:"assignee,omitempty"`
// Creator filters issues based on their creator.
Creator string `url:"creator,omitempty"`
// Mentioned filters issues to those mentioned a specific user.
Mentioned string `url:"mentioned,omitempty"`
// Labels filters issues based on their label.
Labels []string `url:"labels,omitempty,comma"`
// Sort specifies how to sort issues. Possible values are: created, updated,
// and comments. Default value is "created".
Sort string `url:"sort,omitempty"`
// Direction in which to sort issues. Possible values are: asc, desc.
// Default is "desc".
Direction string `url:"direction,omitempty"`
// Since filters issues by time.
Since time.Time `url:"since,omitempty"`
ListOptions
}
IssueListByRepoOptions specifies the optional parameters to the IssuesService.ListByRepo method.
type IssueListCommentsOptions struct {
// Sort specifies how to sort comments. Possible values are: created, updated.
Sort string `url:"sort,omitempty"`
// Direction in which to sort comments. Possible values are: asc, desc.
Direction string `url:"direction,omitempty"`
// Since filters comments by time.
Since time.Time `url:"since,omitempty"`
ListOptions
}
IssueListCommentsOptions specifies the optional parameters to the IssuesService.ListComments method.
type IssueListOptions struct {
// Filter specifies which issues to list. Possible values are: assigned,
// created, mentioned, subscribed, all. Default is "assigned".
Filter string `url:"filter,omitempty"`
// State filters issues based on their state. Possible values are: open,
// closed, all. Default is "open".
State string `url:"state,omitempty"`
// Labels filters issues based on their label.
Labels []string `url:"labels,comma,omitempty"`
// Sort specifies how to sort issues. Possible values are: created, updated,
// and comments. Default value is "created".
Sort string `url:"sort,omitempty"`
// Direction in which to sort issues. Possible values are: asc, desc.
// Default is "desc".
Direction string `url:"direction,omitempty"`
// Since filters issues by time.
Since time.Time `url:"since,omitempty"`
ListOptions
}
IssueListOptions specifies the optional parameters to the IssuesService.List and IssuesService.ListByOrg methods.
type IssueRequest struct {
Title *string `json:"title,omitempty"`
Body *string `json:"body,omitempty"`
Labels *[]string `json:"labels,omitempty"`
Assignee *string `json:"assignee,omitempty"`
State *string `json:"state,omitempty"`
Milestone *int `json:"milestone,omitempty"`
Assignees *[]string `json:"assignees,omitempty"`
}
IssueRequest represents a request to create/edit an issue. It is separate from Issue above because otherwise Labels and Assignee fail to serialize to the correct JSON.
func (i *IssueRequest) GetAssignee() string
GetAssignee returns the Assignee field if it's non-nil, zero value otherwise.
func (i *IssueRequest) GetAssignees() []string
GetAssignees returns the Assignees field if it's non-nil, zero value otherwise.
func (i *IssueRequest) GetBody() string
GetBody returns the Body field if it's non-nil, zero value otherwise.
func (i *IssueRequest) GetLabels() []string
GetLabels returns the Labels field if it's non-nil, zero value otherwise.
func (i *IssueRequest) GetMilestone() int
GetMilestone returns the Milestone field if it's non-nil, zero value otherwise.
func (i *IssueRequest) GetState() string
GetState returns the State field if it's non-nil, zero value otherwise.
func (i *IssueRequest) GetTitle() string
GetTitle returns the Title field if it's non-nil, zero value otherwise.
type IssueStats struct {
TotalIssues *int `json:"total_issues,omitempty"`
OpenIssues *int `json:"open_issues,omitempty"`
ClosedIssues *int `json:"closed_issues,omitempty"`
}
IssueStats represents the number of total, open and closed issues.
func (i *IssueStats) GetClosedIssues() int
GetClosedIssues returns the ClosedIssues field if it's non-nil, zero value otherwise.
func (i *IssueStats) GetOpenIssues() int
GetOpenIssues returns the OpenIssues field if it's non-nil, zero value otherwise.
func (i *IssueStats) GetTotalIssues() int
GetTotalIssues returns the TotalIssues field if it's non-nil, zero value otherwise.
func (s IssueStats) String() string
type IssuesEvent struct {
// Action is the action that was performed. Possible values are: "assigned",
// "unassigned", "labeled", "unlabeled", "opened", "closed", "reopened", "edited".
Action *string `json:"action,omitempty"`
Issue *Issue `json:"issue,omitempty"`
Assignee *User `json:"assignee,omitempty"`
Label *Label `json:"label,omitempty"`
// The following fields are only populated by Webhook events.
Changes *EditChange `json:"changes,omitempty"`
Repo *Repository `json:"repository,omitempty"`
Sender *User `json:"sender,omitempty"`
Installation *Installation `json:"installation,omitempty"`
}
IssuesEvent is triggered when an issue is assigned, unassigned, labeled, unlabeled, opened, closed, or reopened. The Webhook event name is "issues".
GitHub API docs: https://developer.github.com/v3/activity/events/types/#issuesevent
func (i *IssuesEvent) GetAction() string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (i *IssuesEvent) GetAssignee() *User
GetAssignee returns the Assignee field.
func (i *IssuesEvent) GetChanges() *EditChange
GetChanges returns the Changes field.
func (i *IssuesEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (i *IssuesEvent) GetIssue() *Issue
GetIssue returns the Issue field.
func (i *IssuesEvent) GetLabel() *Label
GetLabel returns the Label field.
func (i *IssuesEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (i *IssuesEvent) GetSender() *User
GetSender returns the Sender field.
type IssuesSearchResult struct {
Total *int `json:"total_count,omitempty"`
IncompleteResults *bool `json:"incomplete_results,omitempty"`
Issues []Issue `json:"items,omitempty"`
}
IssuesSearchResult represents the result of an issues search.
func (i *IssuesSearchResult) GetIncompleteResults() bool
GetIncompleteResults returns the IncompleteResults field if it's non-nil, zero value otherwise.
func (i *IssuesSearchResult) GetTotal() int
GetTotal returns the Total field if it's non-nil, zero value otherwise.
type IssuesService service
IssuesService handles communication with the issue related methods of the GitHub API.
GitHub API docs: https://developer.github.com/v3/issues/
func (s *IssuesService) AddAssignees(ctx context.Context, owner, repo string, number int, assignees []string) (*Issue, *Response, error)
AddAssignees adds the provided GitHub users as assignees to the issue.
GitHub API docs: https://developer.github.com/v3/issues/assignees/#add-assignees-to-an-issue
func (s *IssuesService) AddLabelsToIssue(ctx context.Context, owner string, repo string, number int, labels []string) ([]*Label, *Response, error)
AddLabelsToIssue adds labels to an issue.
GitHub API docs: https://developer.github.com/v3/issues/labels/#add-labels-to-an-issue
func (s *IssuesService) Create(ctx context.Context, owner string, repo string, issue *IssueRequest) (*Issue, *Response, error)
Create a new issue on the specified repository.
GitHub API docs: https://developer.github.com/v3/issues/#create-an-issue
func (s *IssuesService) CreateComment(ctx context.Context, owner string, repo string, number int, comment *IssueComment) (*IssueComment, *Response, error)
CreateComment creates a new comment on the specified issue.
GitHub API docs: https://developer.github.com/v3/issues/comments/#create-a-comment
func (s *IssuesService) CreateLabel(ctx context.Context, owner string, repo string, label *Label) (*Label, *Response, error)
CreateLabel creates a new label on the specified repository.
GitHub API docs: https://developer.github.com/v3/issues/labels/#create-a-label
func (s *IssuesService) CreateMilestone(ctx context.Context, owner string, repo string, milestone *Milestone) (*Milestone, *Response, error)
CreateMilestone creates a new milestone on the specified repository.
GitHub API docs: https://developer.github.com/v3/issues/milestones/#create-a-milestone
func (s *IssuesService) DeleteComment(ctx context.Context, owner string, repo string, commentID int64) (*Response, error)
DeleteComment deletes an issue comment.
GitHub API docs: https://developer.github.com/v3/issues/comments/#delete-a-comment
func (s *IssuesService) DeleteLabel(ctx context.Context, owner string, repo string, name string) (*Response, error)
DeleteLabel deletes a label.
GitHub API docs: https://developer.github.com/v3/issues/labels/#delete-a-label
func (s *IssuesService) DeleteMilestone(ctx context.Context, owner string, repo string, number int) (*Response, error)
DeleteMilestone deletes a milestone.
GitHub API docs: https://developer.github.com/v3/issues/milestones/#delete-a-milestone
func (s *IssuesService) Edit(ctx context.Context, owner string, repo string, number int, issue *IssueRequest) (*Issue, *Response, error)
Edit an issue.
GitHub API docs: https://developer.github.com/v3/issues/#edit-an-issue
func (s *IssuesService) EditComment(ctx context.Context, owner string, repo string, commentID int64, comment *IssueComment) (*IssueComment, *Response, error)
EditComment updates an issue comment. A non-nil comment.Body must be provided. Other comment fields should be left nil.
GitHub API docs: https://developer.github.com/v3/issues/comments/#edit-a-comment
func (s *IssuesService) EditLabel(ctx context.Context, owner string, repo string, name string, label *Label) (*Label, *Response, error)
EditLabel edits a label.
GitHub API docs: https://developer.github.com/v3/issues/labels/#update-a-label
func (s *IssuesService) EditMilestone(ctx context.Context, owner string, repo string, number int, milestone *Milestone) (*Milestone, *Response, error)
EditMilestone edits a milestone.
GitHub API docs: https://developer.github.com/v3/issues/milestones/#update-a-milestone
func (s *IssuesService) Get(ctx context.Context, owner string, repo string, number int) (*Issue, *Response, error)
Get a single issue.
GitHub API docs: https://developer.github.com/v3/issues/#get-a-single-issue
func (s *IssuesService) GetComment(ctx context.Context, owner string, repo string, commentID int64) (*IssueComment, *Response, error)
GetComment fetches the specified issue comment.
GitHub API docs: https://developer.github.com/v3/issues/comments/#get-a-single-comment
func (s *IssuesService) GetEvent(ctx context.Context, owner, repo string, id int64) (*IssueEvent, *Response, error)
GetEvent returns the specified issue event.
GitHub API docs: https://developer.github.com/v3/issues/events/#get-a-single-event
func (s *IssuesService) GetLabel(ctx context.Context, owner string, repo string, name string) (*Label, *Response, error)
GetLabel gets a single label.
GitHub API docs: https://developer.github.com/v3/issues/labels/#get-a-single-label
func (s *IssuesService) GetMilestone(ctx context.Context, owner string, repo string, number int) (*Milestone, *Response, error)
GetMilestone gets a single milestone.
GitHub API docs: https://developer.github.com/v3/issues/milestones/#get-a-single-milestone
func (s *IssuesService) IsAssignee(ctx context.Context, owner, repo, user string) (bool, *Response, error)
IsAssignee checks if a user is an assignee for the specified repository.
GitHub API docs: https://developer.github.com/v3/issues/assignees/#check-assignee
func (s *IssuesService) List(ctx context.Context, all bool, opt *IssueListOptions) ([]*Issue, *Response, error)
List the issues for the authenticated user. If all is true, list issues across all the user's visible repositories including owned, member, and organization repositories; if false, list only owned and member repositories.
GitHub API docs: https://developer.github.com/v3/issues/#list-issues
func (s *IssuesService) ListAssignees(ctx context.Context, owner, repo string, opt *ListOptions) ([]*User, *Response, error)
ListAssignees fetches all available assignees (owners and collaborators) to which issues may be assigned.
GitHub API docs: https://developer.github.com/v3/issues/assignees/#list-assignees
func (s *IssuesService) ListByOrg(ctx context.Context, org string, opt *IssueListOptions) ([]*Issue, *Response, error)
ListByOrg fetches the issues in the specified organization for the authenticated user.
GitHub API docs: https://developer.github.com/v3/issues/#list-issues
func (s *IssuesService) ListByRepo(ctx context.Context, owner string, repo string, opt *IssueListByRepoOptions) ([]*Issue, *Response, error)
ListByRepo lists the issues for the specified repository.
GitHub API docs: https://developer.github.com/v3/issues/#list-issues-for-a-repository
func (s *IssuesService) ListComments(ctx context.Context, owner string, repo string, number int, opt *IssueListCommentsOptions) ([]*IssueComment, *Response, error)
ListComments lists all comments on the specified issue. Specifying an issue number of 0 will return all comments on all issues for the repository.
GitHub API docs: https://developer.github.com/v3/issues/comments/#list-comments-on-an-issue
func (s *IssuesService) ListIssueEvents(ctx context.Context, owner, repo string, number int, opt *ListOptions) ([]*IssueEvent, *Response, error)
ListIssueEvents lists events for the specified issue.
GitHub API docs: https://developer.github.com/v3/issues/events/#list-events-for-an-issue
func (s *IssuesService) ListIssueTimeline(ctx context.Context, owner, repo string, number int, opt *ListOptions) ([]*Timeline, *Response, error)
ListIssueTimeline lists events for the specified issue.
GitHub API docs: https://developer.github.com/v3/issues/timeline/#list-events-for-an-issue
func (s *IssuesService) ListLabels(ctx context.Context, owner string, repo string, opt *ListOptions) ([]*Label, *Response, error)
ListLabels lists all labels for a repository.
GitHub API docs: https://developer.github.com/v3/issues/labels/#list-all-labels-for-this-repository
func (s *IssuesService) ListLabelsByIssue(ctx context.Context, owner string, repo string, number int, opt *ListOptions) ([]*Label, *Response, error)
ListLabelsByIssue lists all labels for an issue.
GitHub API docs: https://developer.github.com/v3/issues/labels/#list-labels-on-an-issue
func (s *IssuesService) ListLabelsForMilestone(ctx context.Context, owner string, repo string, number int, opt *ListOptions) ([]*Label, *Response, error)
ListLabelsForMilestone lists labels for every issue in a milestone.
GitHub API docs: https://developer.github.com/v3/issues/labels/#get-labels-for-every-issue-in-a-milestone
func (s *IssuesService) ListMilestones(ctx context.Context, owner string, repo string, opt *MilestoneListOptions) ([]*Milestone, *Response, error)
ListMilestones lists all milestones for a repository.
GitHub API docs: https://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository
func (s *IssuesService) ListRepositoryEvents(ctx context.Context, owner, repo string, opt *ListOptions) ([]*IssueEvent, *Response, error)
ListRepositoryEvents lists events for the specified repository.
GitHub API docs: https://developer.github.com/v3/issues/events/#list-events-for-a-repository
func (s *IssuesService) Lock(ctx context.Context, owner string, repo string, number int, opt *LockIssueOptions) (*Response, error)
Lock an issue's conversation.
GitHub API docs: https://developer.github.com/v3/issues/#lock-an-issue
func (s *IssuesService) RemoveAssignees(ctx context.Context, owner, repo string, number int, assignees []string) (*Issue, *Response, error)
RemoveAssignees removes the provided GitHub users as assignees from the issue.
GitHub API docs: https://developer.github.com/v3/issues/assignees/#remove-assignees-from-an-issue
func (s *IssuesService) RemoveLabelForIssue(ctx context.Context, owner string, repo string, number int, label string) (*Response, error)
RemoveLabelForIssue removes a label for an issue.
GitHub API docs: https://developer.github.com/v3/issues/labels/#remove-a-label-from-an-issue
func (s *IssuesService) RemoveLabelsForIssue(ctx context.Context, owner string, repo string, number int) (*Response, error)
RemoveLabelsForIssue removes all labels for an issue.
GitHub API docs: https://developer.github.com/v3/issues/labels/#remove-all-labels-from-an-issue
func (s *IssuesService) ReplaceLabelsForIssue(ctx context.Context, owner string, repo string, number int, labels []string) ([]*Label, *Response, error)
ReplaceLabelsForIssue replaces all labels for an issue.
GitHub API docs: https://developer.github.com/v3/issues/labels/#replace-all-labels-for-an-issue
func (s *IssuesService) Unlock(ctx context.Context, owner string, repo string, number int) (*Response, error)
Unlock an issue's conversation.
GitHub API docs: https://developer.github.com/v3/issues/#unlock-an-issue
type Key struct {
ID *int64 `json:"id,omitempty"`
Key *string `json:"key,omitempty"`
URL *string `json:"url,omitempty"`
Title *string `json:"title,omitempty"`
ReadOnly *bool `json:"read_only,omitempty"`
}
Key represents a public SSH key used to authenticate a user or deploy script.
func (k *Key) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (k *Key) GetKey() string
GetKey returns the Key field if it's non-nil, zero value otherwise.
func (k *Key) GetReadOnly() bool
GetReadOnly returns the ReadOnly field if it's non-nil, zero value otherwise.
func (k *Key) GetTitle() string
GetTitle returns the Title field if it's non-nil, zero value otherwise.
func (k *Key) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (k Key) String() string
type Label struct {
ID *int64 `json:"id,omitempty"`
URL *string `json:"url,omitempty"`
Name *string `json:"name,omitempty"`
Color *string `json:"color,omitempty"`
Description *string `json:"description,omitempty"`
Default *bool `json:"default,omitempty"`
NodeID *string `json:"node_id,omitempty"`
}
Label represents a GitHub label on an Issue
func (l *Label) GetColor() string
GetColor returns the Color field if it's non-nil, zero value otherwise.
func (l *Label) GetDefault() bool
GetDefault returns the Default field if it's non-nil, zero value otherwise.
func (l *Label) GetDescription() string
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (l *Label) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (l *Label) GetName() string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (l *Label) GetNodeID() string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (l *Label) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (l Label) String() string
type LabelEvent struct {
// Action is the action that was performed. Possible values are:
// "created", "edited", "deleted"
Action *string `json:"action,omitempty"`
Label *Label `json:"label,omitempty"`
// The following fields are only populated by Webhook events.
Changes *EditChange `json:"changes,omitempty"`
Repo *Repository `json:"repository,omitempty"`
Org *Organization `json:"organization,omitempty"`
Installation *Installation `json:"installation,omitempty"`
}
LabelEvent is triggered when a repository's label is created, edited, or deleted. The Webhook event name is "label"
GitHub API docs: https://developer.github.com/v3/activity/events/types/#labelevent
func (l *LabelEvent) GetAction() string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (l *LabelEvent) GetChanges() *EditChange
GetChanges returns the Changes field.
func (l *LabelEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (l *LabelEvent) GetLabel() *Label
GetLabel returns the Label field.
func (l *LabelEvent) GetOrg() *Organization
GetOrg returns the Org field.
func (l *LabelEvent) GetRepo() *Repository
GetRepo returns the Repo field.
type LabelResult struct {
ID *int64 `json:"id,omitempty"`
URL *string `json:"url,omitempty"`
Name *string `json:"name,omitempty"`
Color *string `json:"color,omitempty"`
Default *bool `json:"default,omitempty"`
Description *string `json:"description,omitempty"`
Score *float64 `json:"score,omitempty"`
}
LabelResult represents a single search result.
func (l *LabelResult) GetColor() string
GetColor returns the Color field if it's non-nil, zero value otherwise.
func (l *LabelResult) GetDefault() bool
GetDefault returns the Default field if it's non-nil, zero value otherwise.
func (l *LabelResult) GetDescription() string
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (l *LabelResult) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (l *LabelResult) GetName() string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (l *LabelResult) GetScore() *float64
GetScore returns the Score field.
func (l *LabelResult) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (l LabelResult) String() string
type LabelsSearchResult struct {
Total *int `json:"total_count,omitempty"`
IncompleteResults *bool `json:"incomplete_results,omitempty"`
Labels []*LabelResult `json:"items,omitempty"`
}
LabelsSearchResult represents the result of a code search.
func (l *LabelsSearchResult) GetIncompleteResults() bool
GetIncompleteResults returns the IncompleteResults field if it's non-nil, zero value otherwise.
func (l *LabelsSearchResult) GetTotal() int
GetTotal returns the Total field if it's non-nil, zero value otherwise.
type LargeFile struct {
RefName *string `json:"ref_name,omitempty"`
Path *string `json:"path,omitempty"`
OID *string `json:"oid,omitempty"`
Size *int `json:"size,omitempty"`
}
LargeFile identifies a file larger than 100MB found during a repository import.
GitHub API docs: https://developer.github.com/v3/migration/source_imports/#get-large-files
func (l *LargeFile) GetOID() string
GetOID returns the OID field if it's non-nil, zero value otherwise.
func (l *LargeFile) GetPath() string
GetPath returns the Path field if it's non-nil, zero value otherwise.
func (l *LargeFile) GetRefName() string
GetRefName returns the RefName field if it's non-nil, zero value otherwise.
func (l *LargeFile) GetSize() int
GetSize returns the Size field if it's non-nil, zero value otherwise.
func (f LargeFile) String() string
type License struct {
Key *string `json:"key,omitempty"`
Name *string `json:"name,omitempty"`
URL *string `json:"url,omitempty"`
SPDXID *string `json:"spdx_id,omitempty"`
HTMLURL *string `json:"html_url,omitempty"`
Featured *bool `json:"featured,omitempty"`
Description *string `json:"description,omitempty"`
Implementation *string `json:"implementation,omitempty"`
Permissions *[]string `json:"permissions,omitempty"`
Conditions *[]string `json:"conditions,omitempty"`
Limitations *[]string `json:"limitations,omitempty"`
Body *string `json:"body,omitempty"`
}
License represents an open source license.
func (l *License) GetBody() string
GetBody returns the Body field if it's non-nil, zero value otherwise.
func (l *License) GetConditions() []string
GetConditions returns the Conditions field if it's non-nil, zero value otherwise.
func (l *License) GetDescription() string
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (l *License) GetFeatured() bool
GetFeatured returns the Featured field if it's non-nil, zero value otherwise.
func (l *License) GetHTMLURL() string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (l *License) GetImplementation() string
GetImplementation returns the Implementation field if it's non-nil, zero value otherwise.
func (l *License) GetKey() string
GetKey returns the Key field if it's non-nil, zero value otherwise.
func (l *License) GetLimitations() []string
GetLimitations returns the Limitations field if it's non-nil, zero value otherwise.
func (l *License) GetName() string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (l *License) GetPermissions() []string
GetPermissions returns the Permissions field if it's non-nil, zero value otherwise.
func (l *License) GetSPDXID() string
GetSPDXID returns the SPDXID field if it's non-nil, zero value otherwise.
func (l *License) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (l License) String() string
type LicensesService service
LicensesService handles communication with the license related methods of the GitHub API.
GitHub API docs: https://developer.github.com/v3/licenses/
func (s *LicensesService) Get(ctx context.Context, licenseName string) (*License, *Response, error)
Get extended metadata for one license.
GitHub API docs: https://developer.github.com/v3/licenses/#get-an-individual-license
func (s *LicensesService) List(ctx context.Context) ([]*License, *Response, error)
List popular open source licenses.
GitHub API docs: https://developer.github.com/v3/licenses/#list-all-licenses
type ListCheckRunsOptions struct {
CheckName *string `url:"check_name,omitempty"` // Returns check runs with the specified name.
Status *string `url:"status,omitempty"` // Returns check runs with the specified status. Can be one of "queued", "in_progress", or "completed".
Filter *string `url:"filter,omitempty"` // Filters check runs by their completed_at timestamp. Can be one of "latest" (returning the most recent check runs) or "all". Default: "latest"
ListOptions
}
ListCheckRunsOptions represents parameters to list check runs.
func (l *ListCheckRunsOptions) GetCheckName() string
GetCheckName returns the CheckName field if it's non-nil, zero value otherwise.
func (l *ListCheckRunsOptions) GetFilter() string
GetFilter returns the Filter field if it's non-nil, zero value otherwise.
func (l *ListCheckRunsOptions) GetStatus() string
GetStatus returns the Status field if it's non-nil, zero value otherwise.
type ListCheckRunsResults struct {
Total *int `json:"total_count,omitempty"`
CheckRuns []*CheckRun `json:"check_runs,omitempty"`
}
ListCheckRunsResults represents the result of a check run list.
func (l *ListCheckRunsResults) GetTotal() int
GetTotal returns the Total field if it's non-nil, zero value otherwise.
type ListCheckSuiteOptions struct {
CheckName *string `url:"check_name,omitempty"` // Filters checks suites by the name of the check run.
AppID *int `url:"app_id,omitempty"` // Filters check suites by GitHub App id.
ListOptions
}
ListCheckSuiteOptions represents parameters to list check suites.
func (l *ListCheckSuiteOptions) GetAppID() int
GetAppID returns the AppID field if it's non-nil, zero value otherwise.
func (l *ListCheckSuiteOptions) GetCheckName() string
GetCheckName returns the CheckName field if it's non-nil, zero value otherwise.
type ListCheckSuiteResults struct {
Total *int `json:"total_count,omitempty"`
CheckSuites []*CheckSuite `json:"check_suites,omitempty"`
}
ListCheckSuiteResults represents the result of a check run list.
func (l *ListCheckSuiteResults) GetTotal() int
GetTotal returns the Total field if it's non-nil, zero value otherwise.
type ListCollaboratorsOptions struct {
// Affiliation specifies how collaborators should be filtered by their affiliation.
// Possible values are:
// outside - All outside collaborators of an organization-owned repository
// direct - All collaborators with permissions to an organization-owned repository,
// regardless of organization membership status
// all - All collaborators the authenticated user can see
//
// Default value is "all".
Affiliation string `url:"affiliation,omitempty"`
ListOptions
}
ListCollaboratorsOptions specifies the optional parameters to the RepositoriesService.ListCollaborators method.
type ListContributorsOptions struct {
// Include anonymous contributors in results or not
Anon string `url:"anon,omitempty"`
ListOptions
}
ListContributorsOptions specifies the optional parameters to the RepositoriesService.ListContributors method.
type ListMembersOptions struct {
// If true (or if the authenticated user is not an owner of the
// organization), list only publicly visible members.
PublicOnly bool `url:"-"`
// Filter members returned in the list. Possible values are:
// 2fa_disabled, all. Default is "all".
Filter string `url:"filter,omitempty"`
// Role filters members returned by their role in the organization.
// Possible values are:
// all - all members of the organization, regardless of role
// admin - organization owners
// member - non-owner organization members
//
// Default is "all".
Role string `url:"role,omitempty"`
ListOptions
}
ListMembersOptions specifies optional parameters to the OrganizationsService.ListMembers method.
type ListOptions struct {
// For paginated result sets, page of results to retrieve.
Page int `url:"page,omitempty"`
// For paginated result sets, the number of results to include per page.
PerPage int `url:"per_page,omitempty"`
}
ListOptions specifies the optional parameters to various List methods that support pagination.
type ListOrgMembershipsOptions struct {
// Filter memberships to include only those with the specified state.
// Possible values are: "active", "pending".
State string `url:"state,omitempty"`
ListOptions
}
ListOrgMembershipsOptions specifies optional parameters to the OrganizationsService.ListOrgMemberships method.
type ListOutsideCollaboratorsOptions struct {
// Filter outside collaborators returned in the list. Possible values are:
// 2fa_disabled, all. Default is "all".
Filter string `url:"filter,omitempty"`
ListOptions
}
ListOutsideCollaboratorsOptions specifies optional parameters to the OrganizationsService.ListOutsideCollaborators method.
type LockIssueOptions struct {
// LockReason specifies the reason to lock this issue.
// Providing a lock reason can help make it clearer to contributors why an issue
// was locked. Possible values are: "off-topic", "too heated", "resolved", and "spam".
LockReason string `json:"lock_reason,omitempty"`
}
LockIssueOptions specifies the optional parameters to the IssuesService.Lock method.
type MarkdownOptions struct {
// Mode identifies the rendering mode. Possible values are:
// markdown - render a document as plain Markdown, just like
// README files are rendered.
//
// gfm - to render a document as user-content, e.g. like user
// comments or issues are rendered. In GFM mode, hard line breaks are
// always taken into account, and issue and user mentions are linked
// accordingly.
//
// Default is "markdown".
Mode string
// Context identifies the repository context. Only taken into account
// when rendering as "gfm".
Context string
}
MarkdownOptions specifies optional parameters to the Markdown method.
type MarketplacePlan struct {
URL *string `json:"url,omitempty"`
AccountsURL *string `json:"accounts_url,omitempty"`
ID *int64 `json:"id,omitempty"`
Name *string `json:"name,omitempty"`
Description *string `json:"description,omitempty"`
MonthlyPriceInCents *int `json:"monthly_price_in_cents,omitempty"`
YearlyPriceInCents *int `json:"yearly_price_in_cents,omitempty"`
PriceModel *string `json:"price_model,omitempty"`
UnitName *string `json:"unit_name,omitempty"`
Bullets *[]string `json:"bullets,omitempty"`
}
MarketplacePlan represents a GitHub Apps Marketplace Listing Plan.
func (m *MarketplacePlan) GetAccountsURL() string
GetAccountsURL returns the AccountsURL field if it's non-nil, zero value otherwise.
func (m *MarketplacePlan) GetBullets() []string
GetBullets returns the Bullets field if it's non-nil, zero value otherwise.
func (m *MarketplacePlan) GetDescription() string
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (m *MarketplacePlan) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (m *MarketplacePlan) GetMonthlyPriceInCents() int
GetMonthlyPriceInCents returns the MonthlyPriceInCents field if it's non-nil, zero value otherwise.
func (m *MarketplacePlan) GetName() string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (m *MarketplacePlan) GetPriceModel() string
GetPriceModel returns the PriceModel field if it's non-nil, zero value otherwise.
func (m *MarketplacePlan) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (m *MarketplacePlan) GetUnitName() string
GetUnitName returns the UnitName field if it's non-nil, zero value otherwise.
func (m *MarketplacePlan) GetYearlyPriceInCents() int
GetYearlyPriceInCents returns the YearlyPriceInCents field if it's non-nil, zero value otherwise.
type MarketplacePlanAccount struct {
URL *string `json:"url,omitempty"`
Type *string `json:"type,omitempty"`
ID *int64 `json:"id,omitempty"`
Login *string `json:"login,omitempty"`
Email *string `json:"email,omitempty"`
OrganizationBillingEmail *string `json:"organization_billing_email,omitempty"`
MarketplacePurchase *MarketplacePurchase `json:"marketplace_purchase,omitempty"`
}
MarketplacePlanAccount represents a GitHub Account (user or organization) on a specific plan.
func (m *MarketplacePlanAccount) GetEmail() string
GetEmail returns the Email field if it's non-nil, zero value otherwise.
func (m *MarketplacePlanAccount) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (m *MarketplacePlanAccount) GetLogin() string
GetLogin returns the Login field if it's non-nil, zero value otherwise.
func (m *MarketplacePlanAccount) GetMarketplacePurchase() *MarketplacePurchase
GetMarketplacePurchase returns the MarketplacePurchase field.
func (m *MarketplacePlanAccount) GetOrganizationBillingEmail() string
GetOrganizationBillingEmail returns the OrganizationBillingEmail field if it's non-nil, zero value otherwise.
func (m *MarketplacePlanAccount) GetType() string
GetType returns the Type field if it's non-nil, zero value otherwise.
func (m *MarketplacePlanAccount) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
type MarketplacePurchase struct {
BillingCycle *string `json:"billing_cycle,omitempty"`
NextBillingDate *string `json:"next_billing_date,omitempty"`
UnitCount *int `json:"unit_count,omitempty"`
Plan *MarketplacePlan `json:"plan,omitempty"`
Account *MarketplacePlanAccount `json:"account,omitempty"`
}
MarketplacePurchase represents a GitHub Apps Marketplace Purchase.
func (m *MarketplacePurchase) GetAccount() *MarketplacePlanAccount
GetAccount returns the Account field.
func (m *MarketplacePurchase) GetBillingCycle() string
GetBillingCycle returns the BillingCycle field if it's non-nil, zero value otherwise.
func (m *MarketplacePurchase) GetNextBillingDate() string
GetNextBillingDate returns the NextBillingDate field if it's non-nil, zero value otherwise.
func (m *MarketplacePurchase) GetPlan() *MarketplacePlan
GetPlan returns the Plan field.
func (m *MarketplacePurchase) GetUnitCount() int
GetUnitCount returns the UnitCount field if it's non-nil, zero value otherwise.
type MarketplacePurchaseEvent struct {
// Action is the action that was performed. Possible values are:
// "purchased", "cancelled", "changed".
Action *string `json:"action,omitempty"`
// The following fields are only populated by Webhook events.
EffectiveDate *Timestamp `json:"effective_date,omitempty"`
MarketplacePurchase *MarketplacePurchase `json:"marketplace_purchase,omitempty"`
PreviousMarketplacePurchase *MarketplacePurchase `json:"previous_marketplace_purchase,omitempty"`
Sender *User `json:"sender,omitempty"`
Installation *Installation `json:"installation,omitempty"`
}
MarketplacePurchaseEvent is triggered when a user purchases, cancels, or changes their GitHub Marketplace plan. Webhook event name "marketplace_purchase".
Github API docs: https://developer.github.com/v3/activity/events/types/#marketplacepurchaseevent
func (m *MarketplacePurchaseEvent) GetAction() string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (m *MarketplacePurchaseEvent) GetEffectiveDate() Timestamp
GetEffectiveDate returns the EffectiveDate field if it's non-nil, zero value otherwise.
func (m *MarketplacePurchaseEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (m *MarketplacePurchaseEvent) GetMarketplacePurchase() *MarketplacePurchase
GetMarketplacePurchase returns the MarketplacePurchase field.
func (m *MarketplacePurchaseEvent) GetPreviousMarketplacePurchase() *MarketplacePurchase
GetPreviousMarketplacePurchase returns the PreviousMarketplacePurchase field.
func (m *MarketplacePurchaseEvent) GetSender() *User
GetSender returns the Sender field.
type MarketplaceService struct {
// Stubbed controls whether endpoints that return stubbed data are used
// instead of production endpoints. Stubbed data is fake data that's useful
// for testing your GitHub Apps. Stubbed data is hard-coded and will not
// change based on actual subscriptions.
//
// GitHub API docs: https://developer.github.com/v3/apps/marketplace/
Stubbed bool
// contains filtered or unexported fields
}
MarketplaceService handles communication with the marketplace related methods of the GitHub API.
GitHub API docs: https://developer.github.com/v3/apps/marketplace/
func (s *MarketplaceService) ListMarketplacePurchasesForUser(ctx context.Context, opt *ListOptions) ([]*MarketplacePurchase, *Response, error)
ListMarketplacePurchasesForUser lists all GitHub marketplace purchases made by a user.
GitHub API docs: https://developer.github.com/v3/apps/marketplace/#get-a-users-marketplace-purchases
func (s *MarketplaceService) ListPlanAccountsForAccount(ctx context.Context, accountID int64, opt *ListOptions) ([]*MarketplacePlanAccount, *Response, error)
ListPlanAccountsForAccount lists all GitHub accounts (user or organization) associated with an account.
GitHub API docs: https://developer.github.com/v3/apps/marketplace/#check-if-a-github-account-is-associated-with-any-marketplace-listing
func (s *MarketplaceService) ListPlanAccountsForPlan(ctx context.Context, planID int64, opt *ListOptions) ([]*MarketplacePlanAccount, *Response, error)
ListPlanAccountsForPlan lists all GitHub accounts (user or organization) on a specific plan.
GitHub API docs: https://developer.github.com/v3/apps/marketplace/#list-all-github-accounts-user-or-organization-on-a-specific-plan
func (s *MarketplaceService) ListPlans(ctx context.Context, opt *ListOptions) ([]*MarketplacePlan, *Response, error)
ListPlans lists all plans for your Marketplace listing.
GitHub API docs: https://developer.github.com/v3/apps/marketplace/#list-all-plans-for-your-marketplace-listing
type Match struct {
Text *string `json:"text,omitempty"`
Indices []int `json:"indices,omitempty"`
}
Match represents a single text match.
func (m *Match) GetText() string
GetText returns the Text field if it's non-nil, zero value otherwise.
type MemberEvent struct {
// Action is the action that was performed. Possible value is: "added".
Action *string `json:"action,omitempty"`
Member *User `json:"member,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"`
}
MemberEvent is triggered when a user is added as a collaborator to a repository. The Webhook event name is "member".
GitHub API docs: https://developer.github.com/v3/activity/events/types/#memberevent
func (m *MemberEvent) GetAction() string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (m *MemberEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (m *MemberEvent) GetMember() *User
GetMember returns the Member field.
func (m *MemberEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (m *MemberEvent) GetSender() *User
GetSender returns the Sender field.
type Membership struct {
URL *string `json:"url,omitempty"`
// State is the user's status within the organization or team.
// Possible values are: "active", "pending"
State *string `json:"state,omitempty"`
// Role identifies the user's role within the organization or team.
// Possible values for organization membership:
// member - non-owner organization member
// admin - organization owner
//
// Possible values for team membership are:
// member - a normal member of the team
// maintainer - a team maintainer. Able to add/remove other team
// members, promote other team members to team
// maintainer, and edit the team’s name and description
Role *string `json:"role,omitempty"`
// For organization membership, the API URL of the organization.
OrganizationURL *string `json:"organization_url,omitempty"`
// For organization membership, the organization the membership is for.
Organization *Organization `json:"organization,omitempty"`
// For organization membership, the user the membership is for.
User *User `json:"user,omitempty"`
}
Membership represents the status of a user's membership in an organization or team.
func (m *Membership) GetOrganization() *Organization
GetOrganization returns the Organization field.
func (m *Membership) GetOrganizationURL() string
GetOrganizationURL returns the OrganizationURL field if it's non-nil, zero value otherwise.
func (m *Membership) GetRole() string
GetRole returns the Role field if it's non-nil, zero value otherwise.
func (m *Membership) GetState() string
GetState returns the State field if it's non-nil, zero value otherwise.
func (m *Membership) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (m *Membership) GetUser() *User
GetUser returns the User field.
func (m Membership) String() string
type MembershipEvent struct {
// Action is the action that was performed. Possible values are: "added", "removed".
Action *string `json:"action,omitempty"`
// Scope is the scope of the membership. Possible value is: "team".
Scope *string `json:"scope,omitempty"`
Member *User `json:"member,omitempty"`
Team *Team `json:"team,omitempty"`
// The following fields are only populated by Webhook events.
Org *Organization `json:"organization,omitempty"`
Sender *User `json:"sender,omitempty"`
Installation *Installation `json:"installation,omitempty"`
}
MembershipEvent is triggered when a user is added or removed from a team. The Webhook event name is "membership".
Events of this type are not visible in timelines, they are only used to trigger organization webhooks.
GitHub API docs: https://developer.github.com/v3/activity/events/types/#membershipevent
func (m *MembershipEvent) GetAction() string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (m *MembershipEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (m *MembershipEvent) GetMember() *User
GetMember returns the Member field.
func (m *MembershipEvent) GetOrg() *Organization
GetOrg returns the Org field.
func (m *MembershipEvent) GetScope() string
GetScope returns the Scope field if it's non-nil, zero value otherwise.
func (m *MembershipEvent) GetSender() *User
GetSender returns the Sender field.
func (m *MembershipEvent) GetTeam() *Team
GetTeam returns the Team field.
type Metric struct {
Name *string `json:"name"`
Key *string `json:"key"`
URL *string `json:"url"`
HTMLURL *string `json:"html_url"`
}
Metric represents the different fields for one file in community health files.
func (m *Metric) GetHTMLURL() string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (m *Metric) GetKey() string
GetKey returns the Key field if it's non-nil, zero value otherwise.
func (m *Metric) GetName() string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (m *Metric) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
type Migration struct {
ID *int64 `json:"id,omitempty"`
GUID *string `json:"guid,omitempty"`
// State is the current state of a migration.
// Possible values are:
// "pending" which means the migration hasn't started yet,
// "exporting" which means the migration is in progress,
// "exported" which means the migration finished successfully, or
// "failed" which means the migration failed.
State *string `json:"state,omitempty"`
// LockRepositories indicates whether repositories are locked (to prevent
// manipulation) while migrating data.
LockRepositories *bool `json:"lock_repositories,omitempty"`
// ExcludeAttachments indicates whether attachments should be excluded from
// the migration (to reduce migration archive file size).
ExcludeAttachments *bool `json:"exclude_attachments,omitempty"`
URL *string `json:"url,omitempty"`
CreatedAt *string `json:"created_at,omitempty"`
UpdatedAt *string `json:"updated_at,omitempty"`
Repositories []*Repository `json:"repositories,omitempty"`
}
Migration represents a GitHub migration (archival).
func (m *Migration) GetCreatedAt() string
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (m *Migration) GetExcludeAttachments() bool
GetExcludeAttachments returns the ExcludeAttachments field if it's non-nil, zero value otherwise.
func (m *Migration) GetGUID() string
GetGUID returns the GUID field if it's non-nil, zero value otherwise.
func (m *Migration) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (m *Migration) GetLockRepositories() bool
GetLockRepositories returns the LockRepositories field if it's non-nil, zero value otherwise.
func (m *Migration) GetState() string
GetState returns the State field if it's non-nil, zero value otherwise.
func (m *Migration) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (m *Migration) GetUpdatedAt() string
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (m Migration) String() string
type MigrationOptions struct {
// LockRepositories indicates whether repositories should be locked (to prevent
// manipulation) while migrating data.
LockRepositories bool
// ExcludeAttachments indicates whether attachments should be excluded from
// the migration (to reduce migration archive file size).
ExcludeAttachments bool
}
MigrationOptions specifies the optional parameters to Migration methods.
type MigrationService service
MigrationService provides access to the migration related functions in the GitHub API.
GitHub API docs: https://developer.github.com/v3/migration/
func (s *MigrationService) CancelImport(ctx context.Context, owner, repo string) (*Response, error)
CancelImport stops an import for a repository.
GitHub API docs: https://developer.github.com/v3/migration/source_imports/#cancel-an-import
func (s *MigrationService) CommitAuthors(ctx context.Context, owner, repo string) ([]*SourceImportAuthor, *Response, error)
CommitAuthors gets the authors mapped from the original repository.
Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username "hubot" into something like "hubot <hubot@12341234-abab-fefe-8787-fedcba987654>".
This method and MapCommitAuthor allow you to provide correct Git author information.
GitHub API docs: https://developer.github.com/v3/migration/source_imports/#get-commit-authors
func (s *MigrationService) DeleteMigration(ctx context.Context, org string, id int64) (*Response, error)
DeleteMigration deletes a previous migration archive. id is the migration ID.
GitHub API docs: https://developer.github.com/v3/migration/migrations/#delete-a-migration-archive
func (s *MigrationService) DeleteUserMigration(ctx context.Context, id int64) (*Response, error)
DeleteUserMigration will delete a previous migration archive. id is the migration ID.
GitHub API docs: https://developer.github.com/v3/migrations/users/#delete-a-user-migration-archive
func (s *MigrationService) ImportProgress(ctx context.Context, owner, repo string) (*Import, *Response, error)
ImportProgress queries for the status and progress of an ongoing repository import.
GitHub API docs: https://developer.github.com/v3/migration/source_imports/#get-import-progress
func (s *MigrationService) LargeFiles(ctx context.Context, owner, repo string) ([]*LargeFile, *Response, error)
LargeFiles lists files larger than 100MB found during the import.
GitHub API docs: https://developer.github.com/v3/migration/source_imports/#get-large-files
func (s *MigrationService) ListMigrations(ctx context.Context, org string) ([]*Migration, *Response, error)
ListMigrations lists the most recent migrations.
GitHub API docs: https://developer.github.com/v3/migration/migrations/#get-a-list-of-migrations
func (s *MigrationService) ListUserMigrations(ctx context.Context) ([]*UserMigration, *Response, error)
ListUserMigrations lists the most recent migrations.
GitHub API docs: https://developer.github.com/v3/migrations/users/#get-a-list-of-user-migrations
func (s *MigrationService) MapCommitAuthor(ctx context.Context, owner, repo string, id int64, author *SourceImportAuthor) (*SourceImportAuthor, *Response, error)
MapCommitAuthor updates an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository.
GitHub API docs: https://developer.github.com/v3/migration/source_imports/#map-a-commit-author
func (s *MigrationService) MigrationArchiveURL(ctx context.Context, org string, id int64) (url string, err error)
MigrationArchiveURL fetches a migration archive URL. id is the migration ID.
GitHub API docs: https://developer.github.com/v3/migration/migrations/#download-a-migration-archive
func (s *MigrationService) MigrationStatus(ctx context.Context, org string, id int64) (*Migration, *Response, error)
MigrationStatus gets the status of a specific migration archive. id is the migration ID.
GitHub API docs: https://developer.github.com/v3/migration/migrations/#get-the-status-of-a-migration
func (s *MigrationService) SetLFSPreference(ctx context.Context, owner, repo string, in *Import) (*Import, *Response, error)
SetLFSPreference sets whether imported repositories should use Git LFS for files larger than 100MB. Only the UseLFS field on the provided Import is used.
GitHub API docs: https://developer.github.com/v3/migration/source_imports/#set-git-lfs-preference
func (s *MigrationService) StartImport(ctx context.Context, owner, repo string, in *Import) (*Import, *Response, error)
StartImport initiates a repository import.
GitHub API docs: https://developer.github.com/v3/migration/source_imports/#start-an-import
func (s *MigrationService) StartMigration(ctx context.Context, org string, repos []string, opt *MigrationOptions) (*Migration, *Response, error)
StartMigration starts the generation of a migration archive. repos is a slice of repository names to migrate.
GitHub API docs: https://developer.github.com/v3/migration/migrations/#start-a-migration
func (s *MigrationService) StartUserMigration(ctx context.Context, repos []string, opt *UserMigrationOptions) (*UserMigration, *Response, error)
StartUserMigration starts the generation of a migration archive. repos is a slice of repository names to migrate.
GitHub API docs: https://developer.github.com/v3/migrations/users/#start-a-user-migration
func (s *MigrationService) UnlockRepo(ctx context.Context, org string, id int64, repo string) (*Response, error)
UnlockRepo unlocks a repository that was locked for migration. id is the migration ID. You should unlock each migrated repository and delete them when the migration is complete and you no longer need the source data.
GitHub API docs: https://developer.github.com/v3/migration/migrations/#unlock-a-repository
func (s *MigrationService) UnlockUserRepo(ctx context.Context, id int64, repo string) (*Response, error)
UnlockUserRepository will unlock a repo that was locked for migration. id is migration ID. You should unlock each migrated repository and delete them when the migration is complete and you no longer need the source data.
GitHub API docs: https://developer.github.com/v3/migrations/users/#unlock-a-user-repository
func (s *MigrationService) UpdateImport(ctx context.Context, owner, repo string, in *Import) (*Import, *Response, error)
UpdateImport initiates a repository import.
GitHub API docs: https://developer.github.com/v3/migration/source_imports/#update-existing-import
func (s *MigrationService) UserMigrationArchiveURL(ctx context.Context, id int64) (string, error)
UserMigrationArchiveURL gets the URL for a specific migration archive. id is the migration ID.
GitHub API docs: https://developer.github.com/v3/migrations/users/#download-a-user-migration-archive
func (s *MigrationService) UserMigrationStatus(ctx context.Context, id int64) (*UserMigration, *Response, error)
UserMigrationStatus gets the status of a specific migration archive. id is the migration ID.
GitHub API docs: https://developer.github.com/v3/migrations/users/#get-the-status-of-a-user-migration
type Milestone struct {
URL *string `json:"url,omitempty"`
HTMLURL *string `json:"html_url,omitempty"`
LabelsURL *string `json:"labels_url,omitempty"`
ID *int64 `json:"id,omitempty"`
Number *int `json:"number,omitempty"`
State *string `json:"state,omitempty"`
Title *string `json:"title,omitempty"`
Description *string `json:"description,omitempty"`
Creator *User `json:"creator,omitempty"`
OpenIssues *int `json:"open_issues,omitempty"`
ClosedIssues *int `json:"closed_issues,omitempty"`
CreatedAt *time.Time `json:"created_at,omitempty"`
UpdatedAt *time.Time `json:"updated_at,omitempty"`
ClosedAt *time.Time `json:"closed_at,omitempty"`
DueOn *time.Time `json:"due_on,omitempty"`
NodeID *string `json:"node_id,omitempty"`
}
Milestone represents a GitHub repository milestone.
func (m *Milestone) GetClosedAt() time.Time
GetClosedAt returns the ClosedAt field if it's non-nil, zero value otherwise.
func (m *Milestone) GetClosedIssues() int
GetClosedIssues returns the ClosedIssues field if it's non-nil, zero value otherwise.
func (m *Milestone) GetCreatedAt() time.Time
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (m *Milestone) GetCreator() *User
GetCreator returns the Creator field.
func (m *Milestone) GetDescription() string
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (m *Milestone) GetDueOn() time.Time
GetDueOn returns the DueOn field if it's non-nil, zero value otherwise.
func (m *Milestone) GetHTMLURL() string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (m *Milestone) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (m *Milestone) GetLabelsURL() string
GetLabelsURL returns the LabelsURL field if it's non-nil, zero value otherwise.
func (m *Milestone) GetNodeID() string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (m *Milestone) GetNumber() int
GetNumber returns the Number field if it's non-nil, zero value otherwise.
func (m *Milestone) GetOpenIssues() int
GetOpenIssues returns the OpenIssues field if it's non-nil, zero value otherwise.
func (m *Milestone) GetState() string
GetState returns the State field if it's non-nil, zero value otherwise.
func (m *Milestone) GetTitle() string
GetTitle returns the Title field if it's non-nil, zero value otherwise.
func (m *Milestone) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (m *Milestone) GetUpdatedAt() time.Time
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (m Milestone) String() string
type MilestoneEvent struct {
// Action is the action that was performed. Possible values are:
// "created", "closed", "opened", "edited", "deleted"
Action *string `json:"action,omitempty"`
Milestone *Milestone `json:"milestone,omitempty"`
// The following fields are only populated by Webhook events.
Changes *EditChange `json:"changes,omitempty"`
Repo *Repository `json:"repository,omitempty"`
Sender *User `json:"sender,omitempty"`
Org *Organization `json:"organization,omitempty"`
Installation *Installation `json:"installation,omitempty"`
}
MilestoneEvent is triggered when a milestone is created, closed, opened, edited, or deleted. The Webhook event name is "milestone".
GitHub API docs: https://developer.github.com/v3/activity/events/types/#milestoneevent
func (m *MilestoneEvent) GetAction() string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (m *MilestoneEvent) GetChanges() *EditChange
GetChanges returns the Changes field.
func (m *MilestoneEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (m *MilestoneEvent) GetMilestone() *Milestone
GetMilestone returns the Milestone field.
func (m *MilestoneEvent) GetOrg() *Organization
GetOrg returns the Org field.
func (m *MilestoneEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (m *MilestoneEvent) GetSender() *User
GetSender returns the Sender field.
type MilestoneListOptions struct {
// State filters milestones based on their state. Possible values are:
// open, closed, all. Default is "open".
State string `url:"state,omitempty"`
// Sort specifies how to sort milestones. Possible values are: due_on, completeness.
// Default value is "due_on".
Sort string `url:"sort,omitempty"`
// Direction in which to sort milestones. Possible values are: asc, desc.
// Default is "asc".
Direction string `url:"direction,omitempty"`
ListOptions
}
MilestoneListOptions specifies the optional parameters to the IssuesService.ListMilestones method.
type MilestoneStats struct {
TotalMilestones *int `json:"total_milestones,omitempty"`
OpenMilestones *int `json:"open_milestones,omitempty"`
ClosedMilestones *int `json:"closed_milestones,omitempty"`
}
MilestoneStats represents the number of total, open and close milestones.
func (m *MilestoneStats) GetClosedMilestones() int
GetClosedMilestones returns the ClosedMilestones field if it's non-nil, zero value otherwise.
func (m *MilestoneStats) GetOpenMilestones() int
GetOpenMilestones returns the OpenMilestones field if it's non-nil, zero value otherwise.
func (m *MilestoneStats) GetTotalMilestones() int
GetTotalMilestones returns the TotalMilestones field if it's non-nil, zero value otherwise.
func (s MilestoneStats) String() string
type NewPullRequest struct {
Title *string `json:"title,omitempty"`
Head *string `json:"head,omitempty"`
Base *string `json:"base,omitempty"`
Body *string `json:"body,omitempty"`
Issue *int `json:"issue,omitempty"`
MaintainerCanModify *bool `json:"maintainer_can_modify,omitempty"`
}
NewPullRequest represents a new pull request to be created.
func (n *NewPullRequest) GetBase() string
GetBase returns the Base field if it's non-nil, zero value otherwise.
func (n *NewPullRequest) GetBody() string
GetBody returns the Body field if it's non-nil, zero value otherwise.
func (n *NewPullRequest) GetHead() string
GetHead returns the Head field if it's non-nil, zero value otherwise.
func (n *NewPullRequest) GetIssue() int
GetIssue returns the Issue field if it's non-nil, zero value otherwise.
func (n *NewPullRequest) GetMaintainerCanModify() bool
GetMaintainerCanModify returns the MaintainerCanModify field if it's non-nil, zero value otherwise.
func (n *NewPullRequest) GetTitle() string
GetTitle returns the Title field if it's non-nil, zero value otherwise.
type NewTeam struct {
Name string `json:"name"` // Name of the team. (Required.)
Description *string `json:"description,omitempty"`
Maintainers []string `json:"maintainers,omitempty"`
RepoNames []string `json:"repo_names,omitempty"`
ParentTeamID *int64 `json:"parent_team_id,omitempty"`
// Deprecated: Permission is deprecated when creating or editing a team in an org
// using the new GitHub permission model. It no longer identifies the
// permission a team has on its repos, but only specifies the default
// permission a repo is initially added with. Avoid confusion by
// specifying a permission value when calling AddTeamRepo.
Permission *string `json:"permission,omitempty"`
// Privacy identifies the level of privacy this team should have.
// Possible values are:
// secret - only visible to organization owners and members of this team
// closed - visible to all members of this organization
// Default is "secret".
Privacy *string `json:"privacy,omitempty"`
// LDAPDN may be used in GitHub Enterprise when the team membership
// is synchronized with LDAP.
LDAPDN *string `json:"ldap_dn,omitempty"`
}
NewTeam represents a team to be created or modified.
func (n *NewTeam) GetDescription() string
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (n *NewTeam) GetLDAPDN() string
GetLDAPDN returns the LDAPDN field if it's non-nil, zero value otherwise.
func (n *NewTeam) GetParentTeamID() int64
GetParentTeamID returns the ParentTeamID field if it's non-nil, zero value otherwise.
func (n *NewTeam) GetPermission() string
GetPermission returns the Permission field if it's non-nil, zero value otherwise.
func (n *NewTeam) GetPrivacy() string
GetPrivacy returns the Privacy field if it's non-nil, zero value otherwise.
func (s NewTeam) String() string
type Notification struct {
ID *string `json:"id,omitempty"`
Repository *Repository `json:"repository,omitempty"`
Subject *NotificationSubject `json:"subject,omitempty"`
// Reason identifies the event that triggered the notification.
//
// GitHub API docs: https://developer.github.com/v3/activity/notifications/#notification-reasons
Reason *string `json:"reason,omitempty"`
Unread *bool `json:"unread,omitempty"`
UpdatedAt *time.Time `json:"updated_at,omitempty"`
LastReadAt *time.Time `json:"last_read_at,omitempty"`
URL *string `json:"url,omitempty"`
}
Notification identifies a GitHub notification for a user.
func (n *Notification) GetID() string
GetID returns the ID field if it's non-nil, zero value otherwise.
func (n *Notification) GetLastReadAt() time.Time
GetLastReadAt returns the LastReadAt field if it's non-nil, zero value otherwise.
func (n *Notification) GetReason() string
GetReason returns the Reason field if it's non-nil, zero value otherwise.
func (n *Notification) GetRepository() *Repository
GetRepository returns the Repository field.
func (n *Notification) GetSubject() *NotificationSubject
GetSubject returns the Subject field.
func (n *Notification) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (n *Notification) GetUnread() bool
GetUnread returns the Unread field if it's non-nil, zero value otherwise.
func (n *Notification) GetUpdatedAt() time.Time
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
type NotificationListOptions struct {
All bool `url:"all,omitempty"`
Participating bool `url:"participating,omitempty"`
Since time.Time `url:"since,omitempty"`
Before time.Time `url:"before,omitempty"`
ListOptions
}
NotificationListOptions specifies the optional parameters to the ActivityService.ListNotifications method.
type NotificationSubject struct {
Title *string `json:"title,omitempty"`
URL *string `json:"url,omitempty"`
LatestCommentURL *string `json:"latest_comment_url,omitempty"`
Type *string `json:"type,omitempty"`
}
NotificationSubject identifies the subject of a notification.
func (n *NotificationSubject) GetLatestCommentURL() string
GetLatestCommentURL returns the LatestCommentURL field if it's non-nil, zero value otherwise.
func (n *NotificationSubject) GetTitle() string
GetTitle returns the Title field if it's non-nil, zero value otherwise.
func (n *NotificationSubject) GetType() string
GetType returns the Type field if it's non-nil, zero value otherwise.
func (n *NotificationSubject) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
type OrgBlockEvent struct {
// Action is the action that was performed.
// Can be "blocked" or "unblocked".
Action *string `json:"action,omitempty"`
BlockedUser *User `json:"blocked_user,omitempty"`
Organization *Organization `json:"organization,omitempty"`
Sender *User `json:"sender,omitempty"`
// The following fields are only populated by Webhook events.
Installation *Installation `json:"installation,omitempty"`
}
OrgBlockEvent is triggered when an organization blocks or unblocks a user. The Webhook event name is "org_block".
GitHub API docs: https://developer.github.com/v3/activity/events/types/#orgblockevent
func (o *OrgBlockEvent) GetAction() string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (o *OrgBlockEvent) GetBlockedUser() *User
GetBlockedUser returns the BlockedUser field.
func (o *OrgBlockEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (o *OrgBlockEvent) GetOrganization() *Organization
GetOrganization returns the Organization field.
func (o *OrgBlockEvent) GetSender() *User
GetSender returns the Sender field.
type OrgStats struct {
TotalOrgs *int `json:"total_orgs,omitempty"`
DisabledOrgs *int `json:"disabled_orgs,omitempty"`
TotalTeams *int `json:"total_teams,omitempty"`
TotalTeamMembers *int `json:"total_team_members,omitempty"`
}
OrgStats represents the number of total, disabled organizations and the team and team member count.
func (o *OrgStats) GetDisabledOrgs() int
GetDisabledOrgs returns the DisabledOrgs field if it's non-nil, zero value otherwise.
func (o *OrgStats) GetTotalOrgs() int
GetTotalOrgs returns the TotalOrgs field if it's non-nil, zero value otherwise.
func (o *OrgStats) GetTotalTeamMembers() int
GetTotalTeamMembers returns the TotalTeamMembers field if it's non-nil, zero value otherwise.
func (o *OrgStats) GetTotalTeams() int
GetTotalTeams returns the TotalTeams field if it's non-nil, zero value otherwise.
func (s OrgStats) String() string
type Organization struct {
Login *string `json:"login,omitempty"`
ID *int64 `json:"id,omitempty"`
NodeID *string `json:"node_id,omitempty"`
AvatarURL *string `json:"avatar_url,omitempty"`
HTMLURL *string `json:"html_url,omitempty"`
Name *string `json:"name,omitempty"`
Company *string `json:"company,omitempty"`
Blog *string `json:"blog,omitempty"`
Location *string `json:"location,omitempty"`
Email *string `json:"email,omitempty"`
Description *string `json:"description,omitempty"`
PublicRepos *int `json:"public_repos,omitempty"`
PublicGists *int `json:"public_gists,omitempty"`
Followers *int `json:"followers,omitempty"`
Following *int `json:"following,omitempty"`
CreatedAt *time.Time `json:"created_at,omitempty"`
UpdatedAt *time.Time `json:"updated_at,omitempty"`
TotalPrivateRepos *int `json:"total_private_repos,omitempty"`
OwnedPrivateRepos *int `json:"owned_private_repos,omitempty"`
PrivateGists *int `json:"private_gists,omitempty"`
DiskUsage *int `json:"disk_usage,omitempty"`
Collaborators *int `json:"collaborators,omitempty"`
BillingEmail *string `json:"billing_email,omitempty"`
Type *string `json:"type,omitempty"`
Plan *Plan `json:"plan,omitempty"`
// API URLs
URL *string `json:"url,omitempty"`
EventsURL *string `json:"events_url,omitempty"`
HooksURL *string `json:"hooks_url,omitempty"`
IssuesURL *string `json:"issues_url,omitempty"`
MembersURL *string `json:"members_url,omitempty"`
PublicMembersURL *string `json:"public_members_url,omitempty"`
ReposURL *string `json:"repos_url,omitempty"`
}
Organization represents a GitHub organization account.
func (o *Organization) GetAvatarURL() string
GetAvatarURL returns the AvatarURL field if it's non-nil, zero value otherwise.
func (o *Organization) GetBillingEmail() string
GetBillingEmail returns the BillingEmail field if it's non-nil, zero value otherwise.
func (o *Organization) GetBlog() string
GetBlog returns the Blog field if it's non-nil, zero value otherwise.
func (o *Organization) GetCollaborators() int
GetCollaborators returns the Collaborators field if it's non-nil, zero value otherwise.
func (o *Organization) GetCompany() string
GetCompany returns the Company field if it's non-nil, zero value otherwise.
func (o *Organization) GetCreatedAt() time.Time
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (o *Organization) GetDescription() string
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (o *Organization) GetDiskUsage() int
GetDiskUsage returns the DiskUsage field if it's non-nil, zero value otherwise.
func (o *Organization) GetEmail() string
GetEmail returns the Email field if it's non-nil, zero value otherwise.
func (o *Organization) GetEventsURL() string
GetEventsURL returns the EventsURL field if it's non-nil, zero value otherwise.
func (o *Organization) GetFollowers() int
GetFollowers returns the Followers field if it's non-nil, zero value otherwise.
func (o *Organization) GetFollowing() int
GetFollowing returns the Following field if it's non-nil, zero value otherwise.
func (o *Organization) GetHTMLURL() string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (o *Organization) GetHooksURL() string
GetHooksURL returns the HooksURL field if it's non-nil, zero value otherwise.
func (o *Organization) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (o *Organization) GetIssuesURL() string
GetIssuesURL returns the IssuesURL field if it's non-nil, zero value otherwise.
func (o *Organization) GetLocation() string
GetLocation returns the Location field if it's non-nil, zero value otherwise.
func (o *Organization) GetLogin() string
GetLogin returns the Login field if it's non-nil, zero value otherwise.
func (o *Organization) GetMembersURL() string
GetMembersURL returns the MembersURL field if it's non-nil, zero value otherwise.
func (o *Organization) GetName() string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (o *Organization) GetNodeID() string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (o *Organization) GetOwnedPrivateRepos() int
GetOwnedPrivateRepos returns the OwnedPrivateRepos field if it's non-nil, zero value otherwise.
func (o *Organization) GetPlan() *Plan
GetPlan returns the Plan field.
func (o *Organization) GetPrivateGists() int
GetPrivateGists returns the PrivateGists field if it's non-nil, zero value otherwise.
func (o *Organization) GetPublicGists() int
GetPublicGists returns the PublicGists field if it's non-nil, zero value otherwise.
func (o *Organization) GetPublicMembersURL() string
GetPublicMembersURL returns the PublicMembersURL field if it's non-nil, zero value otherwise.
func (o *Organization) GetPublicRepos() int
GetPublicRepos returns the PublicRepos field if it's non-nil, zero value otherwise.
func (o *Organization) GetReposURL() string
GetReposURL returns the ReposURL field if it's non-nil, zero value otherwise.
func (o *Organization) GetTotalPrivateRepos() int
GetTotalPrivateRepos returns the TotalPrivateRepos field if it's non-nil, zero value otherwise.
func (o *Organization) GetType() string
GetType returns the Type field if it's non-nil, zero value otherwise.
func (o *Organization) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (o *Organization) GetUpdatedAt() time.Time
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (o Organization) String() string
type OrganizationEvent struct {
// Action is the action that was performed.
// Can be one of "member_added", "member_removed", or "member_invited".
Action *string `json:"action,omitempty"`
// Invitaion is the invitation for the user or email if the action is "member_invited".
Invitation *Invitation `json:"invitation,omitempty"`
// Membership is the membership between the user and the organization.
// Not present when the action is "member_invited".
Membership *Membership `json:"membership,omitempty"`
Organization *Organization `json:"organization,omitempty"`
Sender *User `json:"sender,omitempty"`
Installation *Installation `json:"installation,omitempty"`
}
OrganizationEvent is triggered when a user is added, removed, or invited to an organization. Events of this type are not visible in timelines. These events are only used to trigger organization hooks. Webhook event name is "organization".
GitHub API docs: https://developer.github.com/v3/activity/events/types/#organizationevent
func (o *OrganizationEvent) GetAction() string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (o *OrganizationEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (o *OrganizationEvent) GetInvitation() *Invitation
GetInvitation returns the Invitation field.
func (o *OrganizationEvent) GetMembership() *Membership
GetMembership returns the Membership field.
func (o *OrganizationEvent) GetOrganization() *Organization
GetOrganization returns the Organization field.
func (o *OrganizationEvent) GetSender() *User
GetSender returns the Sender field.
type OrganizationsListOptions struct {
// Since filters Organizations by ID.
Since int64 `url:"since,omitempty"`
// Note: Pagination is powered exclusively by the Since parameter,
// ListOptions.Page has no effect.
// ListOptions.PerPage controls an undocumented GitHub API parameter.
ListOptions
}
OrganizationsListOptions specifies the optional parameters to the OrganizationsService.ListAll method.
type OrganizationsService service
OrganizationsService provides access to the organization related functions in the GitHub API.
GitHub API docs: https://developer.github.com/v3/orgs/
func (s *OrganizationsService) BlockUser(ctx context.Context, org string, user string) (*Response, error)
BlockUser blocks specified user from an organization.
GitHub API docs: https://developer.github.com/v3/orgs/blocking/#block-a-user
func (s *OrganizationsService) ConcealMembership(ctx context.Context, org, user string) (*Response, error)
ConcealMembership conceals a user's membership in an organization.
GitHub API docs: https://developer.github.com/v3/orgs/members/#conceal-a-users-membership
func (s *OrganizationsService) ConvertMemberToOutsideCollaborator(ctx context.Context, org string, user string) (*Response, error)
ConvertMemberToOutsideCollaborator reduces the permission level of a member of the organization to that of an outside collaborator. Therefore, they will only have access to the repositories that their current team membership allows. Responses for converting a non-member or the last owner to an outside collaborator are listed in GitHub API docs.
GitHub API docs: https://developer.github.com/v3/orgs/outside_collaborators/#convert-member-to-outside-collaborator
func (s *OrganizationsService) CreateHook(ctx context.Context, org string, hook *Hook) (*Hook, *Response, error)
CreateHook creates a Hook for the specified org. Name and Config are required fields.
GitHub API docs: https://developer.github.com/v3/orgs/hooks/#create-a-hook
func (s *OrganizationsService) CreateOrgInvitation(ctx context.Context, org string, opt *CreateOrgInvitationOptions) (*Invitation, *Response, error)
CreateOrgInvitation invites people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.
https://developer.github.com/v3/orgs/members/#create-organization-invitation
func (s *OrganizationsService) CreateProject(ctx context.Context, org string, opt *ProjectOptions) (*Project, *Response, error)
CreateProject creates a GitHub Project for the specified organization.
GitHub API docs: https://developer.github.com/v3/projects/#create-an-organization-project
func (s *OrganizationsService) DeleteHook(ctx context.Context, org string, id int64) (*Response, error)
DeleteHook deletes a specified Hook.
GitHub API docs: https://developer.github.com/v3/orgs/hooks/#delete-a-hook
func (s *OrganizationsService) Edit(ctx context.Context, name string, org *Organization) (*Organization, *Response, error)
Edit an organization.
GitHub API docs: https://developer.github.com/v3/orgs/#edit-an-organization
func (s *OrganizationsService) EditHook(ctx context.Context, org string, id int64, hook *Hook) (*Hook, *Response, error)
EditHook updates a specified Hook.
GitHub API docs: https://developer.github.com/v3/orgs/hooks/#edit-a-hook
func (s *OrganizationsService) EditOrgMembership(ctx context.Context, user, org string, membership *Membership) (*Membership, *Response, error)
EditOrgMembership edits the membership for user in specified organization. Passing an empty string for user will edit the membership for the authenticated user.
GitHub API docs: https://developer.github.com/v3/orgs/members/#add-or-update-organization-membership GitHub API docs: https://developer.github.com/v3/orgs/members/#edit-your-organization-membership
func (s *OrganizationsService) Get(ctx context.Context, org string) (*Organization, *Response, error)
Get fetches an organization by name.
GitHub API docs: https://developer.github.com/v3/orgs/#get-an-organization
func (s *OrganizationsService) GetByID(ctx context.Context, id int64) (*Organization, *Response, error)
GetByID fetches an organization.
Note: GetByID uses the undocumented GitHub API endpoint /organizations/:id.
func (s *OrganizationsService) GetHook(ctx context.Context, org string, id int64) (*Hook, *Response, error)
GetHook returns a single specified Hook.
GitHub API docs: https://developer.github.com/v3/orgs/hooks/#get-single-hook
func (s *OrganizationsService) GetOrgMembership(ctx context.Context, user, org string) (*Membership, *Response, error)
GetOrgMembership gets the membership for a user in a specified organization. Passing an empty string for user will get the membership for the authenticated user.
GitHub API docs: https://developer.github.com/v3/orgs/members/#get-organization-membership https://developer.github.com/v3/orgs/members/#get-your-organization-membership
func (s *OrganizationsService) IsBlocked(ctx context.Context, org string, user string) (bool, *Response, error)
IsBlocked reports whether specified user is blocked from an organization.
GitHub API docs: https://developer.github.com/v3/orgs/blocking/#check-whether-a-user-is-blocked-from-an-organization
func (s *OrganizationsService) IsMember(ctx context.Context, org, user string) (bool, *Response, error)
IsMember checks if a user is a member of an organization.
GitHub API docs: https://developer.github.com/v3/orgs/members/#check-membership
func (s *OrganizationsService) IsPublicMember(ctx context.Context, org, user string) (bool, *Response, error)
IsPublicMember checks if a user is a public member of an organization.
GitHub API docs: https://developer.github.com/v3/orgs/members/#check-public-membership
func (s *OrganizationsService) List(ctx context.Context, user string, opt *ListOptions) ([]*Organization, *Response, error)
List the organizations for a user. Passing the empty string will list organizations for the authenticated user.
GitHub API docs: https://developer.github.com/v3/orgs/#list-user-organizations
func (s *OrganizationsService) ListAll(ctx context.Context, opt *OrganizationsListOptions) ([]*Organization, *Response, error)
ListAll lists all organizations, in the order that they were created on GitHub.
Note: Pagination is powered exclusively by the since parameter. To continue listing the next set of organizations, use the ID of the last-returned organization as the opts.Since parameter for the next call.
GitHub API docs: https://developer.github.com/v3/orgs/#list-all-organizations
func (s *OrganizationsService) ListBlockedUsers(ctx context.Context, org string, opt *ListOptions) ([]*User, *Response, error)
ListBlockedUsers lists all the users blocked by an organization.
GitHub API docs: https://developer.github.com/v3/orgs/blocking/#list-blocked-users
func (s *OrganizationsService) ListHooks(ctx context.Context, org string, opt *ListOptions) ([]*Hook, *Response, error)
ListHooks lists all Hooks for the specified organization.
GitHub API docs: https://developer.github.com/v3/orgs/hooks/#list-hooks
func (s *OrganizationsService) ListMembers(ctx context.Context, org string, opt *ListMembersOptions) ([]*User, *Response, error)
ListMembers lists the members for an organization. If the authenticated user is an owner of the organization, this will return both concealed and public members, otherwise it will only return public members.
GitHub API docs: https://developer.github.com/v3/orgs/members/#members-list
func (s *OrganizationsService) ListOrgInvitationTeams(ctx context.Context, org, invitationID string, opt *ListOptions) ([]*Team, *Response, error)
ListOrgInvitationTeams lists all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner.
GitHub API docs: https://developer.github.com/v3/orgs/members/#list-organization-invitation-teams
func (s *OrganizationsService) ListOrgMemberships(ctx context.Context, opt *ListOrgMembershipsOptions) ([]*Membership, *Response, error)
ListOrgMemberships lists the organization memberships for the authenticated user.
GitHub API docs: https://developer.github.com/v3/orgs/members/#list-your-organization-memberships
func (s *OrganizationsService) ListOutsideCollaborators(ctx context.Context, org string, opt *ListOutsideCollaboratorsOptions) ([]*User, *Response, error)
ListOutsideCollaborators lists outside collaborators of organization's repositories. This will only work if the authenticated user is an owner of the organization.
Warning: The API may change without advance notice during the preview period. Preview features are not supported for production use.
GitHub API docs: https://developer.github.com/v3/orgs/outside_collaborators/#list-outside-collaborators
func (s *OrganizationsService) ListPendingOrgInvitations(ctx context.Context, org string, opt *ListOptions) ([]*Invitation, *Response, error)
ListPendingOrgInvitations returns a list of pending invitations.
GitHub API docs: https://developer.github.com/v3/orgs/members/#list-pending-organization-invitations
func (s *OrganizationsService) ListProjects(ctx context.Context, org string, opt *ProjectListOptions) ([]*Project, *Response, error)
ListProjects lists the projects for an organization.
GitHub API docs: https://developer.github.com/v3/projects/#list-organization-projects
func (s *OrganizationsService) PingHook(ctx context.Context, org string, id int64) (*Response, error)
PingHook triggers a 'ping' event to be sent to the Hook.
GitHub API docs: https://developer.github.com/v3/orgs/hooks/#ping-a-hook
func (s *OrganizationsService) PublicizeMembership(ctx context.Context, org, user string) (*Response, error)
PublicizeMembership publicizes a user's membership in an organization. (A user cannot publicize the membership for another user.)
GitHub API docs: https://developer.github.com/v3/orgs/members/#publicize-a-users-membership
func (s *OrganizationsService) RemoveMember(ctx context.Context, org, user string) (*Response, error)
RemoveMember removes a user from all teams of an organization.
GitHub API docs: https://developer.github.com/v3/orgs/members/#remove-a-member
func (s *OrganizationsService) RemoveOrgMembership(ctx context.Context, user, org string) (*Response, error)
RemoveOrgMembership removes user from the specified organization. If the user has been invited to the organization, this will cancel their invitation.
GitHub API docs: https://developer.github.com/v3/orgs/members/#remove-organization-membership
func (s *OrganizationsService) RemoveOutsideCollaborator(ctx context.Context, org string, user string) (*Response, error)
RemoveOutsideCollaborator removes a user from the list of outside collaborators; consequently, removing them from all the organization's repositories.
GitHub API docs: https://developer.github.com/v3/orgs/outside_collaborators/#remove-outside-collaborator
func (s *OrganizationsService) UnblockUser(ctx context.Context, org string, user string) (*Response, error)
UnblockUser unblocks specified user from an organization.
GitHub API docs: https://developer.github.com/v3/orgs/blocking/#unblock-a-user
type Page struct {
PageName *string `json:"page_name,omitempty"`
Title *string `json:"title,omitempty"`
Summary *string `json:"summary,omitempty"`
Action *string `json:"action,omitempty"`
SHA *string `json:"sha,omitempty"`
HTMLURL *string `json:"html_url,omitempty"`
}
Page represents a single Wiki page.
func (p *Page) GetAction() string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (p *Page) GetHTMLURL() string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (p *Page) GetPageName() string
GetPageName returns the PageName field if it's non-nil, zero value otherwise.
func (p *Page) GetSHA() string
GetSHA returns the SHA field if it's non-nil, zero value otherwise.
func (p *Page) GetSummary() string
GetSummary returns the Summary field if it's non-nil, zero value otherwise.
func (p *Page) GetTitle() string
GetTitle returns the Title field if it's non-nil, zero value otherwise.
type PageBuildEvent struct {
Build *PagesBuild `json:"build,omitempty"`
// The following fields are only populated by Webhook events.
ID *int64 `json:"id,omitempty"`
Repo *Repository `json:"repository,omitempty"`
Sender *User `json:"sender,omitempty"`
Installation *Installation `json:"installation,omitempty"`
}
PageBuildEvent represents an attempted build of a GitHub Pages site, whether successful or not. The Webhook event name is "page_build".
This event is triggered on push to a GitHub Pages enabled branch (gh-pages for project pages, master for user and organization pages).
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/#pagebuildevent
func (p *PageBuildEvent) GetBuild() *PagesBuild
GetBuild returns the Build field.
func (p *PageBuildEvent) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (p *PageBuildEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (p *PageBuildEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (p *PageBuildEvent) GetSender() *User
GetSender returns the Sender field.
type PageStats struct {
TotalPages *int `json:"total_pages,omitempty"`
}
PageStats represents the total number of github pages.
func (p *PageStats) GetTotalPages() int
GetTotalPages returns the TotalPages field if it's non-nil, zero value otherwise.
func (s PageStats) String() string
type Pages struct {
URL *string `json:"url,omitempty"`
Status *string `json:"status,omitempty"`
CNAME *string `json:"cname,omitempty"`
Custom404 *bool `json:"custom_404,omitempty"`
HTMLURL *string `json:"html_url,omitempty"`
}
Pages represents a GitHub Pages site configuration.
func (p *Pages) GetCNAME() string
GetCNAME returns the CNAME field if it's non-nil, zero value otherwise.
func (p *Pages) GetCustom404() bool
GetCustom404 returns the Custom404 field if it's non-nil, zero value otherwise.
func (p *Pages) GetHTMLURL() string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (p *Pages) GetStatus() string
GetStatus returns the Status field if it's non-nil, zero value otherwise.
func (p *Pages) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
type PagesBuild struct {
URL *string `json:"url,omitempty"`
Status *string `json:"status,omitempty"`
Error *PagesError `json:"error,omitempty"`
Pusher *User `json:"pusher,omitempty"`
Commit *string `json:"commit,omitempty"`
Duration *int `json:"duration,omitempty"`
CreatedAt *Timestamp `json:"created_at,omitempty"`
UpdatedAt *Timestamp `json:"updated_at,omitempty"`
}
PagesBuild represents the build information for a GitHub Pages site.
func (p *PagesBuild) GetCommit() string
GetCommit returns the Commit field if it's non-nil, zero value otherwise.
func (p *PagesBuild) GetCreatedAt() Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (p *PagesBuild) GetDuration() int
GetDuration returns the Duration field if it's non-nil, zero value otherwise.
func (p *PagesBuild) GetError() *PagesError
GetError returns the Error field.
func (p *PagesBuild) GetPusher() *User
GetPusher returns the Pusher field.
func (p *PagesBuild) GetStatus() string
GetStatus returns the Status field if it's non-nil, zero value otherwise.
func (p *PagesBuild) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (p *PagesBuild) GetUpdatedAt() Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
type PagesError struct {
Message *string `json:"message,omitempty"`
}
PagesError represents a build error for a GitHub Pages site.
func (p *PagesError) GetMessage() string
GetMessage returns the Message field if it's non-nil, zero value otherwise.
type PingEvent struct {
// Random string of GitHub zen.
Zen *string `json:"zen,omitempty"`
// The ID of the webhook that triggered the ping.
HookID *int64 `json:"hook_id,omitempty"`
// The webhook configuration.
Hook *Hook `json:"hook,omitempty"`
Installation *Installation `json:"installation,omitempty"`
}
PingEvent is triggered when a Webhook is added to GitHub.
GitHub API docs: https://developer.github.com/webhooks/#ping-event
func (p *PingEvent) GetHook() *Hook
GetHook returns the Hook field.
func (p *PingEvent) GetHookID() int64
GetHookID returns the HookID field if it's non-nil, zero value otherwise.
func (p *PingEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (p *PingEvent) GetZen() string
GetZen returns the Zen field if it's non-nil, zero value otherwise.
type Plan struct {
Name *string `json:"name,omitempty"`
Space *int `json:"space,omitempty"`
Collaborators *int `json:"collaborators,omitempty"`
PrivateRepos *int `json:"private_repos,omitempty"`
}
Plan represents the payment plan for an account. See plans at https://github.com/plans.
func (p *Plan) GetCollaborators() int
GetCollaborators returns the Collaborators field if it's non-nil, zero value otherwise.
func (p *Plan) GetName() string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (p *Plan) GetPrivateRepos() int
GetPrivateRepos returns the PrivateRepos field if it's non-nil, zero value otherwise.
func (p *Plan) GetSpace() int
GetSpace returns the Space field if it's non-nil, zero value otherwise.
func (p Plan) String() string
type PreReceiveHook struct {
ID *int64 `json:"id,omitempty"`
Name *string `json:"name,omitempty"`
Enforcement *string `json:"enforcement,omitempty"`
ConfigURL *string `json:"configuration_url,omitempty"`
}
PreReceiveHook represents a GitHub pre-receive hook for a repository.
func (p *PreReceiveHook) GetConfigURL() string
GetConfigURL returns the ConfigURL field if it's non-nil, zero value otherwise.
func (p *PreReceiveHook) GetEnforcement() string
GetEnforcement returns the Enforcement field if it's non-nil, zero value otherwise.
func (p *PreReceiveHook) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (p *PreReceiveHook) GetName() string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (p PreReceiveHook) String() string
type PreferenceList struct {
AutoTriggerChecks []*AutoTriggerCheck `json:"auto_trigger_checks,omitempty"` // A slice of auto trigger checks that can be set for a check suite in a repository.
}
PreferenceList represents a list of auto trigger checks for repository
type Project struct {
ID *int64 `json:"id,omitempty"`
URL *string `json:"url,omitempty"`
OwnerURL *string `json:"owner_url,omitempty"`
Name *string `json:"name,omitempty"`
Body *string `json:"body,omitempty"`
Number *int `json:"number,omitempty"`
CreatedAt *Timestamp `json:"created_at,omitempty"`
UpdatedAt *Timestamp `json:"updated_at,omitempty"`
NodeID *string `json:"node_id,omitempty"`
// The User object that generated the project.
Creator *User `json:"creator,omitempty"`
}
Project represents a GitHub Project.
func (p *Project) GetBody() string
GetBody returns the Body field if it's non-nil, zero value otherwise.
func (p *Project) GetCreatedAt() Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (p *Project) GetCreator() *User
GetCreator returns the Creator field.
func (p *Project) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (p *Project) GetName() string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (p *Project) GetNodeID() string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (p *Project) GetNumber() int
GetNumber returns the Number field if it's non-nil, zero value otherwise.
func (p *Project) GetOwnerURL() string
GetOwnerURL returns the OwnerURL field if it's non-nil, zero value otherwise.
func (p *Project) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (p *Project) GetUpdatedAt() Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (p Project) String() string
type ProjectCard struct {
URL *string `json:"url,omitempty"`
ColumnURL *string `json:"column_url,omitempty"`
ContentURL *string `json:"content_url,omitempty"`
ID *int64 `json:"id,omitempty"`
Note *string `json:"note,omitempty"`
Creator *User `json:"creator,omitempty"`
CreatedAt *Timestamp `json:"created_at,omitempty"`
UpdatedAt *Timestamp `json:"updated_at,omitempty"`
NodeID *string `json:"node_id,omitempty"`
Archived *bool `json:"archived,omitempty"`
// The following fields are only populated by Webhook events.
ColumnID *int64 `json:"column_id,omitempty"`
}
ProjectCard represents a card in a column of a GitHub Project.
GitHub API docs: https://developer.github.com/v3/projects/cards/#get-a-project-card
func (p *ProjectCard) GetArchived() bool
GetArchived returns the Archived field if it's non-nil, zero value otherwise.
func (p *ProjectCard) GetColumnID() int64
GetColumnID returns the ColumnID field if it's non-nil, zero value otherwise.
func (p *ProjectCard) GetColumnURL() string
GetColumnURL returns the ColumnURL field if it's non-nil, zero value otherwise.
func (p *ProjectCard) GetContentURL() string
GetContentURL returns the ContentURL field if it's non-nil, zero value otherwise.
func (p *ProjectCard) GetCreatedAt() Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (p *ProjectCard) GetCreator() *User
GetCreator returns the Creator field.
func (p *ProjectCard) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (p *ProjectCard) GetNodeID() string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (p *ProjectCard) GetNote() string
GetNote returns the Note field if it's non-nil, zero value otherwise.
func (p *ProjectCard) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (p *ProjectCard) GetUpdatedAt() Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
type ProjectCardChange struct {
Note *struct {
From *string `json:"from,omitempty"`
} `json:"note,omitempty"`
}
ProjectCardChange represents the changes when a project card has been edited.
type ProjectCardEvent struct {
Action *string `json:"action,omitempty"`
Changes *ProjectCardChange `json:"changes,omitempty"`
AfterID *int64 `json:"after_id,omitempty"`
ProjectCard *ProjectCard `json:"project_card,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"`
}
ProjectCardEvent is triggered when a project card is created, updated, moved, converted to an issue, or deleted. The webhook event name is "project_card".
GitHub API docs: https://developer.github.com/v3/activity/events/types/#projectcardevent
func (p *ProjectCardEvent) GetAction() string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (p *ProjectCardEvent) GetAfterID() int64
GetAfterID returns the AfterID field if it's non-nil, zero value otherwise.
func (p *ProjectCardEvent) GetChanges() *ProjectCardChange
GetChanges returns the Changes field.
func (p *ProjectCardEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (p *ProjectCardEvent) GetOrg() *Organization
GetOrg returns the Org field.
func (p *ProjectCardEvent) GetProjectCard() *ProjectCard
GetProjectCard returns the ProjectCard field.
func (p *ProjectCardEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (p *ProjectCardEvent) GetSender() *User
GetSender returns the Sender field.
type ProjectCardListOptions struct {
// ArchivedState is used to list all, archived, or not_archived project cards.
// Defaults to not_archived when you omit this parameter.
ArchivedState *string `url:"archived_state,omitempty"`
ListOptions
}
ProjectCardListOptions specifies the optional parameters to the ProjectsService.ListProjectCards method.
func (p *ProjectCardListOptions) GetArchivedState() string
GetArchivedState returns the ArchivedState field if it's non-nil, zero value otherwise.
type ProjectCardMoveOptions struct {
// Position can be one of "top", "bottom", or "after:<card-id>", where
// <card-id> is the ID of a card in the same project.
Position string `json:"position"`
// ColumnID is the ID of a column in the same project. Note that ColumnID
// is required when using Position "after:<card-id>" when that card is in
// another column; otherwise it is optional.
ColumnID int64 `json:"column_id,omitempty"`
}
ProjectCardMoveOptions specifies the parameters to the ProjectsService.MoveProjectCard method.
type ProjectCardOptions struct {
// The note of the card. Note and ContentID are mutually exclusive.
Note string `json:"note,omitempty"`
// The ID (not Number) of the Issue to associate with this card.
// Note and ContentID are mutually exclusive.
ContentID int64 `json:"content_id,omitempty"`
// The type of content to associate with this card. Possible values are: "Issue".
ContentType string `json:"content_type,omitempty"`
// Use true to archive a project card.
// Specify false if you need to restore a previously archived project card.
Archived *bool `json:"archived,omitempty"`
}
ProjectCardOptions specifies the parameters to the ProjectsService.CreateProjectCard and ProjectsService.UpdateProjectCard methods.
func (p *ProjectCardOptions) GetArchived() bool
GetArchived returns the Archived field if it's non-nil, zero value otherwise.
type ProjectChange struct {
Name *struct {
From *string `json:"from,omitempty"`
} `json:"name,omitempty"`
Body *struct {
From *string `json:"from,omitempty"`
} `json:"body,omitempty"`
}
ProjectChange represents the changes when a project has been edited.
type ProjectColumn struct {
ID *int64 `json:"id,omitempty"`
Name *string `json:"name,omitempty"`
ProjectURL *string `json:"project_url,omitempty"`
CreatedAt *Timestamp `json:"created_at,omitempty"`
UpdatedAt *Timestamp `json:"updated_at,omitempty"`
NodeID *string `json:"node_id,omitempty"`
}
ProjectColumn represents a column of a GitHub Project.
GitHub API docs: https://developer.github.com/v3/repos/projects/
func (p *ProjectColumn) GetCreatedAt() Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (p *ProjectColumn) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (p *ProjectColumn) GetName() string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (p *ProjectColumn) GetNodeID() string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (p *ProjectColumn) GetProjectURL() string
GetProjectURL returns the ProjectURL field if it's non-nil, zero value otherwise.
func (p *ProjectColumn) GetUpdatedAt() Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
type ProjectColumnChange struct {
Name *struct {
From *string `json:"from,omitempty"`
} `json:"name,omitempty"`
}
ProjectColumnChange represents the changes when a project column has been edited.
type ProjectColumnEvent struct {
Action *string `json:"action,omitempty"`
Changes *ProjectColumnChange `json:"changes,omitempty"`
AfterID *int64 `json:"after_id,omitempty"`
ProjectColumn *ProjectColumn `json:"project_column,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"`
}
ProjectColumnEvent is triggered when a project column is created, updated, moved, or deleted. The webhook event name is "project_column".
GitHub API docs: https://developer.github.com/v3/activity/events/types/#projectcolumnevent
func (p *ProjectColumnEvent) GetAction() string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (p *ProjectColumnEvent) GetAfterID() int64
GetAfterID returns the AfterID field if it's non-nil, zero value otherwise.
func (p *ProjectColumnEvent) GetChanges() *ProjectColumnChange
GetChanges returns the Changes field.
func (p *ProjectColumnEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (p *ProjectColumnEvent) GetOrg() *Organization
GetOrg returns the Org field.
func (p *ProjectColumnEvent) GetProjectColumn() *ProjectColumn
GetProjectColumn returns the ProjectColumn field.
func (p *ProjectColumnEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (p *ProjectColumnEvent) GetSender() *User
GetSender returns the Sender field.
type ProjectColumnMoveOptions struct {
// Position can be one of "first", "last", or "after:<column-id>", where
// <column-id> is the ID of a column in the same project. (Required.)
Position string `json:"position"`
}
ProjectColumnMoveOptions specifies the parameters to the ProjectsService.MoveProjectColumn method.
type ProjectColumnOptions struct {
// The name of the project column. (Required for creation and update.)
Name string `json:"name"`
}
ProjectColumnOptions specifies the parameters to the ProjectsService.CreateProjectColumn and ProjectsService.UpdateProjectColumn methods.
type ProjectEvent struct {
Action *string `json:"action,omitempty"`
Changes *ProjectChange `json:"changes,omitempty"`
Project *Project `json:"project,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"`
}
ProjectEvent is triggered when project is created, modified or deleted. The webhook event name is "project".
GitHub API docs: https://developer.github.com/v3/activity/events/types/#projectevent
func (p *ProjectEvent) GetAction() string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (p *ProjectEvent) GetChanges() *ProjectChange
GetChanges returns the Changes field.
func (p *ProjectEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (p *ProjectEvent) GetOrg() *Organization
GetOrg returns the Org field.
func (p *ProjectEvent) GetProject() *Project
GetProject returns the Project field.
func (p *ProjectEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (p *ProjectEvent) GetSender() *User
GetSender returns the Sender field.
type ProjectListOptions struct {
// Indicates the state of the projects to return. Can be either open, closed, or all. Default: open
State string `url:"state,omitempty"`
ListOptions
}
ProjectListOptions specifies the optional parameters to the OrganizationsService.ListProjects and RepositoriesService.ListProjects methods.
type ProjectOptions struct {
// The name of the project. (Required for creation; optional for update.)
Name string `json:"name,omitempty"`
// The body of the project. (Optional.)
Body string `json:"body,omitempty"`
// State of the project. Either "open" or "closed". (Optional.)
State string `json:"state,omitempty"`
}
ProjectOptions specifies the parameters to the RepositoriesService.CreateProject and ProjectsService.UpdateProject methods.
type ProjectsService service
ProjectsService provides access to the projects functions in the GitHub API.
GitHub API docs: https://developer.github.com/v3/projects/
func (s *ProjectsService) CreateProjectCard(ctx context.Context, columnID int64, opt *ProjectCardOptions) (*ProjectCard, *Response, error)
CreateProjectCard creates a card in the specified column of a GitHub Project.
GitHub API docs: https://developer.github.com/v3/projects/cards/#create-a-project-card
func (s *ProjectsService) CreateProjectColumn(ctx context.Context, projectID int64, opt *ProjectColumnOptions) (*ProjectColumn, *Response, error)
CreateProjectColumn creates a column for the specified (by number) project.
GitHub API docs: https://developer.github.com/v3/projects/columns/#create-a-project-column
func (s *ProjectsService) DeleteProject(ctx context.Context, id int64) (*Response, error)
DeleteProject deletes a GitHub Project from a repository.
GitHub API docs: https://developer.github.com/v3/projects/#delete-a-project
func (s *ProjectsService) DeleteProjectCard(ctx context.Context, cardID int64) (*Response, error)
DeleteProjectCard deletes a card from a GitHub Project.
GitHub API docs: https://developer.github.com/v3/projects/cards/#delete-a-project-card
func (s *ProjectsService) DeleteProjectColumn(ctx context.Context, columnID int64) (*Response, error)
DeleteProjectColumn deletes a column from a GitHub Project.
GitHub API docs: https://developer.github.com/v3/projects/columns/#delete-a-project-column
func (s *ProjectsService) GetProject(ctx context.Context, id int64) (*Project, *Response, error)
GetProject gets a GitHub Project for a repo.
GitHub API docs: https://developer.github.com/v3/projects/#get-a-project
func (s *ProjectsService) GetProjectCard(ctx context.Context, columnID int64) (*ProjectCard, *Response, error)
GetProjectCard gets a card in a column of a GitHub Project.
GitHub API docs: https://developer.github.com/v3/projects/cards/#get-a-project-card
func (s *ProjectsService) GetProjectColumn(ctx context.Context, id int64) (*ProjectColumn, *Response, error)
GetProjectColumn gets a column of a GitHub Project for a repo.
GitHub API docs: https://developer.github.com/v3/projects/columns/#get-a-project-column
func (s *ProjectsService) ListProjectCards(ctx context.Context, columnID int64, opt *ProjectCardListOptions) ([]*ProjectCard, *Response, error)
ListProjectCards lists the cards in a column of a GitHub Project.
GitHub API docs: https://developer.github.com/v3/projects/cards/#list-project-cards
func (s *ProjectsService) ListProjectColumns(ctx context.Context, projectID int64, opt *ListOptions) ([]*ProjectColumn, *Response, error)
ListProjectColumns lists the columns of a GitHub Project for a repo.
GitHub API docs: https://developer.github.com/v3/projects/columns/#list-project-columns
func (s *ProjectsService) MoveProjectCard(ctx context.Context, cardID int64, opt *ProjectCardMoveOptions) (*Response, error)
MoveProjectCard moves a card within a GitHub Project.
GitHub API docs: https://developer.github.com/v3/projects/cards/#move-a-project-card
func (s *ProjectsService) MoveProjectColumn(ctx context.Context, columnID int64, opt *ProjectColumnMoveOptions) (*Response, error)
MoveProjectColumn moves a column within a GitHub Project.
GitHub API docs: https://developer.github.com/v3/projects/columns/#move-a-project-column
func (s *ProjectsService) UpdateProject(ctx context.Context, id int64, opt *ProjectOptions) (*Project, *Response, error)
UpdateProject updates a repository project.
GitHub API docs: https://developer.github.com/v3/projects/#update-a-project
func (s *ProjectsService) UpdateProjectCard(ctx context.Context, cardID int64, opt *ProjectCardOptions) (*ProjectCard, *Response, error)
UpdateProjectCard updates a card of a GitHub Project.
GitHub API docs: https://developer.github.com/v3/projects/cards/#update-a-project-card
func (s *ProjectsService) UpdateProjectColumn(ctx context.Context, columnID int64, opt *ProjectColumnOptions) (*ProjectColumn, *Response, error)
UpdateProjectColumn updates a column of a GitHub Project.
GitHub API docs: https://developer.github.com/v3/projects/columns/#update-a-project-column
type Protection struct {
RequiredStatusChecks *RequiredStatusChecks `json:"required_status_checks"`
RequiredPullRequestReviews *PullRequestReviewsEnforcement `json:"required_pull_request_reviews"`
EnforceAdmins *AdminEnforcement `json:"enforce_admins"`
Restrictions *BranchRestrictions `json:"restrictions"`
}
Protection represents a repository branch's protection.
func (p *Protection) GetEnforceAdmins() *AdminEnforcement
GetEnforceAdmins returns the EnforceAdmins field.
func (p *Protection) GetRequiredPullRequestReviews() *PullRequestReviewsEnforcement
GetRequiredPullRequestReviews returns the RequiredPullRequestReviews field.
func (p *Protection) GetRequiredStatusChecks() *RequiredStatusChecks
GetRequiredStatusChecks returns the RequiredStatusChecks field.
func (p *Protection) GetRestrictions() *BranchRestrictions
GetRestrictions returns the Restrictions field.
type ProtectionRequest struct {
RequiredStatusChecks *RequiredStatusChecks `json:"required_status_checks"`
RequiredPullRequestReviews *PullRequestReviewsEnforcementRequest `json:"required_pull_request_reviews"`
EnforceAdmins bool `json:"enforce_admins"`
Restrictions *BranchRestrictionsRequest `json:"restrictions"`
}
ProtectionRequest represents a request to create/edit a branch's protection.
func (p *ProtectionRequest) GetRequiredPullRequestReviews() *PullRequestReviewsEnforcementRequest
GetRequiredPullRequestReviews returns the RequiredPullRequestReviews field.
func (p *ProtectionRequest) GetRequiredStatusChecks() *RequiredStatusChecks
GetRequiredStatusChecks returns the RequiredStatusChecks field.
func (p *ProtectionRequest) GetRestrictions() *BranchRestrictionsRequest
GetRestrictions returns the Restrictions field.
type PublicEvent struct {
// The following fields are only populated by Webhook events.
Repo *Repository `json:"repository,omitempty"`
Sender *User `json:"sender,omitempty"`
Installation *Installation `json:"installation,omitempty"`
}
PublicEvent is triggered when a private repository is open sourced. According to GitHub: "Without a doubt: the best GitHub event." The Webhook event name is "public".
GitHub API docs: https://developer.github.com/v3/activity/events/types/#publicevent
func (p *PublicEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (p *PublicEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (p *PublicEvent) GetSender() *User
GetSender returns the Sender field.
type PullRequest struct {
ID *int64 `json:"id,omitempty"`
Number *int `json:"number,omitempty"`
State *string `json:"state,omitempty"`
Title *string `json:"title,omitempty"`
Body *string `json:"body,omitempty"`
CreatedAt *time.Time `json:"created_at,omitempty"`
UpdatedAt *time.Time `json:"updated_at,omitempty"`
ClosedAt *time.Time `json:"closed_at,omitempty"`
MergedAt *time.Time `json:"merged_at,omitempty"`
Labels []*Label `json:"labels,omitempty"`
User *User `json:"user,omitempty"`
Merged *bool `json:"merged,omitempty"`
Mergeable *bool `json:"mergeable,omitempty"`
MergeableState *string `json:"mergeable_state,omitempty"`
MergedBy *User `json:"merged_by,omitempty"`
MergeCommitSHA *string `json:"merge_commit_sha,omitempty"`
Comments *int `json:"comments,omitempty"`
Commits *int `json:"commits,omitempty"`
Additions *int `json:"additions,omitempty"`
Deletions *int `json:"deletions,omitempty"`
ChangedFiles *int `json:"changed_files,omitempty"`
URL *string `json:"url,omitempty"`
HTMLURL *string `json:"html_url,omitempty"`
IssueURL *string `json:"issue_url,omitempty"`
StatusesURL *string `json:"statuses_url,omitempty"`
DiffURL *string `json:"diff_url,omitempty"`
PatchURL *string `json:"patch_url,omitempty"`
CommitsURL *string `json:"commits_url,omitempty"`
CommentsURL *string `json:"comments_url,omitempty"`
ReviewCommentsURL *string `json:"review_comments_url,omitempty"`
ReviewCommentURL *string `json:"review_comment_url,omitempty"`
Assignee *User `json:"assignee,omitempty"`
Assignees []*User `json:"assignees,omitempty"`
Milestone *Milestone `json:"milestone,omitempty"`
MaintainerCanModify *bool `json:"maintainer_can_modify,omitempty"`
AuthorAssociation *string `json:"author_association,omitempty"`
NodeID *string `json:"node_id,omitempty"`
RequestedReviewers []*User `json:"requested_reviewers,omitempty"`
Head *PullRequestBranch `json:"head,omitempty"`
Base *PullRequestBranch `json:"base,omitempty"`
// ActiveLockReason is populated only when LockReason is provided while locking the pull request.
// Possible values are: "off-topic", "too heated", "resolved", and "spam".
ActiveLockReason *string `json:"active_lock_reason,omitempty"`
}
PullRequest represents a GitHub pull request on a repository.
func (p *PullRequest) GetActiveLockReason() string
GetActiveLockReason returns the ActiveLockReason field if it's non-nil, zero value otherwise.
func (p *PullRequest) GetAdditions() int
GetAdditions returns the Additions field if it's non-nil, zero value otherwise.
func (p *PullRequest) GetAssignee() *User
GetAssignee returns the Assignee field.
func (p *PullRequest) GetAuthorAssociation() string
GetAuthorAssociation returns the AuthorAssociation field if it's non-nil, zero value otherwise.
func (p *PullRequest) GetBase() *PullRequestBranch
GetBase returns the Base field.
func (p *PullRequest) GetBody() string
GetBody returns the Body field if it's non-nil, zero value otherwise.
func (p *PullRequest) GetChangedFiles() int
GetChangedFiles returns the ChangedFiles field if it's non-nil, zero value otherwise.
func (p *PullRequest) GetClosedAt() time.Time
GetClosedAt returns the ClosedAt field if it's non-nil, zero value otherwise.
func (p *PullRequest) GetComments() int
GetComments returns the Comments field if it's non-nil, zero value otherwise.
func (p *PullRequest) GetCommentsURL() string
GetCommentsURL returns the CommentsURL field if it's non-nil, zero value otherwise.
func (p *PullRequest) GetCommits() int
GetCommits returns the Commits field if it's non-nil, zero value otherwise.
func (p *PullRequest) GetCommitsURL() string
GetCommitsURL returns the CommitsURL field if it's non-nil, zero value otherwise.
func (p *PullRequest) GetCreatedAt() time.Time
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (p *PullRequest) GetDeletions() int
GetDeletions returns the Deletions field if it's non-nil, zero value otherwise.
func (p *PullRequest) GetDiffURL() string
GetDiffURL returns the DiffURL field if it's non-nil, zero value otherwise.
func (p *PullRequest) GetHTMLURL() string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (p *PullRequest) GetHead() *PullRequestBranch
GetHead returns the Head field.
func (p *PullRequest) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (p *PullRequest) GetIssueURL() string
GetIssueURL returns the IssueURL field if it's non-nil, zero value otherwise.
func (p *PullRequest) GetMaintainerCanModify() bool
GetMaintainerCanModify returns the MaintainerCanModify field if it's non-nil, zero value otherwise.
func (p *PullRequest) GetMergeCommitSHA() string
GetMergeCommitSHA returns the MergeCommitSHA field if it's non-nil, zero value otherwise.
func (p *PullRequest) GetMergeable() bool
GetMergeable returns the Mergeable field if it's non-nil, zero value otherwise.
func (p *PullRequest) GetMergeableState() string
GetMergeableState returns the MergeableState field if it's non-nil, zero value otherwise.
func (p *PullRequest) GetMerged() bool
GetMerged returns the Merged field if it's non-nil, zero value otherwise.
func (p *PullRequest) GetMergedAt() time.Time
GetMergedAt returns the MergedAt field if it's non-nil, zero value otherwise.
func (p *PullRequest) GetMergedBy() *User
GetMergedBy returns the MergedBy field.
func (p *PullRequest) GetMilestone() *Milestone
GetMilestone returns the Milestone field.
func (p *PullRequest) GetNodeID() string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (p *PullRequest) GetNumber() int
GetNumber returns the Number field if it's non-nil, zero value otherwise.
func (p *PullRequest) GetPatchURL() string
GetPatchURL returns the PatchURL field if it's non-nil, zero value otherwise.
func (p *PullRequest) GetReviewCommentURL() string
GetReviewCommentURL returns the ReviewCommentURL field if it's non-nil, zero value otherwise.
func (p *PullRequest) GetReviewCommentsURL() string
GetReviewCommentsURL returns the ReviewCommentsURL field if it's non-nil, zero value otherwise.
func (p *PullRequest) GetState() string
GetState returns the State field if it's non-nil, zero value otherwise.
func (p *PullRequest) GetStatusesURL() string
GetStatusesURL returns the StatusesURL field if it's non-nil, zero value otherwise.
func (p *PullRequest) GetTitle() string
GetTitle returns the Title field if it's non-nil, zero value otherwise.
func (p *PullRequest) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (p *PullRequest) GetUpdatedAt() time.Time
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (p *PullRequest) GetUser() *User
GetUser returns the User field.
func (p PullRequest) String() string
type PullRequestBranch struct {
Label *string `json:"label,omitempty"`
Ref *string `json:"ref,omitempty"`
SHA *string `json:"sha,omitempty"`
Repo *Repository `json:"repo,omitempty"`
User *User `json:"user,omitempty"`
}
PullRequestBranch represents a base or head branch in a GitHub pull request.
func (p *PullRequestBranch) GetLabel() string
GetLabel returns the Label field if it's non-nil, zero value otherwise.
func (p *PullRequestBranch) GetRef() string
GetRef returns the Ref field if it's non-nil, zero value otherwise.
func (p *PullRequestBranch) GetRepo() *Repository
GetRepo returns the Repo field.
func (p *PullRequestBranch) GetSHA() string
GetSHA returns the SHA field if it's non-nil, zero value otherwise.
func (p *PullRequestBranch) GetUser() *User
GetUser returns the User field.
type PullRequestComment struct {
ID *int64 `json:"id,omitempty"`
InReplyTo *int64 `json:"in_reply_to_id,omitempty"`
Body *string `json:"body,omitempty"`
Path *string `json:"path,omitempty"`
DiffHunk *string `json:"diff_hunk,omitempty"`
PullRequestReviewID *int64 `json:"pull_request_review_id,omitempty"`
Position *int `json:"position,omitempty"`
OriginalPosition *int `json:"original_position,omitempty"`
CommitID *string `json:"commit_id,omitempty"`
OriginalCommitID *string `json:"original_commit_id,omitempty"`
User *User `json:"user,omitempty"`
Reactions *Reactions `json:"reactions,omitempty"`
CreatedAt *time.Time `json:"created_at,omitempty"`
UpdatedAt *time.Time `json:"updated_at,omitempty"`
// AuthorAssociation is the comment author's relationship to the pull request's repository.
// Possible values are "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MEMBER", "OWNER", or "NONE".
AuthorAssociation *string `json:"author_association,omitempty"`
URL *string `json:"url,omitempty"`
HTMLURL *string `json:"html_url,omitempty"`
PullRequestURL *string `json:"pull_request_url,omitempty"`
}
PullRequestComment represents a comment left on a pull request.
func (p *PullRequestComment) GetAuthorAssociation() string
GetAuthorAssociation returns the AuthorAssociation field if it's non-nil, zero value otherwise.
func (p *PullRequestComment) GetBody() string
GetBody returns the Body field if it's non-nil, zero value otherwise.
func (p *PullRequestComment) GetCommitID() string
GetCommitID returns the CommitID field if it's non-nil, zero value otherwise.
func (p *PullRequestComment) GetCreatedAt() time.Time
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (p *PullRequestComment) GetDiffHunk() string
GetDiffHunk returns the DiffHunk field if it's non-nil, zero value otherwise.
func (p *PullRequestComment) GetHTMLURL() string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (p *PullRequestComment) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (p *PullRequestComment) GetInReplyTo() int64
GetInReplyTo returns the InReplyTo field if it's non-nil, zero value otherwise.
func (p *PullRequestComment) GetOriginalCommitID() string
GetOriginalCommitID returns the OriginalCommitID field if it's non-nil, zero value otherwise.
func (p *PullRequestComment) GetOriginalPosition() int
GetOriginalPosition returns the OriginalPosition field if it's non-nil, zero value otherwise.
func (p *PullRequestComment) GetPath() string
GetPath returns the Path field if it's non-nil, zero value otherwise.
func (p *PullRequestComment) GetPosition() int
GetPosition returns the Position field if it's non-nil, zero value otherwise.
func (p *PullRequestComment) GetPullRequestReviewID() int64
GetPullRequestReviewID returns the PullRequestReviewID field if it's non-nil, zero value otherwise.
func (p *PullRequestComment) GetPullRequestURL() string
GetPullRequestURL returns the PullRequestURL field if it's non-nil, zero value otherwise.
func (p *PullRequestComment) GetReactions() *Reactions
GetReactions returns the Reactions field.
func (p *PullRequestComment) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (p *PullRequestComment) GetUpdatedAt() time.Time
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (p *PullRequestComment) GetUser() *User
GetUser returns the User field.
func (p PullRequestComment) String() string
type PullRequestEvent struct {
// Action is the action that was performed. Possible values are:
// "assigned", "unassigned", "review_requested", "review_request_removed", "labeled", "unlabeled",
// "opened", "closed", "reopened", "synchronize", "edited".
// If the action is "closed" and the merged key is false,
// the pull request was closed with unmerged commits. If the action is "closed"
// and the merged key is true, the pull request was merged.
Action *string `json:"action,omitempty"`
Number *int `json:"number,omitempty"`
PullRequest *PullRequest `json:"pull_request,omitempty"`
// The following fields are only populated by Webhook events.
Changes *EditChange `json:"changes,omitempty"`
// RequestedReviewer is populated in "review_requested", "review_request_removed" event deliveries.
// A request affecting multiple reviewers at once is split into multiple
// such event deliveries, each with a single, different RequestedReviewer.
RequestedReviewer *User `json:"requested_reviewer,omitempty"`
Repo *Repository `json:"repository,omitempty"`
Sender *User `json:"sender,omitempty"`
Installation *Installation `json:"installation,omitempty"`
Label *Label `json:"label,omitempty"` // Populated in "labeled" event deliveries.
}
PullRequestEvent is triggered when a pull request is assigned, unassigned, labeled, unlabeled, opened, closed, reopened, or synchronized. The Webhook event name is "pull_request".
GitHub API docs: https://developer.github.com/v3/activity/events/types/#pullrequestevent
func (p *PullRequestEvent) GetAction() string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (p *PullRequestEvent) GetChanges() *EditChange
GetChanges returns the Changes field.
func (p *PullRequestEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (p *PullRequestEvent) GetLabel() *Label
GetLabel returns the Label field.
func (p *PullRequestEvent) GetNumber() int
GetNumber returns the Number field if it's non-nil, zero value otherwise.
func (p *PullRequestEvent) GetPullRequest() *PullRequest
GetPullRequest returns the PullRequest field.
func (p *PullRequestEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (p *PullRequestEvent) GetRequestedReviewer() *User
GetRequestedReviewer returns the RequestedReviewer field.
func (p *PullRequestEvent) GetSender() *User
GetSender returns the Sender field.
type PullRequestLinks struct {
URL *string `json:"url,omitempty"`
HTMLURL *string `json:"html_url,omitempty"`
DiffURL *string `json:"diff_url,omitempty"`
PatchURL *string `json:"patch_url,omitempty"`
}
PullRequestLinks object is added to the Issue object when it's an issue included in the IssueCommentEvent webhook payload, if the webhook is fired by a comment on a PR.
func (p *PullRequestLinks) GetDiffURL() string
GetDiffURL returns the DiffURL field if it's non-nil, zero value otherwise.
func (p *PullRequestLinks) GetHTMLURL() string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (p *PullRequestLinks) GetPatchURL() string
GetPatchURL returns the PatchURL field if it's non-nil, zero value otherwise.
func (p *PullRequestLinks) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
type PullRequestListCommentsOptions struct {
// Sort specifies how to sort comments. Possible values are: created, updated.
Sort string `url:"sort,omitempty"`
// Direction in which to sort comments. Possible values are: asc, desc.
Direction string `url:"direction,omitempty"`
// Since filters comments by time.
Since time.Time `url:"since,omitempty"`
ListOptions
}
PullRequestListCommentsOptions specifies the optional parameters to the PullRequestsService.ListComments method.
type PullRequestListOptions struct {
// State filters pull requests based on their state. Possible values are:
// open, closed. Default is "open".
State string `url:"state,omitempty"`
// Head filters pull requests by head user and branch name in the format of:
// "user:ref-name".
Head string `url:"head,omitempty"`
// Base filters pull requests by base branch name.
Base string `url:"base,omitempty"`
// Sort specifies how to sort pull requests. Possible values are: created,
// updated, popularity, long-running. Default is "created".
Sort string `url:"sort,omitempty"`
// Direction in which to sort pull requests. Possible values are: asc, desc.
// If Sort is "created" or not specified, Default is "desc", otherwise Default
// is "asc"
Direction string `url:"direction,omitempty"`
ListOptions
}
PullRequestListOptions specifies the optional parameters to the PullRequestsService.List method.
type PullRequestMergeResult struct {
SHA *string `json:"sha,omitempty"`
Merged *bool `json:"merged,omitempty"`
Message *string `json:"message,omitempty"`
}
PullRequestMergeResult represents the result of merging a pull request.
func (p *PullRequestMergeResult) GetMerged() bool
GetMerged returns the Merged field if it's non-nil, zero value otherwise.
func (p *PullRequestMergeResult) GetMessage() string
GetMessage returns the Message field if it's non-nil, zero value otherwise.
func (p *PullRequestMergeResult) GetSHA() string
GetSHA returns the SHA field if it's non-nil, zero value otherwise.
type PullRequestOptions struct {
CommitTitle string // Extra detail to append to automatic commit message. (Optional.)
SHA string // SHA that pull request head must match to allow merge. (Optional.)
// The merge method to use. Possible values include: "merge", "squash", and "rebase" with the default being merge. (Optional.)
MergeMethod string
}
PullRequestOptions lets you define how a pull request will be merged.
type PullRequestReview struct {
ID *int64 `json:"id,omitempty"`
User *User `json:"user,omitempty"`
Body *string `json:"body,omitempty"`
SubmittedAt *time.Time `json:"submitted_at,omitempty"`
CommitID *string `json:"commit_id,omitempty"`
HTMLURL *string `json:"html_url,omitempty"`
PullRequestURL *string `json:"pull_request_url,omitempty"`
State *string `json:"state,omitempty"`
}
PullRequestReview represents a review of a pull request.
func (p *PullRequestReview) GetBody() string
GetBody returns the Body field if it's non-nil, zero value otherwise.
func (p *PullRequestReview) GetCommitID() string
GetCommitID returns the CommitID field if it's non-nil, zero value otherwise.
func (p *PullRequestReview) GetHTMLURL() string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (p *PullRequestReview) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (p *PullRequestReview) GetPullRequestURL() string
GetPullRequestURL returns the PullRequestURL field if it's non-nil, zero value otherwise.
func (p *PullRequestReview) GetState() string
GetState returns the State field if it's non-nil, zero value otherwise.
func (p *PullRequestReview) GetSubmittedAt() time.Time
GetSubmittedAt returns the SubmittedAt field if it's non-nil, zero value otherwise.
func (p *PullRequestReview) GetUser() *User
GetUser returns the User field.
func (p PullRequestReview) String() string
type PullRequestReviewCommentEvent struct {
// Action is the action that was performed on the comment.
// Possible values are: "created", "edited", "deleted".
Action *string `json:"action,omitempty"`
PullRequest *PullRequest `json:"pull_request,omitempty"`
Comment *PullRequestComment `json:"comment,omitempty"`
// The following fields are only populated by Webhook events.
Changes *EditChange `json:"changes,omitempty"`
Repo *Repository `json:"repository,omitempty"`
Sender *User `json:"sender,omitempty"`
Installation *Installation `json:"installation,omitempty"`
}
PullRequestReviewCommentEvent is triggered when a comment is created on a portion of the unified diff of a pull request. The Webhook event name is "pull_request_review_comment".
GitHub API docs: https://developer.github.com/v3/activity/events/types/#pullrequestreviewcommentevent
func (p *PullRequestReviewCommentEvent) GetAction() string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (p *PullRequestReviewCommentEvent) GetChanges() *EditChange
GetChanges returns the Changes field.
func (p *PullRequestReviewCommentEvent) GetComment() *PullRequestComment
GetComment returns the Comment field.
func (p *PullRequestReviewCommentEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (p *PullRequestReviewCommentEvent) GetPullRequest() *PullRequest
GetPullRequest returns the PullRequest field.
func (p *PullRequestReviewCommentEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (p *PullRequestReviewCommentEvent) GetSender() *User
GetSender returns the Sender field.
type PullRequestReviewDismissalRequest struct {
Message *string `json:"message,omitempty"`
}
PullRequestReviewDismissalRequest represents a request to dismiss a review.
func (p *PullRequestReviewDismissalRequest) GetMessage() string
GetMessage returns the Message field if it's non-nil, zero value otherwise.
func (r PullRequestReviewDismissalRequest) String() string
type PullRequestReviewEvent struct {
// Action is always "submitted".
Action *string `json:"action,omitempty"`
Review *PullRequestReview `json:"review,omitempty"`
PullRequest *PullRequest `json:"pull_request,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"`
// The following field is only present when the webhook is triggered on
// a repository belonging to an organization.
Organization *Organization `json:"organization,omitempty"`
}
PullRequestReviewEvent is triggered when a review is submitted on a pull request. The Webhook event name is "pull_request_review".
GitHub API docs: https://developer.github.com/v3/activity/events/types/#pullrequestreviewevent
func (p *PullRequestReviewEvent) GetAction() string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (p *PullRequestReviewEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (p *PullRequestReviewEvent) GetOrganization() *Organization
GetOrganization returns the Organization field.
func (p *PullRequestReviewEvent) GetPullRequest() *PullRequest
GetPullRequest returns the PullRequest field.
func (p *PullRequestReviewEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (p *PullRequestReviewEvent) GetReview() *PullRequestReview
GetReview returns the Review field.
func (p *PullRequestReviewEvent) GetSender() *User
GetSender returns the Sender field.
type PullRequestReviewRequest struct {
CommitID *string `json:"commit_id,omitempty"`
Body *string `json:"body,omitempty"`
Event *string `json:"event,omitempty"`
Comments []*DraftReviewComment `json:"comments,omitempty"`
}
PullRequestReviewRequest represents a request to create a review.
func (p *PullRequestReviewRequest) GetBody() string
GetBody returns the Body field if it's non-nil, zero value otherwise.
func (p *PullRequestReviewRequest) GetCommitID() string
GetCommitID returns the CommitID field if it's non-nil, zero value otherwise.
func (p *PullRequestReviewRequest) GetEvent() string
GetEvent returns the Event field if it's non-nil, zero value otherwise.
func (r PullRequestReviewRequest) String() string
type PullRequestReviewsEnforcement struct {
// Specifies which users and teams can dismiss pull request reviews.
DismissalRestrictions DismissalRestrictions `json:"dismissal_restrictions"`
// Specifies if approved reviews are dismissed automatically, when a new commit is pushed.
DismissStaleReviews bool `json:"dismiss_stale_reviews"`
// RequireCodeOwnerReviews specifies if an approved review is required in pull requests including files with a designated code owner.
RequireCodeOwnerReviews bool `json:"require_code_owner_reviews"`
// RequiredApprovingReviewCount specifies the number of approvals required before the pull request can be merged.
// Valid values are 1-6.
RequiredApprovingReviewCount int `json:"required_approving_review_count"`
}
PullRequestReviewsEnforcement represents the pull request reviews enforcement of a protected branch.
type PullRequestReviewsEnforcementRequest struct {
// Specifies which users and teams should be allowed to dismiss pull request reviews.
// User and team dismissal restrictions are only available for
// organization-owned repositories. Must be nil for personal repositories.
DismissalRestrictionsRequest *DismissalRestrictionsRequest `json:"dismissal_restrictions,omitempty"`
// Specifies if approved reviews can be dismissed automatically, when a new commit is pushed. (Required)
DismissStaleReviews bool `json:"dismiss_stale_reviews"`
// RequireCodeOwnerReviews specifies if an approved review is required in pull requests including files with a designated code owner.
RequireCodeOwnerReviews bool `json:"require_code_owner_reviews"`
// RequiredApprovingReviewCount specifies the number of approvals required before the pull request can be merged.
// Valid values are 1-6.
RequiredApprovingReviewCount int `json:"required_approving_review_count"`
}
PullRequestReviewsEnforcementRequest represents request to set the pull request review enforcement of a protected branch. It is separate from PullRequestReviewsEnforcement above because the request structure is different from the response structure.
func (p *PullRequestReviewsEnforcementRequest) GetDismissalRestrictionsRequest() *DismissalRestrictionsRequest
GetDismissalRestrictionsRequest returns the DismissalRestrictionsRequest field.
type PullRequestReviewsEnforcementUpdate struct {
// Specifies which users and teams can dismiss pull request reviews. Can be omitted.
DismissalRestrictionsRequest *DismissalRestrictionsRequest `json:"dismissal_restrictions,omitempty"`
// Specifies if approved reviews can be dismissed automatically, when a new commit is pushed. Can be omitted.
DismissStaleReviews *bool `json:"dismiss_stale_reviews,omitempty"`
// RequireCodeOwnerReviews specifies if an approved review is required in pull requests including files with a designated code owner.
RequireCodeOwnerReviews bool `json:"require_code_owner_reviews,omitempty"`
// RequiredApprovingReviewCount specifies the number of approvals required before the pull request can be merged.
// Valid values are 1 - 6.
RequiredApprovingReviewCount int `json:"required_approving_review_count"`
}
PullRequestReviewsEnforcementUpdate represents request to patch the pull request review enforcement of a protected branch. It is separate from PullRequestReviewsEnforcementRequest above because the patch request does not require all fields to be initialized.
func (p *PullRequestReviewsEnforcementUpdate) GetDismissStaleReviews() bool
GetDismissStaleReviews returns the DismissStaleReviews field if it's non-nil, zero value otherwise.
func (p *PullRequestReviewsEnforcementUpdate) GetDismissalRestrictionsRequest() *DismissalRestrictionsRequest
GetDismissalRestrictionsRequest returns the DismissalRestrictionsRequest field.
type PullRequestsService service
PullRequestsService handles communication with the pull request related methods of the GitHub API.
GitHub API docs: https://developer.github.com/v3/pulls/
func (s *PullRequestsService) Create(ctx context.Context, owner string, repo string, pull *NewPullRequest) (*PullRequest, *Response, error)
Create a new pull request on the specified repository.
GitHub API docs: https://developer.github.com/v3/pulls/#create-a-pull-request
Code:
package main
import (
"context"
"fmt"
"github.com/google/go-github/github"
)
func main() {
// In this example we're creating a PR and displaying the HTML url at the end.
// Note that authentication is needed here as you are performing a modification
// so you will need to modify the example to provide an oauth client to
// github.NewClient() instead of nil. See the following documentation for more
// information on how to authenticate with the client:
// https://godoc.org/github.com/google/go-github/github#hdr-Authentication
client := github.NewClient(nil)
newPR := &github.NewPullRequest{
Title: github.String("My awesome pull request"),
Head: github.String("branch_to_merge"),
Base: github.String("master"),
Body: github.String("This is the description of the PR created with the package `github.com/google/go-github/github`"),
MaintainerCanModify: github.Bool(true),
}
pr, _, err := client.PullRequests.Create(context.Background(), "myOrganization", "myRepository", newPR)
if err != nil {
fmt.Println(err)
return
}
fmt.Printf("PR created: %s\n", pr.GetHTMLURL())
}
func (s *PullRequestsService) CreateComment(ctx context.Context, owner string, repo string, number int, comment *PullRequestComment) (*PullRequestComment, *Response, error)
CreateComment creates a new comment on the specified pull request.
GitHub API docs: https://developer.github.com/v3/pulls/comments/#create-a-comment
func (s *PullRequestsService) CreateCommentInReplyTo(ctx context.Context, owner string, repo string, number int, body string, commentID int64) (*PullRequestComment, *Response, error)
CreateCommentInReplyTo creates a new comment as a reply to an existing pull request comment.
GitHub API docs: https://developer.github.com/v3/pulls/comments/#alternative-input
func (s *PullRequestsService) CreateReview(ctx context.Context, owner, repo string, number int, review *PullRequestReviewRequest) (*PullRequestReview, *Response, error)
CreateReview creates a new review on the specified pull request.
TODO: Follow up with GitHub support about an issue with this method's returned error format and remove this comment once it's fixed. Read more about it here - https://github.com/google/go-github/issues/540
GitHub API docs: https://developer.github.com/v3/pulls/reviews/#create-a-pull-request-review
func (s *PullRequestsService) DeleteComment(ctx context.Context, owner string, repo string, commentID int64) (*Response, error)
DeleteComment deletes a pull request comment.
GitHub API docs: https://developer.github.com/v3/pulls/comments/#delete-a-comment
func (s *PullRequestsService) DeletePendingReview(ctx context.Context, owner, repo string, number int, reviewID int64) (*PullRequestReview, *Response, error)
DeletePendingReview deletes the specified pull request pending review.
TODO: Follow up with GitHub support about an issue with this method's returned error format and remove this comment once it's fixed. Read more about it here - https://github.com/google/go-github/issues/540
GitHub API docs: https://developer.github.com/v3/pulls/reviews/#delete-a-pending-review
func (s *PullRequestsService) DismissReview(ctx context.Context, owner, repo string, number int, reviewID int64, review *PullRequestReviewDismissalRequest) (*PullRequestReview, *Response, error)
DismissReview dismisses a specified review on the specified pull request.
TODO: Follow up with GitHub support about an issue with this method's returned error format and remove this comment once it's fixed. Read more about it here - https://github.com/google/go-github/issues/540
GitHub API docs: https://developer.github.com/v3/pulls/reviews/#dismiss-a-pull-request-review
func (s *PullRequestsService) Edit(ctx context.Context, owner string, repo string, number int, pull *PullRequest) (*PullRequest, *Response, error)
Edit a pull request. pull must not be nil.
The following fields are editable: Title, Body, State, Base.Ref and MaintainerCanModify. Base.Ref updates the base branch of the pull request.
GitHub API docs: https://developer.github.com/v3/pulls/#update-a-pull-request
func (s *PullRequestsService) EditComment(ctx context.Context, owner string, repo string, commentID int64, comment *PullRequestComment) (*PullRequestComment, *Response, error)
EditComment updates a pull request comment. A non-nil comment.Body must be provided. Other comment fields should be left nil.
GitHub API docs: https://developer.github.com/v3/pulls/comments/#edit-a-comment
func (s *PullRequestsService) Get(ctx context.Context, owner string, repo string, number int) (*PullRequest, *Response, error)
Get a single pull request.
GitHub API docs: https://developer.github.com/v3/pulls/#get-a-single-pull-request
func (s *PullRequestsService) GetComment(ctx context.Context, owner string, repo string, commentID int64) (*PullRequestComment, *Response, error)
GetComment fetches the specified pull request comment.
GitHub API docs: https://developer.github.com/v3/pulls/comments/#get-a-single-comment
func (s *PullRequestsService) GetRaw(ctx context.Context, owner string, repo string, number int, opt RawOptions) (string, *Response, error)
GetRaw gets a single pull request in raw (diff or patch) format.
func (s *PullRequestsService) GetReview(ctx context.Context, owner, repo string, number int, reviewID int64) (*PullRequestReview, *Response, error)
GetReview fetches the specified pull request review.
TODO: Follow up with GitHub support about an issue with this method's returned error format and remove this comment once it's fixed. Read more about it here - https://github.com/google/go-github/issues/540
GitHub API docs: https://developer.github.com/v3/pulls/reviews/#get-a-single-review
func (s *PullRequestsService) IsMerged(ctx context.Context, owner string, repo string, number int) (bool, *Response, error)
IsMerged checks if a pull request has been merged.
GitHub API docs: https://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged
func (s *PullRequestsService) List(ctx context.Context, owner string, repo string, opt *PullRequestListOptions) ([]*PullRequest, *Response, error)
List the pull requests for the specified repository.
GitHub API docs: https://developer.github.com/v3/pulls/#list-pull-requests
func (s *PullRequestsService) ListComments(ctx context.Context, owner string, repo string, number int, opt *PullRequestListCommentsOptions) ([]*PullRequestComment, *Response, error)
ListComments lists all comments on the specified pull request. Specifying a pull request number of 0 will return all comments on all pull requests for the repository.
GitHub API docs: https://developer.github.com/v3/pulls/comments/#list-comments-on-a-pull-request
func (s *PullRequestsService) ListCommits(ctx context.Context, owner string, repo string, number int, opt *ListOptions) ([]*RepositoryCommit, *Response, error)
ListCommits lists the commits in a pull request.
GitHub API docs: https://developer.github.com/v3/pulls/#list-commits-on-a-pull-request
func (s *PullRequestsService) ListFiles(ctx context.Context, owner string, repo string, number int, opt *ListOptions) ([]*CommitFile, *Response, error)
ListFiles lists the files in a pull request.
GitHub API docs: https://developer.github.com/v3/pulls/#list-pull-requests-files
func (s *PullRequestsService) ListReviewComments(ctx context.Context, owner, repo string, number int, reviewID int64, opt *ListOptions) ([]*PullRequestComment, *Response, error)
ListReviewComments lists all the comments for the specified review.
TODO: Follow up with GitHub support about an issue with this method's returned error format and remove this comment once it's fixed. Read more about it here - https://github.com/google/go-github/issues/540
GitHub API docs: https://developer.github.com/v3/pulls/reviews/#get-comments-for-a-single-review
func (s *PullRequestsService) ListReviewers(ctx context.Context, owner, repo string, number int, opt *ListOptions) (*Reviewers, *Response, error)
ListReviewers lists reviewers whose reviews have been requested on the specified pull request.
GitHub API docs: https://developer.github.com/v3/pulls/review_requests/#list-review-requests
func (s *PullRequestsService) ListReviews(ctx context.Context, owner, repo string, number int, opt *ListOptions) ([]*PullRequestReview, *Response, error)
ListReviews lists all reviews on the specified pull request.
TODO: Follow up with GitHub support about an issue with this method's returned error format and remove this comment once it's fixed. Read more about it here - https://github.com/google/go-github/issues/540
GitHub API docs: https://developer.github.com/v3/pulls/reviews/#list-reviews-on-a-pull-request
func (s *PullRequestsService) Merge(ctx context.Context, owner string, repo string, number int, commitMessage string, options *PullRequestOptions) (*PullRequestMergeResult, *Response, error)
Merge a pull request (Merge Button™). commitMessage is the title for the automatic commit message.
GitHub API docs: https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-buttontrade
func (s *PullRequestsService) RemoveReviewers(ctx context.Context, owner, repo string, number int, reviewers ReviewersRequest) (*Response, error)
RemoveReviewers removes the review request for the provided reviewers for the specified pull request.
GitHub API docs: https://developer.github.com/v3/pulls/review_requests/#delete-a-review-request
func (s *PullRequestsService) RequestReviewers(ctx context.Context, owner, repo string, number int, reviewers ReviewersRequest) (*PullRequest, *Response, error)
RequestReviewers creates a review request for the provided reviewers for the specified pull request.
GitHub API docs: https://developer.github.com/v3/pulls/review_requests/#create-a-review-request
func (s *PullRequestsService) SubmitReview(ctx context.Context, owner, repo string, number int, reviewID int64, review *PullRequestReviewRequest) (*PullRequestReview, *Response, error)
SubmitReview submits a specified review on the specified pull request.
TODO: Follow up with GitHub support about an issue with this method's returned error format and remove this comment once it's fixed. Read more about it here - https://github.com/google/go-github/issues/540
GitHub API docs: https://developer.github.com/v3/pulls/reviews/#submit-a-pull-request-review
type PullStats struct {
TotalPulls *int `json:"total_pulls,omitempty"`
MergedPulls *int `json:"merged_pulls,omitempty"`
MergablePulls *int `json:"mergeable_pulls,omitempty"`
UnmergablePulls *int `json:"unmergeable_pulls,omitempty"`
}
PullStats represents the number of total, merged, mergable and unmergeable pull-requests.
func (p *PullStats) GetMergablePulls() int
GetMergablePulls returns the MergablePulls field if it's non-nil, zero value otherwise.
func (p *PullStats) GetMergedPulls() int
GetMergedPulls returns the MergedPulls field if it's non-nil, zero value otherwise.
func (p *PullStats) GetTotalPulls() int
GetTotalPulls returns the TotalPulls field if it's non-nil, zero value otherwise.
func (p *PullStats) GetUnmergablePulls() int
GetUnmergablePulls returns the UnmergablePulls field if it's non-nil, zero value otherwise.
func (s PullStats) String() string
type PunchCard struct {
Day *int // Day of the week (0-6: =Sunday - Saturday).
Hour *int // Hour of day (0-23).
Commits *int // Number of commits.
}
PunchCard represents the number of commits made during a given hour of a day of the week.
func (p *PunchCard) GetCommits() int
GetCommits returns the Commits field if it's non-nil, zero value otherwise.
func (p *PunchCard) GetDay() int
GetDay returns the Day field if it's non-nil, zero value otherwise.
func (p *PunchCard) GetHour() int
GetHour returns the Hour field if it's non-nil, zero value otherwise.
type PushEvent struct {
PushID *int64 `json:"push_id,omitempty"`
Head *string `json:"head,omitempty"`
Ref *string `json:"ref,omitempty"`
Size *int `json:"size,omitempty"`
Commits []PushEventCommit `json:"commits,omitempty"`
Before *string `json:"before,omitempty"`
DistinctSize *int `json:"distinct_size,omitempty"`
// The following fields are only populated by Webhook events.
After *string `json:"after,omitempty"`
Created *bool `json:"created,omitempty"`
Deleted *bool `json:"deleted,omitempty"`
Forced *bool `json:"forced,omitempty"`
BaseRef *string `json:"base_ref,omitempty"`
Compare *string `json:"compare,omitempty"`
Repo *PushEventRepository `json:"repository,omitempty"`
HeadCommit *PushEventCommit `json:"head_commit,omitempty"`
Pusher *User `json:"pusher,omitempty"`
Sender *User `json:"sender,omitempty"`
Installation *Installation `json:"installation,omitempty"`
}
PushEvent represents a git push to a GitHub repository.
GitHub API docs: https://developer.github.com/v3/activity/events/types/#pushevent
func (p *PushEvent) GetAfter() string
GetAfter returns the After field if it's non-nil, zero value otherwise.
func (p *PushEvent) GetBaseRef() string
GetBaseRef returns the BaseRef field if it's non-nil, zero value otherwise.
func (p *PushEvent) GetBefore() string
GetBefore returns the Before field if it's non-nil, zero value otherwise.
func (p *PushEvent) GetCompare() string
GetCompare returns the Compare field if it's non-nil, zero value otherwise.
func (p *PushEvent) GetCreated() bool
GetCreated returns the Created field if it's non-nil, zero value otherwise.
func (p *PushEvent) GetDeleted() bool
GetDeleted returns the Deleted field if it's non-nil, zero value otherwise.
func (p *PushEvent) GetDistinctSize() int
GetDistinctSize returns the DistinctSize field if it's non-nil, zero value otherwise.
func (p *PushEvent) GetForced() bool
GetForced returns the Forced field if it's non-nil, zero value otherwise.
func (p *PushEvent) GetHead() string
GetHead returns the Head field if it's non-nil, zero value otherwise.
func (p *PushEvent) GetHeadCommit() *PushEventCommit
GetHeadCommit returns the HeadCommit field.
func (p *PushEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (p *PushEvent) GetPushID() int64
GetPushID returns the PushID field if it's non-nil, zero value otherwise.
func (p *PushEvent) GetPusher() *User
GetPusher returns the Pusher field.
func (p *PushEvent) GetRef() string
GetRef returns the Ref field if it's non-nil, zero value otherwise.
func (p *PushEvent) GetRepo() *PushEventRepository
GetRepo returns the Repo field.
func (p *PushEvent) GetSender() *User
GetSender returns the Sender field.
func (p *PushEvent) GetSize() int
GetSize returns the Size field if it's non-nil, zero value otherwise.
func (p PushEvent) String() string
type PushEventCommit struct {
Message *string `json:"message,omitempty"`
Author *CommitAuthor `json:"author,omitempty"`
URL *string `json:"url,omitempty"`
Distinct *bool `json:"distinct,omitempty"`
// The following fields are only populated by Events API.
SHA *string `json:"sha,omitempty"`
// The following fields are only populated by Webhook events.
ID *string `json:"id,omitempty"`
TreeID *string `json:"tree_id,omitempty"`
Timestamp *Timestamp `json:"timestamp,omitempty"`
Committer *CommitAuthor `json:"committer,omitempty"`
Added []string `json:"added,omitempty"`
Removed []string `json:"removed,omitempty"`
Modified []string `json:"modified,omitempty"`
}
PushEventCommit represents a git commit in a GitHub PushEvent.
func (p *PushEventCommit) GetAuthor() *CommitAuthor
GetAuthor returns the Author field.
func (p *PushEventCommit) GetCommitter() *CommitAuthor
GetCommitter returns the Committer field.
func (p *PushEventCommit) GetDistinct() bool
GetDistinct returns the Distinct field if it's non-nil, zero value otherwise.
func (p *PushEventCommit) GetID() string
GetID returns the ID field if it's non-nil, zero value otherwise.
func (p *PushEventCommit) GetMessage() string
GetMessage returns the Message field if it's non-nil, zero value otherwise.
func (p *PushEventCommit) GetSHA() string
GetSHA returns the SHA field if it's non-nil, zero value otherwise.
func (p *PushEventCommit) GetTimestamp() Timestamp
GetTimestamp returns the Timestamp field if it's non-nil, zero value otherwise.
func (p *PushEventCommit) GetTreeID() string
GetTreeID returns the TreeID field if it's non-nil, zero value otherwise.
func (p *PushEventCommit) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (p PushEventCommit) String() string
type PushEventRepoOwner struct {
Name *string `json:"name,omitempty"`
Email *string `json:"email,omitempty"`
}
PushEventRepoOwner is a basic representation of user/org in a PushEvent payload.
func (p *PushEventRepoOwner) GetEmail() string
GetEmail returns the Email field if it's non-nil, zero value otherwise.
func (p *PushEventRepoOwner) GetName() string
GetName returns the Name field if it's non-nil, zero value otherwise.
type PushEventRepository struct {
ID *int64 `json:"id,omitempty"`
NodeID *string `json:"node_id,omitempty"`
Name *string `json:"name,omitempty"`
FullName *string `json:"full_name,omitempty"`
Owner *PushEventRepoOwner `json:"owner,omitempty"`
Private *bool `json:"private,omitempty"`
Description *string `json:"description,omitempty"`
Fork *bool `json:"fork,omitempty"`
CreatedAt *Timestamp `json:"created_at,omitempty"`
PushedAt *Timestamp `json:"pushed_at,omitempty"`
UpdatedAt *Timestamp `json:"updated_at,omitempty"`
Homepage *string `json:"homepage,omitempty"`
Size *int `json:"size,omitempty"`
StargazersCount *int `json:"stargazers_count,omitempty"`
WatchersCount *int `json:"watchers_count,omitempty"`
Language *string `json:"language,omitempty"`
HasIssues *bool `json:"has_issues,omitempty"`
HasDownloads *bool `json:"has_downloads,omitempty"`
HasWiki *bool `json:"has_wiki,omitempty"`
HasPages *bool `json:"has_pages,omitempty"`
ForksCount *int `json:"forks_count,omitempty"`
OpenIssuesCount *int `json:"open_issues_count,omitempty"`
DefaultBranch *string `json:"default_branch,omitempty"`
MasterBranch *string `json:"master_branch,omitempty"`
Organization *string `json:"organization,omitempty"`
URL *string `json:"url,omitempty"`
ArchiveURL *string `json:"archive_url,omitempty"`
HTMLURL *string `json:"html_url,omitempty"`
StatusesURL *string `json:"statuses_url,omitempty"`
GitURL *string `json:"git_url,omitempty"`
SSHURL *string `json:"ssh_url,omitempty"`
CloneURL *string `json:"clone_url,omitempty"`
SVNURL *string `json:"svn_url,omitempty"`
}
PushEventRepository represents the repo object in a PushEvent payload.
func (p *PushEventRepository) GetArchiveURL() string
GetArchiveURL returns the ArchiveURL field if it's non-nil, zero value otherwise.
func (p *PushEventRepository) GetCloneURL() string
GetCloneURL returns the CloneURL field if it's non-nil, zero value otherwise.
func (p *PushEventRepository) GetCreatedAt() Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (p *PushEventRepository) GetDefaultBranch() string
GetDefaultBranch returns the DefaultBranch field if it's non-nil, zero value otherwise.
func (p *PushEventRepository) GetDescription() string
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (p *PushEventRepository) GetFork() bool
GetFork returns the Fork field if it's non-nil, zero value otherwise.
func (p *PushEventRepository) GetForksCount() int
GetForksCount returns the ForksCount field if it's non-nil, zero value otherwise.
func (p *PushEventRepository) GetFullName() string
GetFullName returns the FullName field if it's non-nil, zero value otherwise.
func (p *PushEventRepository) GetGitURL() string
GetGitURL returns the GitURL field if it's non-nil, zero value otherwise.
func (p *PushEventRepository) GetHTMLURL() string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (p *PushEventRepository) GetHasDownloads() bool
GetHasDownloads returns the HasDownloads field if it's non-nil, zero value otherwise.
func (p *PushEventRepository) GetHasIssues() bool
GetHasIssues returns the HasIssues field if it's non-nil, zero value otherwise.
func (p *PushEventRepository) GetHasPages() bool
GetHasPages returns the HasPages field if it's non-nil, zero value otherwise.
func (p *PushEventRepository) GetHasWiki() bool
GetHasWiki returns the HasWiki field if it's non-nil, zero value otherwise.
func (p *PushEventRepository) GetHomepage() string
GetHomepage returns the Homepage field if it's non-nil, zero value otherwise.
func (p *PushEventRepository) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (p *PushEventRepository) GetLanguage() string
GetLanguage returns the Language field if it's non-nil, zero value otherwise.
func (p *PushEventRepository) GetMasterBranch() string
GetMasterBranch returns the MasterBranch field if it's non-nil, zero value otherwise.
func (p *PushEventRepository) GetName() string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (p *PushEventRepository) GetNodeID() string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (p *PushEventRepository) GetOpenIssuesCount() int
GetOpenIssuesCount returns the OpenIssuesCount field if it's non-nil, zero value otherwise.
func (p *PushEventRepository) GetOrganization() string
GetOrganization returns the Organization field if it's non-nil, zero value otherwise.
func (p *PushEventRepository) GetOwner() *PushEventRepoOwner
GetOwner returns the Owner field.
func (p *PushEventRepository) GetPrivate() bool
GetPrivate returns the Private field if it's non-nil, zero value otherwise.
func (p *PushEventRepository) GetPushedAt() Timestamp
GetPushedAt returns the PushedAt field if it's non-nil, zero value otherwise.
func (p *PushEventRepository) GetSSHURL() string
GetSSHURL returns the SSHURL field if it's non-nil, zero value otherwise.
func (p *PushEventRepository) GetSVNURL() string
GetSVNURL returns the SVNURL field if it's non-nil, zero value otherwise.
func (p *PushEventRepository) GetSize() int
GetSize returns the Size field if it's non-nil, zero value otherwise.
func (p *PushEventRepository) GetStargazersCount() int
GetStargazersCount returns the StargazersCount field if it's non-nil, zero value otherwise.
func (p *PushEventRepository) GetStatusesURL() string
GetStatusesURL returns the StatusesURL field if it's non-nil, zero value otherwise.
func (p *PushEventRepository) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (p *PushEventRepository) GetUpdatedAt() Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (p *PushEventRepository) GetWatchersCount() int
GetWatchersCount returns the WatchersCount field if it's non-nil, zero value otherwise.
type Rate struct {
// The number of requests per hour the client is currently limited to.
Limit int `json:"limit"`
// The number of remaining requests the client can make this hour.
Remaining int `json:"remaining"`
// The time at which the current rate limit will reset.
Reset Timestamp `json:"reset"`
}
Rate represents the rate limit for the current client.
func (r Rate) String() string
type RateLimitError struct {
Rate Rate // Rate specifies last known rate limit for the client
Response *http.Response // HTTP response that caused this error
Message string `json:"message"` // error message
}
RateLimitError occurs when GitHub returns 403 Forbidden response with a rate limit remaining value of 0, and error message starts with "API rate limit exceeded for ".
func (r *RateLimitError) Error() string
type RateLimits struct {
// The rate limit for non-search API requests. Unauthenticated
// requests are limited to 60 per hour. Authenticated requests are
// limited to 5,000 per hour.
//
// GitHub API docs: https://developer.github.com/v3/#rate-limiting
Core *Rate `json:"core"`
// The rate limit for search API requests. Unauthenticated requests
// are limited to 10 requests per minutes. Authenticated requests are
// limited to 30 per minute.
//
// GitHub API docs: https://developer.github.com/v3/search/#rate-limit
Search *Rate `json:"search"`
}
RateLimits represents the rate limits for the current client.
func (r *RateLimits) GetCore() *Rate
GetCore returns the Core field.
func (r *RateLimits) GetSearch() *Rate
GetSearch returns the Search field.
func (r RateLimits) String() string
type RawOptions struct {
Type RawType
}
RawOptions specifies parameters when user wants to get raw format of a response instead of JSON.
type RawType uint8
RawType represents type of raw format of a request instead of JSON.
const ( // Diff format. Diff RawType = 1 + iota // Patch format. Patch )
type Reaction struct {
// ID is the Reaction ID.
ID *int64 `json:"id,omitempty"`
User *User `json:"user,omitempty"`
NodeID *string `json:"node_id,omitempty"`
// Content is the type of reaction.
// Possible values are:
// "+1", "-1", "laugh", "confused", "heart", "hooray".
Content *string `json:"content,omitempty"`
}
Reaction represents a GitHub reaction.
func (r *Reaction) GetContent() string
GetContent returns the Content field if it's non-nil, zero value otherwise.
func (r *Reaction) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (r *Reaction) GetNodeID() string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (r *Reaction) GetUser() *User
GetUser returns the User field.
func (r Reaction) String() string
type Reactions struct {
TotalCount *int `json:"total_count,omitempty"`
PlusOne *int `json:"+1,omitempty"`
MinusOne *int `json:"-1,omitempty"`
Laugh *int `json:"laugh,omitempty"`
Confused *int `json:"confused,omitempty"`
Heart *int `json:"heart,omitempty"`
Hooray *int `json:"hooray,omitempty"`
URL *string `json:"url,omitempty"`
}
Reactions represents a summary of GitHub reactions.
func (r *Reactions) GetConfused() int
GetConfused returns the Confused field if it's non-nil, zero value otherwise.
func (r *Reactions) GetHeart() int
GetHeart returns the Heart field if it's non-nil, zero value otherwise.
func (r *Reactions) GetHooray() int
GetHooray returns the Hooray field if it's non-nil, zero value otherwise.
func (r *Reactions) GetLaugh() int
GetLaugh returns the Laugh field if it's non-nil, zero value otherwise.
func (r *Reactions) GetMinusOne() int
GetMinusOne returns the MinusOne field if it's non-nil, zero value otherwise.
func (r *Reactions) GetPlusOne() int
GetPlusOne returns the PlusOne field if it's non-nil, zero value otherwise.
func (r *Reactions) GetTotalCount() int
GetTotalCount returns the TotalCount field if it's non-nil, zero value otherwise.
func (r *Reactions) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
type ReactionsService service
ReactionsService provides access to the reactions-related functions in the GitHub API.
GitHub API docs: https://developer.github.com/v3/reactions/
func (s ReactionsService) CreateCommentReaction(ctx context.Context, owner, repo string, id int64, content string) (*Reaction, *Response, error)
CreateCommentReaction creates a reaction for a commit comment. Note that if you have already created a reaction of type content, the previously created reaction will be returned with Status: 200 OK.
GitHub API docs: https://developer.github.com/v3/reactions/#create-reaction-for-a-commit-comment
func (s ReactionsService) CreateIssueCommentReaction(ctx context.Context, owner, repo string, id int64, content string) (*Reaction, *Response, error)
CreateIssueCommentReaction creates a reaction for an issue comment. Note that if you have already created a reaction of type content, the previously created reaction will be returned with Status: 200 OK.
GitHub API docs: https://developer.github.com/v3/reactions/#create-reaction-for-an-issue-comment
func (s ReactionsService) CreateIssueReaction(ctx context.Context, owner, repo string, number int, content string) (*Reaction, *Response, error)
CreateIssueReaction creates a reaction for an issue. Note that if you have already created a reaction of type content, the previously created reaction will be returned with Status: 200 OK.
GitHub API docs: https://developer.github.com/v3/reactions/#create-reaction-for-an-issue
func (s ReactionsService) CreatePullRequestCommentReaction(ctx context.Context, owner, repo string, id int64, content string) (*Reaction, *Response, error)
CreatePullRequestCommentReaction creates a reaction for a pull request review comment. Note that if you have already created a reaction of type content, the previously created reaction will be returned with Status: 200 OK.
GitHub API docs: https://developer.github.com/v3/reactions/#create-reaction-for-an-issue-comment
func (s *ReactionsService) DeleteReaction(ctx context.Context, id int64) (*Response, error)
DeleteReaction deletes a reaction.
GitHub API docs: https://developer.github.com/v3/reaction/reactions/#delete-a-reaction-archive
func (s *ReactionsService) ListCommentReactions(ctx context.Context, owner, repo string, id int64, opt *ListOptions) ([]*Reaction, *Response, error)
ListCommentReactions lists the reactions for a commit comment.
GitHub API docs: https://developer.github.com/v3/reactions/#list-reactions-for-a-commit-comment
func (s *ReactionsService) ListIssueCommentReactions(ctx context.Context, owner, repo string, id int64, opt *ListOptions) ([]*Reaction, *Response, error)
ListIssueCommentReactions lists the reactions for an issue comment.
GitHub API docs: https://developer.github.com/v3/reactions/#list-reactions-for-an-issue-comment
func (s *ReactionsService) ListIssueReactions(ctx context.Context, owner, repo string, number int, opt *ListOptions) ([]*Reaction, *Response, error)
ListIssueReactions lists the reactions for an issue.
GitHub API docs: https://developer.github.com/v3/reactions/#list-reactions-for-an-issue
func (s *ReactionsService) ListPullRequestCommentReactions(ctx context.Context, owner, repo string, id int64, opt *ListOptions) ([]*Reaction, *Response, error)
ListPullRequestCommentReactions lists the reactions for a pull request review comment.
GitHub API docs: https://developer.github.com/v3/reactions/#list-reactions-for-an-issue-comment
type Reference struct {
Ref *string `json:"ref"`
URL *string `json:"url"`
Object *GitObject `json:"object"`
NodeID *string `json:"node_id,omitempty"`
}
Reference represents a GitHub reference.
func (r *Reference) GetNodeID() string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (r *Reference) GetObject() *GitObject
GetObject returns the Object field.
func (r *Reference) GetRef() string
GetRef returns the Ref field if it's non-nil, zero value otherwise.
func (r *Reference) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (r Reference) String() string
type ReferenceListOptions struct {
Type string `url:"-"`
ListOptions
}
ReferenceListOptions specifies optional parameters to the GitService.ListRefs method.
type ReleaseAsset struct {
ID *int64 `json:"id,omitempty"`
URL *string `json:"url,omitempty"`
Name *string `json:"name,omitempty"`
Label *string `json:"label,omitempty"`
State *string `json:"state,omitempty"`
ContentType *string `json:"content_type,omitempty"`
Size *int `json:"size,omitempty"`
DownloadCount *int `json:"download_count,omitempty"`
CreatedAt *Timestamp `json:"created_at,omitempty"`
UpdatedAt *Timestamp `json:"updated_at,omitempty"`
BrowserDownloadURL *string `json:"browser_download_url,omitempty"`
Uploader *User `json:"uploader,omitempty"`
NodeID *string `json:"node_id,omitempty"`
}
ReleaseAsset represents a GitHub release asset in a repository.
func (r *ReleaseAsset) GetBrowserDownloadURL() string
GetBrowserDownloadURL returns the BrowserDownloadURL field if it's non-nil, zero value otherwise.
func (r *ReleaseAsset) GetContentType() string
GetContentType returns the ContentType field if it's non-nil, zero value otherwise.
func (r *ReleaseAsset) GetCreatedAt() Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (r *ReleaseAsset) GetDownloadCount() int
GetDownloadCount returns the DownloadCount field if it's non-nil, zero value otherwise.
func (r *ReleaseAsset) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (r *ReleaseAsset) GetLabel() string
GetLabel returns the Label field if it's non-nil, zero value otherwise.
func (r *ReleaseAsset) GetName() string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (r *ReleaseAsset) GetNodeID() string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (r *ReleaseAsset) GetSize() int
GetSize returns the Size field if it's non-nil, zero value otherwise.
func (r *ReleaseAsset) GetState() string
GetState returns the State field if it's non-nil, zero value otherwise.
func (r *ReleaseAsset) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (r *ReleaseAsset) GetUpdatedAt() Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (r *ReleaseAsset) GetUploader() *User
GetUploader returns the Uploader field.
func (r ReleaseAsset) String() string
type ReleaseEvent struct {
// Action is the action that was performed. Possible value is: "published".
Action *string `json:"action,omitempty"`
Release *RepositoryRelease `json:"release,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"`
}
ReleaseEvent is triggered when a release is published. The Webhook event name is "release".
GitHub API docs: https://developer.github.com/v3/activity/events/types/#releaseevent
func (r *ReleaseEvent) GetAction() string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (r *ReleaseEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (r *ReleaseEvent) GetRelease() *RepositoryRelease
GetRelease returns the Release field.
func (r *ReleaseEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (r *ReleaseEvent) GetSender() *User
GetSender returns the Sender field.
type Rename struct {
From *string `json:"from,omitempty"`
To *string `json:"to,omitempty"`
}
Rename contains details for 'renamed' events.
func (r *Rename) GetFrom() string
GetFrom returns the From field if it's non-nil, zero value otherwise.
func (r *Rename) GetTo() string
GetTo returns the To field if it's non-nil, zero value otherwise.
func (r Rename) String() string
type RepoStats struct {
TotalRepos *int `json:"total_repos,omitempty"`
RootRepos *int `json:"root_repos,omitempty"`
ForkRepos *int `json:"fork_repos,omitempty"`
OrgRepos *int `json:"org_repos,omitempty"`
TotalPushes *int `json:"total_pushes,omitempty"`
TotalWikis *int `json:"total_wikis,omitempty"`
}
RepoStats represents the number of total, root, fork, organization repositories together with the total number of pushes and wikis.
func (r *RepoStats) GetForkRepos() int
GetForkRepos returns the ForkRepos field if it's non-nil, zero value otherwise.
func (r *RepoStats) GetOrgRepos() int
GetOrgRepos returns the OrgRepos field if it's non-nil, zero value otherwise.
func (r *RepoStats) GetRootRepos() int
GetRootRepos returns the RootRepos field if it's non-nil, zero value otherwise.
func (r *RepoStats) GetTotalPushes() int
GetTotalPushes returns the TotalPushes field if it's non-nil, zero value otherwise.
func (r *RepoStats) GetTotalRepos() int
GetTotalRepos returns the TotalRepos field if it's non-nil, zero value otherwise.
func (r *RepoStats) GetTotalWikis() int
GetTotalWikis returns the TotalWikis field if it's non-nil, zero value otherwise.
func (s RepoStats) String() string
type RepoStatus struct {
ID *int64 `json:"id,omitempty"`
URL *string `json:"url,omitempty"`
// State is the current state of the repository. Possible values are:
// pending, success, error, or failure.
State *string `json:"state,omitempty"`
// TargetURL is the URL of the page representing this status. It will be
// linked from the GitHub UI to allow users to see the source of the status.
TargetURL *string `json:"target_url,omitempty"`
// Description is a short high level summary of the status.
Description *string `json:"description,omitempty"`
// A string label to differentiate this status from the statuses of other systems.
Context *string `json:"context,omitempty"`
Creator *User `json:"creator,omitempty"`
CreatedAt *time.Time `json:"created_at,omitempty"`
UpdatedAt *time.Time `json:"updated_at,omitempty"`
}
RepoStatus represents the status of a repository at a particular reference.
func (r *RepoStatus) GetContext() string
GetContext returns the Context field if it's non-nil, zero value otherwise.
func (r *RepoStatus) GetCreatedAt() time.Time
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (r *RepoStatus) GetCreator() *User
GetCreator returns the Creator field.
func (r *RepoStatus) GetDescription() string
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (r *RepoStatus) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (r *RepoStatus) GetState() string
GetState returns the State field if it's non-nil, zero value otherwise.
func (r *RepoStatus) GetTargetURL() string
GetTargetURL returns the TargetURL field if it's non-nil, zero value otherwise.
func (r *RepoStatus) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (r *RepoStatus) GetUpdatedAt() time.Time
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (r RepoStatus) String() string
type RepositoriesSearchResult struct {
Total *int `json:"total_count,omitempty"`
IncompleteResults *bool `json:"incomplete_results,omitempty"`
Repositories []Repository `json:"items,omitempty"`
}
RepositoriesSearchResult represents the result of a repositories search.
func (r *RepositoriesSearchResult) GetIncompleteResults() bool
GetIncompleteResults returns the IncompleteResults field if it's non-nil, zero value otherwise.
func (r *RepositoriesSearchResult) GetTotal() int
GetTotal returns the Total field if it's non-nil, zero value otherwise.
type RepositoriesService service
RepositoriesService handles communication with the repository related methods of the GitHub API.
GitHub API docs: https://developer.github.com/v3/repos/
func (s *RepositoriesService) AddAdminEnforcement(ctx context.Context, owner, repo, branch string) (*AdminEnforcement, *Response, error)
AddAdminEnforcement adds admin enforcement to a protected branch. It requires admin access and branch protection to be enabled.
GitHub API docs: https://developer.github.com/v3/repos/branches/#add-admin-enforcement-of-protected-branch
func (s *RepositoriesService) AddCollaborator(ctx context.Context, owner, repo, user string, opt *RepositoryAddCollaboratorOptions) (*Response, error)
AddCollaborator sends an invitation to the specified GitHub user to become a collaborator to the given repo.
GitHub API docs: https://developer.github.com/v3/repos/collaborators/#add-user-as-a-collaborator
func (s *RepositoriesService) CompareCommits(ctx context.Context, owner, repo string, base, head string) (*CommitsComparison, *Response, error)
CompareCommits compares a range of commits with each other. todo: support media formats - https://github.com/google/go-github/issues/6
GitHub API docs: https://developer.github.com/v3/repos/commits/#compare-two-commits
func (s *RepositoriesService) Create(ctx context.Context, org string, repo *Repository) (*Repository, *Response, error)
Create a new repository. If an organization is specified, the new repository will be created under that org. If the empty string is specified, it will be created for the authenticated user.
GitHub API docs: https://developer.github.com/v3/repos/#create
func (s *RepositoriesService) CreateComment(ctx context.Context, owner, repo, sha string, comment *RepositoryComment) (*RepositoryComment, *Response, error)
CreateComment creates a comment for the given commit. Note: GitHub allows for comments to be created for non-existing files and positions.
GitHub API docs: https://developer.github.com/v3/repos/comments/#create-a-commit-comment
func (s *RepositoriesService) CreateDeployment(ctx context.Context, owner, repo string, request *DeploymentRequest) (*Deployment, *Response, error)
CreateDeployment creates a new deployment for a repository.
GitHub API docs: https://developer.github.com/v3/repos/deployments/#create-a-deployment
func (s *RepositoriesService) CreateDeploymentStatus(ctx context.Context, owner, repo string, deployment int64, request *DeploymentStatusRequest) (*DeploymentStatus, *Response, error)
CreateDeploymentStatus creates a new status for a deployment.
GitHub API docs: https://developer.github.com/v3/repos/deployments/#create-a-deployment-status
func (s *RepositoriesService) CreateFile(ctx context.Context, owner, repo, path string, opt *RepositoryContentFileOptions) (*RepositoryContentResponse, *Response, error)
CreateFile creates a new file in a repository at the given path and returns the commit and file metadata.
GitHub API docs: https://developer.github.com/v3/repos/contents/#create-a-file
Code:
package main
import (
"context"
"fmt"
"github.com/google/go-github/github"
)
func main() {
// In this example we're creating a new file in a repository using the
// Contents API. Only 1 file per commit can be managed through that API.
// Note that authentication is needed here as you are performing a modification
// so you will need to modify the example to provide an oauth client to
// github.NewClient() instead of nil. See the following documentation for more
// information on how to authenticate with the client:
// https://godoc.org/github.com/google/go-github/github#hdr-Authentication
client := github.NewClient(nil)
ctx := context.Background()
fileContent := []byte("This is the content of my file\nand the 2nd line of it")
// Note: the file needs to be absent from the repository as you are not
// specifying a SHA reference here.
opts := &github.RepositoryContentFileOptions{
Message: github.String("This is my commit message"),
Content: fileContent,
Branch: github.String("master"),
Committer: &github.CommitAuthor{Name: github.String("FirstName LastName"), Email: github.String("user@example.com")},
}
_, _, err := client.Repositories.CreateFile(ctx, "myOrganization", "myRepository", "myNewFile.md", opts)
if err != nil {
fmt.Println(err)
return
}
}
func (s *RepositoriesService) CreateFork(ctx context.Context, owner, repo string, opt *RepositoryCreateForkOptions) (*Repository, *Response, error)
CreateFork creates a fork of the specified repository.
This method might return an *AcceptedError and a status code of 202. This is because this is the status that GitHub returns to signify that it is now computing creating the fork in a background task. In this event, the Repository value will be returned, which includes the details about the pending fork. A follow up request, after a delay of a second or so, should result in a successful request.
GitHub API docs: https://developer.github.com/v3/repos/forks/#create-a-fork
func (s *RepositoriesService) CreateHook(ctx context.Context, owner, repo string, hook *Hook) (*Hook, *Response, error)
CreateHook creates a Hook for the specified repository. Name and Config are required fields.
GitHub API docs: https://developer.github.com/v3/repos/hooks/#create-a-hook
func (s *RepositoriesService) CreateKey(ctx context.Context, owner string, repo string, key *Key) (*Key, *Response, error)
CreateKey adds a deploy key for a repository.
GitHub API docs: https://developer.github.com/v3/repos/keys/#create
func (s *RepositoriesService) CreateProject(ctx context.Context, owner, repo string, opt *ProjectOptions) (*Project, *Response, error)
CreateProject creates a GitHub Project for the specified repository.
GitHub API docs: https://developer.github.com/v3/projects/#create-a-repository-project
func (s *RepositoriesService) CreateRelease(ctx context.Context, owner, repo string, release *RepositoryRelease) (*RepositoryRelease, *Response, error)
CreateRelease adds a new release for a repository.
GitHub API docs: https://developer.github.com/v3/repos/releases/#create-a-release
func (s *RepositoriesService) CreateStatus(ctx context.Context, owner, repo, ref string, status *RepoStatus) (*RepoStatus, *Response, error)
CreateStatus creates a new status for a repository at the specified reference. Ref can be a SHA, a branch name, or a tag name.
GitHub API docs: https://developer.github.com/v3/repos/statuses/#create-a-status
func (s *RepositoriesService) Delete(ctx context.Context, owner, repo string) (*Response, error)
Delete a repository.
GitHub API docs: https://developer.github.com/v3/repos/#delete-a-repository
func (s *RepositoriesService) DeleteComment(ctx context.Context, owner, repo string, id int64) (*Response, error)
DeleteComment deletes a single comment from a repository.
GitHub API docs: https://developer.github.com/v3/repos/comments/#delete-a-commit-comment
func (s *RepositoriesService) DeleteFile(ctx context.Context, owner, repo, path string, opt *RepositoryContentFileOptions) (*RepositoryContentResponse, *Response, error)
DeleteFile deletes a file from a repository and returns the commit. Requires the blob SHA of the file to be deleted.
GitHub API docs: https://developer.github.com/v3/repos/contents/#delete-a-file
func (s *RepositoriesService) DeleteHook(ctx context.Context, owner, repo string, id int64) (*Response, error)
DeleteHook deletes a specified Hook.
GitHub API docs: https://developer.github.com/v3/repos/hooks/#delete-a-hook
func (s *RepositoriesService) DeleteInvitation(ctx context.Context, owner, repo string, invitationID int64) (*Response, error)
DeleteInvitation deletes a repository invitation.
GitHub API docs: https://developer.github.com/v3/repos/invitations/#delete-a-repository-invitation
func (s *RepositoriesService) DeleteKey(ctx context.Context, owner string, repo string, id int64) (*Response, error)
DeleteKey deletes a deploy key.
GitHub API docs: https://developer.github.com/v3/repos/keys/#delete
func (s *RepositoriesService) DeletePreReceiveHook(ctx context.Context, owner, repo string, id int64) (*Response, error)
DeletePreReceiveHook deletes a specified pre-receive hook.
GitHub API docs: https://developer.github.com/enterprise/2.13/v3/repos/pre_receive_hooks/#remove-enforcement-overrides-for-a-pre-receive-hook
func (s *RepositoriesService) DeleteRelease(ctx context.Context, owner, repo string, id int64) (*Response, error)
DeleteRelease delete a single release from a repository.
GitHub API docs: https://developer.github.com/v3/repos/releases/#delete-a-release
func (s *RepositoriesService) DeleteReleaseAsset(ctx context.Context, owner, repo string, id int64) (*Response, error)
DeleteReleaseAsset delete a single release asset from a repository.
GitHub API docs: https://developer.github.com/v3/repos/releases/#delete-a-release-asset
func (s *RepositoriesService) DisableDismissalRestrictions(ctx context.Context, owner, repo, branch string) (*PullRequestReviewsEnforcement, *Response, error)
DisableDismissalRestrictions disables dismissal restrictions of a protected branch. It requires admin access and branch protection to be enabled.
GitHub API docs: https://developer.github.com/v3/repos/branches/#update-pull-request-review-enforcement-of-protected-branch
func (s *RepositoriesService) DownloadContents(ctx context.Context, owner, repo, filepath string, opt *RepositoryContentGetOptions) (io.ReadCloser, error)
DownloadContents returns an io.ReadCloser that reads the contents of the specified file. This function will work with files of any size, as opposed to GetContents which is limited to 1 Mb files. It is the caller's responsibility to close the ReadCloser.
func (s *RepositoriesService) DownloadReleaseAsset(ctx context.Context, owner, repo string, id int64) (rc io.ReadCloser, redirectURL string, err error)
DownloadReleaseAsset downloads a release asset or returns a redirect URL.
DownloadReleaseAsset returns an io.ReadCloser that reads the contents of the specified release asset. It is the caller's responsibility to close the ReadCloser. If a redirect is returned, the redirect URL will be returned as a string instead of the io.ReadCloser. Exactly one of rc and redirectURL will be zero.
GitHub API docs: https://developer.github.com/v3/repos/releases/#get-a-single-release-asset
func (s *RepositoriesService) Edit(ctx context.Context, owner, repo string, repository *Repository) (*Repository, *Response, error)
Edit updates a repository.
GitHub API docs: https://developer.github.com/v3/repos/#edit
func (s *RepositoriesService) EditHook(ctx context.Context, owner, repo string, id int64, hook *Hook) (*Hook, *Response, error)
EditHook updates a specified Hook.
GitHub API docs: https://developer.github.com/v3/repos/hooks/#edit-a-hook
func (s *RepositoriesService) EditKey(ctx context.Context, owner string, repo string, id int64, key *Key) (*Key, *Response, error)
EditKey edits a deploy key.
GitHub API docs: https://developer.github.com/v3/repos/keys/#edit
func (s *RepositoriesService) EditRelease(ctx context.Context, owner, repo string, id int64, release *RepositoryRelease) (*RepositoryRelease, *Response, error)
EditRelease edits a repository release.
GitHub API docs: https://developer.github.com/v3/repos/releases/#edit-a-release
func (s *RepositoriesService) EditReleaseAsset(ctx context.Context, owner, repo string, id int64, release *ReleaseAsset) (*ReleaseAsset, *Response, error)
EditReleaseAsset edits a repository release asset.
GitHub API docs: https://developer.github.com/v3/repos/releases/#edit-a-release-asset
func (s *RepositoriesService) Get(ctx context.Context, owner, repo string) (*Repository, *Response, error)
Get fetches a repository.
GitHub API docs: https://developer.github.com/v3/repos/#get
func (s *RepositoriesService) GetAdminEnforcement(ctx context.Context, owner, repo, branch string) (*AdminEnforcement, *Response, error)
GetAdminEnforcement gets admin enforcement information of a protected branch.
GitHub API docs: https://developer.github.com/v3/repos/branches/#get-admin-enforcement-of-protected-branch
func (s *RepositoriesService) GetArchiveLink(ctx context.Context, owner, repo string, archiveformat archiveFormat, opt *RepositoryContentGetOptions) (*url.URL, *Response, error)
GetArchiveLink returns an URL to download a tarball or zipball archive for a repository. The archiveFormat can be specified by either the github.Tarball or github.Zipball constant.
GitHub API docs: https://developer.github.com/v3/repos/contents/#get-archive-link
func (s *RepositoriesService) GetBranch(ctx context.Context, owner, repo, branch string) (*Branch, *Response, error)
GetBranch gets the specified branch for a repository.
GitHub API docs: https://developer.github.com/v3/repos/#get-branch
func (s *RepositoriesService) GetBranchProtection(ctx context.Context, owner, repo, branch string) (*Protection, *Response, error)
GetBranchProtection gets the protection of a given branch.
GitHub API docs: https://developer.github.com/v3/repos/branches/#get-branch-protection
func (s *RepositoriesService) GetByID(ctx context.Context, id int64) (*Repository, *Response, error)
GetByID fetches a repository.
Note: GetByID uses the undocumented GitHub API endpoint /repositories/:id.
func (s *RepositoriesService) GetCodeOfConduct(ctx context.Context, owner, repo string) (*CodeOfConduct, *Response, error)
GetCodeOfConduct gets the contents of a repository's code of conduct.
GitHub API docs: https://developer.github.com/v3/codes_of_conduct/#get-the-contents-of-a-repositorys-code-of-conduct
func (s *RepositoriesService) GetCombinedStatus(ctx context.Context, owner, repo, ref string, opt *ListOptions) (*CombinedStatus, *Response, error)
GetCombinedStatus returns the combined status of a repository at the specified reference. ref can be a SHA, a branch name, or a tag name.
GitHub API docs: https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref
func (s *RepositoriesService) GetComment(ctx context.Context, owner, repo string, id int64) (*RepositoryComment, *Response, error)
GetComment gets a single comment from a repository.
GitHub API docs: https://developer.github.com/v3/repos/comments/#get-a-single-commit-comment
func (s *RepositoriesService) GetCommit(ctx context.Context, owner, repo, sha string) (*RepositoryCommit, *Response, error)
GetCommit fetches the specified commit, including all details about it.
GitHub API docs: https://developer.github.com/v3/repos/commits/#get-a-single-commit See also: https://developer.github.com/v3/git/commits/#get-a-single-commit provides the same functionality
func (s *RepositoriesService) GetCommitRaw(ctx context.Context, owner string, repo string, sha string, opt RawOptions) (string, *Response, error)
GetCommitRaw fetches the specified commit in raw (diff or patch) format.
func (s *RepositoriesService) GetCommitSHA1(ctx context.Context, owner, repo, ref, lastSHA string) (string, *Response, error)
GetCommitSHA1 gets the SHA-1 of a commit reference. If a last-known SHA1 is supplied and no new commits have occurred, a 304 Unmodified response is returned.
GitHub API docs: https://developer.github.com/v3/repos/commits/#get-the-sha-1-of-a-commit-reference
func (s *RepositoriesService) GetCommunityHealthMetrics(ctx context.Context, owner, repo string) (*CommunityHealthMetrics, *Response, error)
GetCommunityHealthMetrics retrieves all the community health metrics for a repository.
GitHub API docs: https://developer.github.com/v3/repos/community/#retrieve-community-health-metrics
func (s *RepositoriesService) GetContents(ctx context.Context, owner, repo, path string, opt *RepositoryContentGetOptions) (fileContent *RepositoryContent, directoryContent []*RepositoryContent, resp *Response, err error)
GetContents can return either the metadata and content of a single file (when path references a file) or the metadata of all the files and/or subdirectories of a directory (when path references a directory). To make it easy to distinguish between both result types and to mimic the API as much as possible, both result types will be returned but only one will contain a value and the other will be nil.
GitHub API docs: https://developer.github.com/v3/repos/contents/#get-contents
func (s *RepositoriesService) GetDeployment(ctx context.Context, owner, repo string, deploymentID int64) (*Deployment, *Response, error)
GetDeployment returns a single deployment of a repository.
GitHub API docs: https://developer.github.com/v3/repos/deployments/#get-a-single-deployment
func (s *RepositoriesService) GetDeploymentStatus(ctx context.Context, owner, repo string, deploymentID, deploymentStatusID int64) (*DeploymentStatus, *Response, error)
GetDeploymentStatus returns a single deployment status of a repository.
GitHub API docs: https://developer.github.com/v3/repos/deployments/#get-a-single-deployment-status
func (s *RepositoriesService) GetHook(ctx context.Context, owner, repo string, id int64) (*Hook, *Response, error)
GetHook returns a single specified Hook.
GitHub API docs: https://developer.github.com/v3/repos/hooks/#get-single-hook
func (s *RepositoriesService) GetKey(ctx context.Context, owner string, repo string, id int64) (*Key, *Response, error)
GetKey fetches a single deploy key.
GitHub API docs: https://developer.github.com/v3/repos/keys/#get
func (s *RepositoriesService) GetLatestPagesBuild(ctx context.Context, owner, repo string) (*PagesBuild, *Response, error)
GetLatestPagesBuild fetches the latest build information for a GitHub pages site.
GitHub API docs: https://developer.github.com/v3/repos/pages/#list-latest-pages-build
func (s *RepositoriesService) GetLatestRelease(ctx context.Context, owner, repo string) (*RepositoryRelease, *Response, error)
GetLatestRelease fetches the latest published release for the repository.
GitHub API docs: https://developer.github.com/v3/repos/releases/#get-the-latest-release
func (s *RepositoriesService) GetPageBuild(ctx context.Context, owner, repo string, id int64) (*PagesBuild, *Response, error)
GetPageBuild fetches the specific build information for a GitHub pages site.
GitHub API docs: https://developer.github.com/v3/repos/pages/#list-a-specific-pages-build
func (s *RepositoriesService) GetPagesInfo(ctx context.Context, owner, repo string) (*Pages, *Response, error)
GetPagesInfo fetches information about a GitHub Pages site.
GitHub API docs: https://developer.github.com/v3/repos/pages/#get-information-about-a-pages-site
func (s *RepositoriesService) GetPermissionLevel(ctx context.Context, owner, repo, user string) (*RepositoryPermissionLevel, *Response, error)
GetPermissionLevel retrieves the specific permission level a collaborator has for a given repository. GitHub API docs: https://developer.github.com/v3/repos/collaborators/#review-a-users-permission-level
func (s *RepositoriesService) GetPreReceiveHook(ctx context.Context, owner, repo string, id int64) (*PreReceiveHook, *Response, error)
GetPreReceiveHook returns a single specified pre-receive hook.
GitHub API docs: https://developer.github.com/enterprise/2.13/v3/repos/pre_receive_hooks/#get-a-single-pre-receive-hook
func (s *RepositoriesService) GetPullRequestReviewEnforcement(ctx context.Context, owner, repo, branch string) (*PullRequestReviewsEnforcement, *Response, error)
GetPullRequestReviewEnforcement gets pull request review enforcement of a protected branch.
GitHub API docs: https://developer.github.com/v3/repos/branches/#get-pull-request-review-enforcement-of-protected-branch
func (s *RepositoriesService) GetReadme(ctx context.Context, owner, repo string, opt *RepositoryContentGetOptions) (*RepositoryContent, *Response, error)
GetReadme gets the Readme file for the repository.
GitHub API docs: https://developer.github.com/v3/repos/contents/#get-the-readme
Code:
package main
import (
"context"
"fmt"
"github.com/google/go-github/github"
)
func main() {
client := github.NewClient(nil)
readme, _, err := client.Repositories.GetReadme(context.Background(), "google", "go-github", nil)
if err != nil {
fmt.Println(err)
return
}
content, err := readme.GetContent()
if err != nil {
fmt.Println(err)
return
}
fmt.Printf("google/go-github README:\n%v\n", content)
}
func (s *RepositoriesService) GetRelease(ctx context.Context, owner, repo string, id int64) (*RepositoryRelease, *Response, error)
GetRelease fetches a single release.
GitHub API docs: https://developer.github.com/v3/repos/releases/#get-a-single-release
func (s *RepositoriesService) GetReleaseAsset(ctx context.Context, owner, repo string, id int64) (*ReleaseAsset, *Response, error)
GetReleaseAsset fetches a single release asset.
GitHub API docs: https://developer.github.com/v3/repos/releases/#get-a-single-release-asset
func (s *RepositoriesService) GetReleaseByTag(ctx context.Context, owner, repo, tag string) (*RepositoryRelease, *Response, error)
GetReleaseByTag fetches a release with the specified tag.
GitHub API docs: https://developer.github.com/v3/repos/releases/#get-a-release-by-tag-name
func (s *RepositoriesService) GetRequiredStatusChecks(ctx context.Context, owner, repo, branch string) (*RequiredStatusChecks, *Response, error)
GetRequiredStatusChecks gets the required status checks for a given protected branch.
GitHub API docs: https://developer.github.com/v3/repos/branches/#get-required-status-checks-of-protected-branch
func (s *RepositoriesService) IsCollaborator(ctx context.Context, owner, repo, user string) (bool, *Response, error)
IsCollaborator checks whether the specified GitHub user has collaborator access to the given repo. Note: This will return false if the user is not a collaborator OR the user is not a GitHub user.
GitHub API docs: https://developer.github.com/v3/repos/collaborators/#get
func (s *RepositoriesService) License(ctx context.Context, owner, repo string) (*RepositoryLicense, *Response, error)
License gets the contents of a repository's license if one is detected.
GitHub API docs: https://developer.github.com/v3/licenses/#get-the-contents-of-a-repositorys-license
func (s *RepositoriesService) List(ctx context.Context, user string, opt *RepositoryListOptions) ([]*Repository, *Response, error)
List the repositories for a user. Passing the empty string will list repositories for the authenticated user.
GitHub API docs: https://developer.github.com/v3/repos/#list-user-repositories
Code:
package main
import (
"context"
"fmt"
"github.com/google/go-github/github"
)
func main() {
client := github.NewClient(nil)
user := "willnorris"
opt := &github.RepositoryListOptions{Type: "owner", Sort: "updated", Direction: "desc"}
repos, _, err := client.Repositories.List(context.Background(), user, opt)
if err != nil {
fmt.Println(err)
}
fmt.Printf("Recently updated repositories by %q: %v", user, github.Stringify(repos))
}
func (s *RepositoriesService) ListAll(ctx context.Context, opt *RepositoryListAllOptions) ([]*Repository, *Response, error)
ListAll lists all GitHub repositories in the order that they were created.
GitHub API docs: https://developer.github.com/v3/repos/#list-all-public-repositories
func (s *RepositoriesService) ListAllTopics(ctx context.Context, owner, repo string) ([]string, *Response, error)
ListAllTopics lists topics for a repository.
GitHub API docs: https://developer.github.com/v3/repos/#list-all-topics-for-a-repository
func (s *RepositoriesService) ListBranches(ctx context.Context, owner string, repo string, opt *ListOptions) ([]*Branch, *Response, error)
ListBranches lists branches for the specified repository.
GitHub API docs: https://developer.github.com/v3/repos/#list-branches
func (s *RepositoriesService) ListByOrg(ctx context.Context, org string, opt *RepositoryListByOrgOptions) ([]*Repository, *Response, error)
ListByOrg lists the repositories for an organization.
GitHub API docs: https://developer.github.com/v3/repos/#list-organization-repositories
func (s *RepositoriesService) ListCodeFrequency(ctx context.Context, owner, repo string) ([]*WeeklyStats, *Response, error)
ListCodeFrequency returns a weekly aggregate of the number of additions and deletions pushed to a repository. Returned WeeklyStats will contain additions and deletions, but not total commits.
If this is the first time these statistics are requested for the given repository, this method will return an *AcceptedError and a status code of 202. This is because this is the status that GitHub returns to signify that it is now computing the requested statistics. A follow up request, after a delay of a second or so, should result in a successful request.
GitHub API docs: https://developer.github.com/v3/repos/statistics/#code-frequency
func (s *RepositoriesService) ListCollaborators(ctx context.Context, owner, repo string, opt *ListCollaboratorsOptions) ([]*User, *Response, error)
ListCollaborators lists the GitHub users that have access to the repository.
GitHub API docs: https://developer.github.com/v3/repos/collaborators/#list-collaborators
func (s *RepositoriesService) ListComments(ctx context.Context, owner, repo string, opt *ListOptions) ([]*RepositoryComment, *Response, error)
ListComments lists all the comments for the repository.
GitHub API docs: https://developer.github.com/v3/repos/comments/#list-commit-comments-for-a-repository
func (s *RepositoriesService) ListCommitActivity(ctx context.Context, owner, repo string) ([]*WeeklyCommitActivity, *Response, error)
ListCommitActivity returns the last year of commit activity grouped by week. The days array is a group of commits per day, starting on Sunday.
If this is the first time these statistics are requested for the given repository, this method will return an *AcceptedError and a status code of 202. This is because this is the status that GitHub returns to signify that it is now computing the requested statistics. A follow up request, after a delay of a second or so, should result in a successful request.
GitHub API docs: https://developer.github.com/v3/repos/statistics/#commit-activity
func (s *RepositoriesService) ListCommitComments(ctx context.Context, owner, repo, sha string, opt *ListOptions) ([]*RepositoryComment, *Response, error)
ListCommitComments lists all the comments for a given commit SHA.
GitHub API docs: https://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit
func (s *RepositoriesService) ListCommits(ctx context.Context, owner, repo string, opt *CommitsListOptions) ([]*RepositoryCommit, *Response, error)
ListCommits lists the commits of a repository.
GitHub API docs: https://developer.github.com/v3/repos/commits/#list
func (s *RepositoriesService) ListContributors(ctx context.Context, owner string, repository string, opt *ListContributorsOptions) ([]*Contributor, *Response, error)
ListContributors lists contributors for a repository.
GitHub API docs: https://developer.github.com/v3/repos/#list-contributors
func (s *RepositoriesService) ListContributorsStats(ctx context.Context, owner, repo string) ([]*ContributorStats, *Response, error)
ListContributorsStats gets a repo's contributor list with additions, deletions and commit counts.
If this is the first time these statistics are requested for the given repository, this method will return an *AcceptedError and a status code of 202. This is because this is the status that GitHub returns to signify that it is now computing the requested statistics. A follow up request, after a delay of a second or so, should result in a successful request.
GitHub API docs: https://developer.github.com/v3/repos/statistics/#contributors
func (s *RepositoriesService) ListDeploymentStatuses(ctx context.Context, owner, repo string, deployment int64, opt *ListOptions) ([]*DeploymentStatus, *Response, error)
ListDeploymentStatuses lists the statuses of a given deployment of a repository.
GitHub API docs: https://developer.github.com/v3/repos/deployments/#list-deployment-statuses
func (s *RepositoriesService) ListDeployments(ctx context.Context, owner, repo string, opt *DeploymentsListOptions) ([]*Deployment, *Response, error)
ListDeployments lists the deployments of a repository.
GitHub API docs: https://developer.github.com/v3/repos/deployments/#list-deployments
func (s *RepositoriesService) ListForks(ctx context.Context, owner, repo string, opt *RepositoryListForksOptions) ([]*Repository, *Response, error)
ListForks lists the forks of the specified repository.
GitHub API docs: https://developer.github.com/v3/repos/forks/#list-forks
func (s *RepositoriesService) ListHooks(ctx context.Context, owner, repo string, opt *ListOptions) ([]*Hook, *Response, error)
ListHooks lists all Hooks for the specified repository.
GitHub API docs: https://developer.github.com/v3/repos/hooks/#list
func (s *RepositoriesService) ListInvitations(ctx context.Context, owner, repo string, opt *ListOptions) ([]*RepositoryInvitation, *Response, error)
ListInvitations lists all currently-open repository invitations.
GitHub API docs: https://developer.github.com/v3/repos/invitations/#list-invitations-for-a-repository
func (s *RepositoriesService) ListKeys(ctx context.Context, owner string, repo string, opt *ListOptions) ([]*Key, *Response, error)
ListKeys lists the deploy keys for a repository.
GitHub API docs: https://developer.github.com/v3/repos/keys/#list
func (s *RepositoriesService) ListLanguages(ctx context.Context, owner string, repo string) (map[string]int, *Response, error)
ListLanguages lists languages for the specified repository. The returned map specifies the languages and the number of bytes of code written in that language. For example:
{
"C": 78769,
"Python": 7769
}
GitHub API docs: https://developer.github.com/v3/repos/#list-languages
func (s *RepositoriesService) ListPagesBuilds(ctx context.Context, owner, repo string, opt *ListOptions) ([]*PagesBuild, *Response, error)
ListPagesBuilds lists the builds for a GitHub Pages site.
GitHub API docs: https://developer.github.com/v3/repos/pages/#list-pages-builds
func (s *RepositoriesService) ListParticipation(ctx context.Context, owner, repo string) (*RepositoryParticipation, *Response, error)
ListParticipation returns the total commit counts for the 'owner' and total commit counts in 'all'. 'all' is everyone combined, including the 'owner' in the last 52 weeks. If you’d like to get the commit counts for non-owners, you can subtract 'all' from 'owner'.
The array order is oldest week (index 0) to most recent week.
If this is the first time these statistics are requested for the given repository, this method will return an *AcceptedError and a status code of 202. This is because this is the status that GitHub returns to signify that it is now computing the requested statistics. A follow up request, after a delay of a second or so, should result in a successful request.
GitHub API docs: https://developer.github.com/v3/repos/statistics/#participation
func (s *RepositoriesService) ListPreReceiveHooks(ctx context.Context, owner, repo string, opt *ListOptions) ([]*PreReceiveHook, *Response, error)
ListPreReceiveHooks lists all pre-receive hooks for the specified repository.
GitHub API docs: https://developer.github.com/enterprise/2.13/v3/repos/pre_receive_hooks/#list-pre-receive-hooks
func (s *RepositoriesService) ListProjects(ctx context.Context, owner, repo string, opt *ProjectListOptions) ([]*Project, *Response, error)
ListProjects lists the projects for a repo.
GitHub API docs: https://developer.github.com/v3/projects/#list-repository-projects
func (s *RepositoriesService) ListPunchCard(ctx context.Context, owner, repo string) ([]*PunchCard, *Response, error)
ListPunchCard returns the number of commits per hour in each day.
If this is the first time these statistics are requested for the given repository, this method will return an *AcceptedError and a status code of 202. This is because this is the status that GitHub returns to signify that it is now computing the requested statistics. A follow up request, after a delay of a second or so, should result in a successful request.
GitHub API docs: https://developer.github.com/v3/repos/statistics/#punch-card
func (s *RepositoriesService) ListReleaseAssets(ctx context.Context, owner, repo string, id int64, opt *ListOptions) ([]*ReleaseAsset, *Response, error)
ListReleaseAssets lists the release's assets.
GitHub API docs: https://developer.github.com/v3/repos/releases/#list-assets-for-a-release
func (s *RepositoriesService) ListReleases(ctx context.Context, owner, repo string, opt *ListOptions) ([]*RepositoryRelease, *Response, error)
ListReleases lists the releases for a repository.
GitHub API docs: https://developer.github.com/v3/repos/releases/#list-releases-for-a-repository
func (s *RepositoriesService) ListRequiredStatusChecksContexts(ctx context.Context, owner, repo, branch string) (contexts []string, resp *Response, err error)
ListRequiredStatusChecksContexts lists the required status checks contexts for a given protected branch.
GitHub API docs: https://developer.github.com/v3/repos/branches/#list-required-status-checks-contexts-of-protected-branch
func (s *RepositoriesService) ListStatuses(ctx context.Context, owner, repo, ref string, opt *ListOptions) ([]*RepoStatus, *Response, error)
ListStatuses lists the statuses of a repository at the specified reference. ref can be a SHA, a branch name, or a tag name.
GitHub API docs: https://developer.github.com/v3/repos/statuses/#list-statuses-for-a-specific-ref
func (s *RepositoriesService) ListTags(ctx context.Context, owner string, repo string, opt *ListOptions) ([]*RepositoryTag, *Response, error)
ListTags lists tags for the specified repository.
GitHub API docs: https://developer.github.com/v3/repos/#list-tags
func (s *RepositoriesService) ListTeams(ctx context.Context, owner string, repo string, opt *ListOptions) ([]*Team, *Response, error)
ListTeams lists the teams for the specified repository.
GitHub API docs: https://developer.github.com/v3/repos/#list-teams
func (s *RepositoriesService) ListTrafficClones(ctx context.Context, owner, repo string, opt *TrafficBreakdownOptions) (*TrafficClones, *Response, error)
ListTrafficClones get total number of clones for the last 14 days and breaks it down either per day or week for the last 14 days.
GitHub API docs: https://developer.github.com/v3/repos/traffic/#views
func (s *RepositoriesService) ListTrafficPaths(ctx context.Context, owner, repo string) ([]*TrafficPath, *Response, error)
ListTrafficPaths list the top 10 popular content over the last 14 days.
GitHub API docs: https://developer.github.com/v3/repos/traffic/#list-paths
func (s *RepositoriesService) ListTrafficReferrers(ctx context.Context, owner, repo string) ([]*TrafficReferrer, *Response, error)
ListTrafficReferrers list the top 10 referrers over the last 14 days.
GitHub API docs: https://developer.github.com/v3/repos/traffic/#list-referrers
func (s *RepositoriesService) ListTrafficViews(ctx context.Context, owner, repo string, opt *TrafficBreakdownOptions) (*TrafficViews, *Response, error)
ListTrafficViews get total number of views for the last 14 days and breaks it down either per day or week.
GitHub API docs: https://developer.github.com/v3/repos/traffic/#views
func (s *RepositoriesService) Merge(ctx context.Context, owner, repo string, request *RepositoryMergeRequest) (*RepositoryCommit, *Response, error)
Merge a branch in the specified repository.
GitHub API docs: https://developer.github.com/v3/repos/merging/#perform-a-merge
func (s *RepositoriesService) PingHook(ctx context.Context, owner, repo string, id int64) (*Response, error)
PingHook triggers a 'ping' event to be sent to the Hook.
GitHub API docs: https://developer.github.com/v3/repos/hooks/#ping-a-hook
func (s *RepositoriesService) RemoveAdminEnforcement(ctx context.Context, owner, repo, branch string) (*Response, error)
RemoveAdminEnforcement removes admin enforcement from a protected branch.
GitHub API docs: https://developer.github.com/v3/repos/branches/#remove-admin-enforcement-of-protected-branch
func (s *RepositoriesService) RemoveBranchProtection(ctx context.Context, owner, repo, branch string) (*Response, error)
RemoveBranchProtection removes the protection of a given branch.
GitHub API docs: https://developer.github.com/v3/repos/branches/#remove-branch-protection
func (s *RepositoriesService) RemoveCollaborator(ctx context.Context, owner, repo, user string) (*Response, error)
RemoveCollaborator removes the specified GitHub user as collaborator from the given repo. Note: Does not return error if a valid user that is not a collaborator is removed.
GitHub API docs: https://developer.github.com/v3/repos/collaborators/#remove-collaborator
func (s *RepositoriesService) RemovePullRequestReviewEnforcement(ctx context.Context, owner, repo, branch string) (*Response, error)
RemovePullRequestReviewEnforcement removes pull request enforcement of a protected branch.
GitHub API docs: https://developer.github.com/v3/repos/branches/#remove-pull-request-review-enforcement-of-protected-branch
func (s *RepositoriesService) ReplaceAllTopics(ctx context.Context, owner, repo string, topics []string) ([]string, *Response, error)
ReplaceAllTopics replaces topics for a repository.
GitHub API docs: https://developer.github.com/v3/repos/#replace-all-topics-for-a-repository
func (s *RepositoriesService) RequestPageBuild(ctx context.Context, owner, repo string) (*PagesBuild, *Response, error)
RequestPageBuild requests a build of a GitHub Pages site without needing to push new commit.
GitHub API docs: https://developer.github.com/v3/repos/pages/#request-a-page-build
func (s *RepositoriesService) TestHook(ctx context.Context, owner, repo string, id int64) (*Response, error)
TestHook triggers a test Hook by github.
GitHub API docs: https://developer.github.com/v3/repos/hooks/#test-a-push-hook
func (s *RepositoriesService) Transfer(ctx context.Context, owner, repo string, transfer TransferRequest) (*Repository, *Response, error)
Transfer transfers a repository from one account or organization to another.
This method might return an *AcceptedError and a status code of 202. This is because this is the status that GitHub returns to signify that it has now scheduled the transfer of the repository in a background task. A follow up request, after a delay of a second or so, should result in a successful request.
GitHub API docs: https://developer.github.com/v3/repos/#transfer-a-repository
func (s *RepositoriesService) UpdateBranchProtection(ctx context.Context, owner, repo, branch string, preq *ProtectionRequest) (*Protection, *Response, error)
UpdateBranchProtection updates the protection of a given branch.
GitHub API docs: https://developer.github.com/v3/repos/branches/#update-branch-protection
func (s *RepositoriesService) UpdateComment(ctx context.Context, owner, repo string, id int64, comment *RepositoryComment) (*RepositoryComment, *Response, error)
UpdateComment updates the body of a single comment.
GitHub API docs: https://developer.github.com/v3/repos/comments/#update-a-commit-comment
func (s *RepositoriesService) UpdateFile(ctx context.Context, owner, repo, path string, opt *RepositoryContentFileOptions) (*RepositoryContentResponse, *Response, error)
UpdateFile updates a file in a repository at the given path and returns the commit and file metadata. Requires the blob SHA of the file being updated.
GitHub API docs: https://developer.github.com/v3/repos/contents/#update-a-file
func (s *RepositoriesService) UpdateInvitation(ctx context.Context, owner, repo string, invitationID int64, permissions string) (*RepositoryInvitation, *Response, error)
UpdateInvitation updates the permissions associated with a repository invitation.
permissions represents the permissions that the associated user will have on the repository. Possible values are: "read", "write", "admin".
GitHub API docs: https://developer.github.com/v3/repos/invitations/#update-a-repository-invitation
func (s *RepositoriesService) UpdatePreReceiveHook(ctx context.Context, owner, repo string, id int64, hook *PreReceiveHook) (*PreReceiveHook, *Response, error)
UpdatePreReceiveHook updates a specified pre-receive hook.
GitHub API docs: https://developer.github.com/enterprise/2.13/v3/repos/pre_receive_hooks/#update-pre-receive-hook-enforcement
func (s *RepositoriesService) UpdatePullRequestReviewEnforcement(ctx context.Context, owner, repo, branch string, patch *PullRequestReviewsEnforcementUpdate) (*PullRequestReviewsEnforcement, *Response, error)
UpdatePullRequestReviewEnforcement patches pull request review enforcement of a protected branch. It requires admin access and branch protection to be enabled.
GitHub API docs: https://developer.github.com/v3/repos/branches/#update-pull-request-review-enforcement-of-protected-branch
func (s *RepositoriesService) UpdateRequiredStatusChecks(ctx context.Context, owner, repo, branch string, sreq *RequiredStatusChecksRequest) (*RequiredStatusChecks, *Response, error)
UpdateRequiredStatusChecks updates the required status checks for a given protected branch.
GitHub API docs: https://developer.github.com/v3/repos/branches/#update-required-status-checks-of-protected-branch
func (s *RepositoriesService) UploadReleaseAsset(ctx context.Context, owner, repo string, id int64, opt *UploadOptions, file *os.File) (*ReleaseAsset, *Response, error)
UploadReleaseAsset creates an asset by uploading a file into a release repository. To upload assets that cannot be represented by an os.File, call NewUploadRequest directly.
GitHub API docs: https://developer.github.com/v3/repos/releases/#upload-a-release-asset
type Repository struct {
ID *int64 `json:"id,omitempty"`
NodeID *string `json:"node_id,omitempty"`
Owner *User `json:"owner,omitempty"`
Name *string `json:"name,omitempty"`
FullName *string `json:"full_name,omitempty"`
Description *string `json:"description,omitempty"`
Homepage *string `json:"homepage,omitempty"`
CodeOfConduct *CodeOfConduct `json:"code_of_conduct,omitempty"`
DefaultBranch *string `json:"default_branch,omitempty"`
MasterBranch *string `json:"master_branch,omitempty"`
CreatedAt *Timestamp `json:"created_at,omitempty"`
PushedAt *Timestamp `json:"pushed_at,omitempty"`
UpdatedAt *Timestamp `json:"updated_at,omitempty"`
HTMLURL *string `json:"html_url,omitempty"`
CloneURL *string `json:"clone_url,omitempty"`
GitURL *string `json:"git_url,omitempty"`
MirrorURL *string `json:"mirror_url,omitempty"`
SSHURL *string `json:"ssh_url,omitempty"`
SVNURL *string `json:"svn_url,omitempty"`
Language *string `json:"language,omitempty"`
Fork *bool `json:"fork,omitempty"`
ForksCount *int `json:"forks_count,omitempty"`
NetworkCount *int `json:"network_count,omitempty"`
OpenIssuesCount *int `json:"open_issues_count,omitempty"`
StargazersCount *int `json:"stargazers_count,omitempty"`
SubscribersCount *int `json:"subscribers_count,omitempty"`
WatchersCount *int `json:"watchers_count,omitempty"`
Size *int `json:"size,omitempty"`
AutoInit *bool `json:"auto_init,omitempty"`
Parent *Repository `json:"parent,omitempty"`
Source *Repository `json:"source,omitempty"`
Organization *Organization `json:"organization,omitempty"`
Permissions *map[string]bool `json:"permissions,omitempty"`
AllowRebaseMerge *bool `json:"allow_rebase_merge,omitempty"`
AllowSquashMerge *bool `json:"allow_squash_merge,omitempty"`
AllowMergeCommit *bool `json:"allow_merge_commit,omitempty"`
Topics []string `json:"topics,omitempty"`
// Only provided when using RepositoriesService.Get while in preview
License *License `json:"license,omitempty"`
// Additional mutable fields when creating and editing a repository
Private *bool `json:"private,omitempty"`
HasIssues *bool `json:"has_issues,omitempty"`
HasWiki *bool `json:"has_wiki,omitempty"`
HasPages *bool `json:"has_pages,omitempty"`
HasProjects *bool `json:"has_projects,omitempty"`
HasDownloads *bool `json:"has_downloads,omitempty"`
LicenseTemplate *string `json:"license_template,omitempty"`
GitignoreTemplate *string `json:"gitignore_template,omitempty"`
Archived *bool `json:"archived,omitempty"`
// Creating an organization repository. Required for non-owners.
TeamID *int64 `json:"team_id,omitempty"`
// API URLs
URL *string `json:"url,omitempty"`
ArchiveURL *string `json:"archive_url,omitempty"`
AssigneesURL *string `json:"assignees_url,omitempty"`
BlobsURL *string `json:"blobs_url,omitempty"`
BranchesURL *string `json:"branches_url,omitempty"`
CollaboratorsURL *string `json:"collaborators_url,omitempty"`
CommentsURL *string `json:"comments_url,omitempty"`
CommitsURL *string `json:"commits_url,omitempty"`
CompareURL *string `json:"compare_url,omitempty"`
ContentsURL *string `json:"contents_url,omitempty"`
ContributorsURL *string `json:"contributors_url,omitempty"`
DeploymentsURL *string `json:"deployments_url,omitempty"`
DownloadsURL *string `json:"downloads_url,omitempty"`
EventsURL *string `json:"events_url,omitempty"`
ForksURL *string `json:"forks_url,omitempty"`
GitCommitsURL *string `json:"git_commits_url,omitempty"`
GitRefsURL *string `json:"git_refs_url,omitempty"`
GitTagsURL *string `json:"git_tags_url,omitempty"`
HooksURL *string `json:"hooks_url,omitempty"`
IssueCommentURL *string `json:"issue_comment_url,omitempty"`
IssueEventsURL *string `json:"issue_events_url,omitempty"`
IssuesURL *string `json:"issues_url,omitempty"`
KeysURL *string `json:"keys_url,omitempty"`
LabelsURL *string `json:"labels_url,omitempty"`
LanguagesURL *string `json:"languages_url,omitempty"`
MergesURL *string `json:"merges_url,omitempty"`
MilestonesURL *string `json:"milestones_url,omitempty"`
NotificationsURL *string `json:"notifications_url,omitempty"`
PullsURL *string `json:"pulls_url,omitempty"`
ReleasesURL *string `json:"releases_url,omitempty"`
StargazersURL *string `json:"stargazers_url,omitempty"`
StatusesURL *string `json:"statuses_url,omitempty"`
SubscribersURL *string `json:"subscribers_url,omitempty"`
SubscriptionURL *string `json:"subscription_url,omitempty"`
TagsURL *string `json:"tags_url,omitempty"`
TreesURL *string `json:"trees_url,omitempty"`
TeamsURL *string `json:"teams_url,omitempty"`
// TextMatches is only populated from search results that request text matches
// See: search.go and https://developer.github.com/v3/search/#text-match-metadata
TextMatches []TextMatch `json:"text_matches,omitempty"`
}
Repository represents a GitHub repository.
func (r *Repository) GetAllowMergeCommit() bool
GetAllowMergeCommit returns the AllowMergeCommit field if it's non-nil, zero value otherwise.
func (r *Repository) GetAllowRebaseMerge() bool
GetAllowRebaseMerge returns the AllowRebaseMerge field if it's non-nil, zero value otherwise.
func (r *Repository) GetAllowSquashMerge() bool
GetAllowSquashMerge returns the AllowSquashMerge field if it's non-nil, zero value otherwise.
func (r *Repository) GetArchiveURL() string
GetArchiveURL returns the ArchiveURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetArchived() bool
GetArchived returns the Archived field if it's non-nil, zero value otherwise.
func (r *Repository) GetAssigneesURL() string
GetAssigneesURL returns the AssigneesURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetAutoInit() bool
GetAutoInit returns the AutoInit field if it's non-nil, zero value otherwise.
func (r *Repository) GetBlobsURL() string
GetBlobsURL returns the BlobsURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetBranchesURL() string
GetBranchesURL returns the BranchesURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetCloneURL() string
GetCloneURL returns the CloneURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetCodeOfConduct() *CodeOfConduct
GetCodeOfConduct returns the CodeOfConduct field.
func (r *Repository) GetCollaboratorsURL() string
GetCollaboratorsURL returns the CollaboratorsURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetCommentsURL() string
GetCommentsURL returns the CommentsURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetCommitsURL() string
GetCommitsURL returns the CommitsURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetCompareURL() string
GetCompareURL returns the CompareURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetContentsURL() string
GetContentsURL returns the ContentsURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetContributorsURL() string
GetContributorsURL returns the ContributorsURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetCreatedAt() Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (r *Repository) GetDefaultBranch() string
GetDefaultBranch returns the DefaultBranch field if it's non-nil, zero value otherwise.
func (r *Repository) GetDeploymentsURL() string
GetDeploymentsURL returns the DeploymentsURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetDescription() string
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (r *Repository) GetDownloadsURL() string
GetDownloadsURL returns the DownloadsURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetEventsURL() string
GetEventsURL returns the EventsURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetFork() bool
GetFork returns the Fork field if it's non-nil, zero value otherwise.
func (r *Repository) GetForksCount() int
GetForksCount returns the ForksCount field if it's non-nil, zero value otherwise.
func (r *Repository) GetForksURL() string
GetForksURL returns the ForksURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetFullName() string
GetFullName returns the FullName field if it's non-nil, zero value otherwise.
func (r *Repository) GetGitCommitsURL() string
GetGitCommitsURL returns the GitCommitsURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetGitRefsURL() string
GetGitRefsURL returns the GitRefsURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetGitTagsURL() string
GetGitTagsURL returns the GitTagsURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetGitURL() string
GetGitURL returns the GitURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetGitignoreTemplate() string
GetGitignoreTemplate returns the GitignoreTemplate field if it's non-nil, zero value otherwise.
func (r *Repository) GetHTMLURL() string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetHasDownloads() bool
GetHasDownloads returns the HasDownloads field if it's non-nil, zero value otherwise.
func (r *Repository) GetHasIssues() bool
GetHasIssues returns the HasIssues field if it's non-nil, zero value otherwise.
func (r *Repository) GetHasPages() bool
GetHasPages returns the HasPages field if it's non-nil, zero value otherwise.
func (r *Repository) GetHasProjects() bool
GetHasProjects returns the HasProjects field if it's non-nil, zero value otherwise.
func (r *Repository) GetHasWiki() bool
GetHasWiki returns the HasWiki field if it's non-nil, zero value otherwise.
func (r *Repository) GetHomepage() string
GetHomepage returns the Homepage field if it's non-nil, zero value otherwise.
func (r *Repository) GetHooksURL() string
GetHooksURL returns the HooksURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (r *Repository) GetIssueCommentURL() string
GetIssueCommentURL returns the IssueCommentURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetIssueEventsURL() string
GetIssueEventsURL returns the IssueEventsURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetIssuesURL() string
GetIssuesURL returns the IssuesURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetKeysURL() string
GetKeysURL returns the KeysURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetLabelsURL() string
GetLabelsURL returns the LabelsURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetLanguage() string
GetLanguage returns the Language field if it's non-nil, zero value otherwise.
func (r *Repository) GetLanguagesURL() string
GetLanguagesURL returns the LanguagesURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetLicense() *License
GetLicense returns the License field.
func (r *Repository) GetLicenseTemplate() string
GetLicenseTemplate returns the LicenseTemplate field if it's non-nil, zero value otherwise.
func (r *Repository) GetMasterBranch() string
GetMasterBranch returns the MasterBranch field if it's non-nil, zero value otherwise.
func (r *Repository) GetMergesURL() string
GetMergesURL returns the MergesURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetMilestonesURL() string
GetMilestonesURL returns the MilestonesURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetMirrorURL() string
GetMirrorURL returns the MirrorURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetName() string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (r *Repository) GetNetworkCount() int
GetNetworkCount returns the NetworkCount field if it's non-nil, zero value otherwise.
func (r *Repository) GetNodeID() string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (r *Repository) GetNotificationsURL() string
GetNotificationsURL returns the NotificationsURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetOpenIssuesCount() int
GetOpenIssuesCount returns the OpenIssuesCount field if it's non-nil, zero value otherwise.
func (r *Repository) GetOrganization() *Organization
GetOrganization returns the Organization field.
func (r *Repository) GetOwner() *User
GetOwner returns the Owner field.
func (r *Repository) GetParent() *Repository
GetParent returns the Parent field.
func (r *Repository) GetPermissions() map[string]bool
GetPermissions returns the Permissions field if it's non-nil, zero value otherwise.
func (r *Repository) GetPrivate() bool
GetPrivate returns the Private field if it's non-nil, zero value otherwise.
func (r *Repository) GetPullsURL() string
GetPullsURL returns the PullsURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetPushedAt() Timestamp
GetPushedAt returns the PushedAt field if it's non-nil, zero value otherwise.
func (r *Repository) GetReleasesURL() string
GetReleasesURL returns the ReleasesURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetSSHURL() string
GetSSHURL returns the SSHURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetSVNURL() string
GetSVNURL returns the SVNURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetSize() int
GetSize returns the Size field if it's non-nil, zero value otherwise.
func (r *Repository) GetSource() *Repository
GetSource returns the Source field.
func (r *Repository) GetStargazersCount() int
GetStargazersCount returns the StargazersCount field if it's non-nil, zero value otherwise.
func (r *Repository) GetStargazersURL() string
GetStargazersURL returns the StargazersURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetStatusesURL() string
GetStatusesURL returns the StatusesURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetSubscribersCount() int
GetSubscribersCount returns the SubscribersCount field if it's non-nil, zero value otherwise.
func (r *Repository) GetSubscribersURL() string
GetSubscribersURL returns the SubscribersURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetSubscriptionURL() string
GetSubscriptionURL returns the SubscriptionURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetTagsURL() string
GetTagsURL returns the TagsURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetTeamID() int64
GetTeamID returns the TeamID field if it's non-nil, zero value otherwise.
func (r *Repository) GetTeamsURL() string
GetTeamsURL returns the TeamsURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetTreesURL() string
GetTreesURL returns the TreesURL field if it's non-nil, zero value otherwise.
func (r *Repository) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (r *Repository) GetUpdatedAt() Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (r *Repository) GetWatchersCount() int
GetWatchersCount returns the WatchersCount field if it's non-nil, zero value otherwise.
func (r Repository) String() string
type RepositoryAddCollaboratorOptions struct {
// Permission specifies the permission to grant the user on this repository.
// Possible values are:
// pull - team members can pull, but not push to or administer this repository
// push - team members can pull and push, but not administer this repository
// admin - team members can pull, push and administer this repository
//
// Default value is "push". This option is only valid for organization-owned repositories.
Permission string `json:"permission,omitempty"`
}
RepositoryAddCollaboratorOptions specifies the optional parameters to the RepositoriesService.AddCollaborator method.
type RepositoryComment struct {
HTMLURL *string `json:"html_url,omitempty"`
URL *string `json:"url,omitempty"`
ID *int64 `json:"id,omitempty"`
CommitID *string `json:"commit_id,omitempty"`
User *User `json:"user,omitempty"`
Reactions *Reactions `json:"reactions,omitempty"`
CreatedAt *time.Time `json:"created_at,omitempty"`
UpdatedAt *time.Time `json:"updated_at,omitempty"`
// User-mutable fields
Body *string `json:"body"`
// User-initialized fields
Path *string `json:"path,omitempty"`
Position *int `json:"position,omitempty"`
}
RepositoryComment represents a comment for a commit, file, or line in a repository.
func (r *RepositoryComment) GetBody() string
GetBody returns the Body field if it's non-nil, zero value otherwise.
func (r *RepositoryComment) GetCommitID() string
GetCommitID returns the CommitID field if it's non-nil, zero value otherwise.
func (r *RepositoryComment) GetCreatedAt() time.Time
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (r *RepositoryComment) GetHTMLURL() string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (r *RepositoryComment) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (r *RepositoryComment) GetPath() string
GetPath returns the Path field if it's non-nil, zero value otherwise.
func (r *RepositoryComment) GetPosition() int
GetPosition returns the Position field if it's non-nil, zero value otherwise.
func (r *RepositoryComment) GetReactions() *Reactions
GetReactions returns the Reactions field.
func (r *RepositoryComment) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (r *RepositoryComment) GetUpdatedAt() time.Time
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (r *RepositoryComment) GetUser() *User
GetUser returns the User field.
func (r RepositoryComment) String() string
type RepositoryCommit 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"`
// Details about how many changes were made in this commit. Only filled in during GetCommit!
Stats *CommitStats `json:"stats,omitempty"`
// Details about which files, and how this commit touched. Only filled in during GetCommit!
Files []CommitFile `json:"files,omitempty"`
}
RepositoryCommit represents a commit in a repo. Note that it's wrapping a Commit, so author/committer information is in two places, but contain different details about them: in RepositoryCommit "github details", in Commit - "git details".
func (r *RepositoryCommit) GetAuthor() *User
GetAuthor returns the Author field.
func (r *RepositoryCommit) GetCommentsURL() string
GetCommentsURL returns the CommentsURL field if it's non-nil, zero value otherwise.
func (r *RepositoryCommit) GetCommit() *Commit
GetCommit returns the Commit field.
func (r *RepositoryCommit) GetCommitter() *User
GetCommitter returns the Committer field.
func (r *RepositoryCommit) GetHTMLURL() string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (r *RepositoryCommit) GetSHA() string
GetSHA returns the SHA field if it's non-nil, zero value otherwise.
func (r *RepositoryCommit) GetStats() *CommitStats
GetStats returns the Stats field.
func (r *RepositoryCommit) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (r RepositoryCommit) String() string
type RepositoryContent struct {
Type *string `json:"type,omitempty"`
Encoding *string `json:"encoding,omitempty"`
Size *int `json:"size,omitempty"`
Name *string `json:"name,omitempty"`
Path *string `json:"path,omitempty"`
// Content contains the actual file content, which may be encoded.
// Callers should call GetContent which will decode the content if
// necessary.
Content *string `json:"content,omitempty"`
SHA *string `json:"sha,omitempty"`
URL *string `json:"url,omitempty"`
GitURL *string `json:"git_url,omitempty"`
HTMLURL *string `json:"html_url,omitempty"`
DownloadURL *string `json:"download_url,omitempty"`
}
RepositoryContent represents a file or directory in a github repository.
func (r *RepositoryContent) GetContent() (string, error)
GetContent returns the content of r, decoding it if necessary.
func (r *RepositoryContent) GetDownloadURL() string
GetDownloadURL returns the DownloadURL field if it's non-nil, zero value otherwise.
func (r *RepositoryContent) GetEncoding() string
GetEncoding returns the Encoding field if it's non-nil, zero value otherwise.
func (r *RepositoryContent) GetGitURL() string
GetGitURL returns the GitURL field if it's non-nil, zero value otherwise.
func (r *RepositoryContent) GetHTMLURL() string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (r *RepositoryContent) GetName() string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (r *RepositoryContent) GetPath() string
GetPath returns the Path field if it's non-nil, zero value otherwise.
func (r *RepositoryContent) GetSHA() string
GetSHA returns the SHA field if it's non-nil, zero value otherwise.
func (r *RepositoryContent) GetSize() int
GetSize returns the Size field if it's non-nil, zero value otherwise.
func (r *RepositoryContent) GetType() string
GetType returns the Type field if it's non-nil, zero value otherwise.
func (r *RepositoryContent) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (r RepositoryContent) String() string
String converts RepositoryContent to a string. It's primarily for testing.
type RepositoryContentFileOptions struct {
Message *string `json:"message,omitempty"`
Content []byte `json:"content,omitempty"` // unencoded
SHA *string `json:"sha,omitempty"`
Branch *string `json:"branch,omitempty"`
Author *CommitAuthor `json:"author,omitempty"`
Committer *CommitAuthor `json:"committer,omitempty"`
}
RepositoryContentFileOptions specifies optional parameters for CreateFile, UpdateFile, and DeleteFile.
func (r *RepositoryContentFileOptions) GetAuthor() *CommitAuthor
GetAuthor returns the Author field.
func (r *RepositoryContentFileOptions) GetBranch() string
GetBranch returns the Branch field if it's non-nil, zero value otherwise.
func (r *RepositoryContentFileOptions) GetCommitter() *CommitAuthor
GetCommitter returns the Committer field.
func (r *RepositoryContentFileOptions) GetMessage() string
GetMessage returns the Message field if it's non-nil, zero value otherwise.
func (r *RepositoryContentFileOptions) GetSHA() string
GetSHA returns the SHA field if it's non-nil, zero value otherwise.
type RepositoryContentGetOptions struct {
Ref string `url:"ref,omitempty"`
}
RepositoryContentGetOptions represents an optional ref parameter, which can be a SHA, branch, or tag
type RepositoryContentResponse struct {
Content *RepositoryContent `json:"content,omitempty"`
Commit `json:"commit,omitempty"`
}
RepositoryContentResponse holds the parsed response from CreateFile, UpdateFile, and DeleteFile.
func (r *RepositoryContentResponse) GetContent() *RepositoryContent
GetContent returns the Content field.
type RepositoryCreateForkOptions struct {
// The organization to fork the repository into.
Organization string `url:"organization,omitempty"`
}
RepositoryCreateForkOptions specifies the optional parameters to the RepositoriesService.CreateFork method.
type RepositoryEvent struct {
// Action is the action that was performed. Possible values are: "created", "deleted",
// "publicized", "privatized".
Action *string `json:"action,omitempty"`
Repo *Repository `json:"repository,omitempty"`
// The following fields are only populated by Webhook events.
Org *Organization `json:"organization,omitempty"`
Sender *User `json:"sender,omitempty"`
Installation *Installation `json:"installation,omitempty"`
}
RepositoryEvent is triggered when a repository is created. The Webhook event name is "repository".
Events of this type are not visible in timelines, they are only used to trigger organization webhooks.
GitHub API docs: https://developer.github.com/v3/activity/events/types/#repositoryevent
func (r *RepositoryEvent) GetAction() string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (r *RepositoryEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (r *RepositoryEvent) GetOrg() *Organization
GetOrg returns the Org field.
func (r *RepositoryEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (r *RepositoryEvent) GetSender() *User
GetSender returns the Sender field.
type RepositoryInvitation struct {
ID *int64 `json:"id,omitempty"`
Repo *Repository `json:"repository,omitempty"`
Invitee *User `json:"invitee,omitempty"`
Inviter *User `json:"inviter,omitempty"`
// Permissions represents the permissions that the associated user will have
// on the repository. Possible values are: "read", "write", "admin".
Permissions *string `json:"permissions,omitempty"`
CreatedAt *Timestamp `json:"created_at,omitempty"`
URL *string `json:"url,omitempty"`
HTMLURL *string `json:"html_url,omitempty"`
}
RepositoryInvitation represents an invitation to collaborate on a repo.
func (r *RepositoryInvitation) GetCreatedAt() Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (r *RepositoryInvitation) GetHTMLURL() string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (r *RepositoryInvitation) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (r *RepositoryInvitation) GetInvitee() *User
GetInvitee returns the Invitee field.
func (r *RepositoryInvitation) GetInviter() *User
GetInviter returns the Inviter field.
func (r *RepositoryInvitation) GetPermissions() string
GetPermissions returns the Permissions field if it's non-nil, zero value otherwise.
func (r *RepositoryInvitation) GetRepo() *Repository
GetRepo returns the Repo field.
func (r *RepositoryInvitation) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
type RepositoryLicense struct {
Name *string `json:"name,omitempty"`
Path *string `json:"path,omitempty"`
SHA *string `json:"sha,omitempty"`
Size *int `json:"size,omitempty"`
URL *string `json:"url,omitempty"`
HTMLURL *string `json:"html_url,omitempty"`
GitURL *string `json:"git_url,omitempty"`
DownloadURL *string `json:"download_url,omitempty"`
Type *string `json:"type,omitempty"`
Content *string `json:"content,omitempty"`
Encoding *string `json:"encoding,omitempty"`
License *License `json:"license,omitempty"`
}
RepositoryLicense represents the license for a repository.
func (r *RepositoryLicense) GetContent() string
GetContent returns the Content field if it's non-nil, zero value otherwise.
func (r *RepositoryLicense) GetDownloadURL() string
GetDownloadURL returns the DownloadURL field if it's non-nil, zero value otherwise.
func (r *RepositoryLicense) GetEncoding() string
GetEncoding returns the Encoding field if it's non-nil, zero value otherwise.
func (r *RepositoryLicense) GetGitURL() string
GetGitURL returns the GitURL field if it's non-nil, zero value otherwise.
func (r *RepositoryLicense) GetHTMLURL() string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (r *RepositoryLicense) GetLicense() *License
GetLicense returns the License field.
func (r *RepositoryLicense) GetName() string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (r *RepositoryLicense) GetPath() string
GetPath returns the Path field if it's non-nil, zero value otherwise.
func (r *RepositoryLicense) GetSHA() string
GetSHA returns the SHA field if it's non-nil, zero value otherwise.
func (r *RepositoryLicense) GetSize() int
GetSize returns the Size field if it's non-nil, zero value otherwise.
func (r *RepositoryLicense) GetType() string
GetType returns the Type field if it's non-nil, zero value otherwise.
func (r *RepositoryLicense) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (l RepositoryLicense) String() string
type RepositoryListAllOptions struct {
// ID of the last repository seen
Since int64 `url:"since,omitempty"`
}
RepositoryListAllOptions specifies the optional parameters to the RepositoriesService.ListAll method.
type RepositoryListByOrgOptions struct {
// Type of repositories to list. Possible values are: all, public, private,
// forks, sources, member. Default is "all".
Type string `url:"type,omitempty"`
ListOptions
}
RepositoryListByOrgOptions specifies the optional parameters to the RepositoriesService.ListByOrg method.
type RepositoryListForksOptions struct {
// How to sort the forks list. Possible values are: newest, oldest,
// watchers. Default is "newest".
Sort string `url:"sort,omitempty"`
ListOptions
}
RepositoryListForksOptions specifies the optional parameters to the RepositoriesService.ListForks method.
type RepositoryListOptions struct {
// Visibility of repositories to list. Can be one of all, public, or private.
// Default: all
Visibility string `url:"visibility,omitempty"`
// List repos of given affiliation[s].
// Comma-separated list of values. Can include:
// * owner: Repositories that are owned by the authenticated user.
// * collaborator: Repositories that the user has been added to as a
// collaborator.
// * organization_member: Repositories that the user has access to through
// being a member of an organization. This includes every repository on
// every team that the user is on.
// Default: owner,collaborator,organization_member
Affiliation string `url:"affiliation,omitempty"`
// Type of repositories to list.
// Can be one of all, owner, public, private, member. Default: all
// Will cause a 422 error if used in the same request as visibility or
// affiliation.
Type string `url:"type,omitempty"`
// How to sort the repository list. Can be one of created, updated, pushed,
// full_name. Default: full_name
Sort string `url:"sort,omitempty"`
// Direction in which to sort repositories. Can be one of asc or desc.
// Default: when using full_name: asc; otherwise desc
Direction string `url:"direction,omitempty"`
ListOptions
}
RepositoryListOptions specifies the optional parameters to the RepositoriesService.List method.
type RepositoryMergeRequest struct {
Base *string `json:"base,omitempty"`
Head *string `json:"head,omitempty"`
CommitMessage *string `json:"commit_message,omitempty"`
}
RepositoryMergeRequest represents a request to merge a branch in a repository.
func (r *RepositoryMergeRequest) GetBase() string
GetBase returns the Base field if it's non-nil, zero value otherwise.
func (r *RepositoryMergeRequest) GetCommitMessage() string
GetCommitMessage returns the CommitMessage field if it's non-nil, zero value otherwise.
func (r *RepositoryMergeRequest) GetHead() string
GetHead returns the Head field if it's non-nil, zero value otherwise.
type RepositoryParticipation struct {
All []int `json:"all,omitempty"`
Owner []int `json:"owner,omitempty"`
}
RepositoryParticipation is the number of commits by everyone who has contributed to the repository (including the owner) as well as the number of commits by the owner themself.
func (r RepositoryParticipation) String() string
type RepositoryPermissionLevel struct {
// Possible values: "admin", "write", "read", "none"
Permission *string `json:"permission,omitempty"`
User *User `json:"user,omitempty"`
}
RepositoryPermissionLevel represents the permission level an organization member has for a given repository.
func (r *RepositoryPermissionLevel) GetPermission() string
GetPermission returns the Permission field if it's non-nil, zero value otherwise.
func (r *RepositoryPermissionLevel) GetUser() *User
GetUser returns the User field.
type RepositoryRelease struct {
ID *int64 `json:"id,omitempty"`
TagName *string `json:"tag_name,omitempty"`
TargetCommitish *string `json:"target_commitish,omitempty"`
Name *string `json:"name,omitempty"`
Body *string `json:"body,omitempty"`
Draft *bool `json:"draft,omitempty"`
Prerelease *bool `json:"prerelease,omitempty"`
CreatedAt *Timestamp `json:"created_at,omitempty"`
PublishedAt *Timestamp `json:"published_at,omitempty"`
URL *string `json:"url,omitempty"`
HTMLURL *string `json:"html_url,omitempty"`
AssetsURL *string `json:"assets_url,omitempty"`
Assets []ReleaseAsset `json:"assets,omitempty"`
UploadURL *string `json:"upload_url,omitempty"`
ZipballURL *string `json:"zipball_url,omitempty"`
TarballURL *string `json:"tarball_url,omitempty"`
Author *User `json:"author,omitempty"`
NodeID *string `json:"node_id,omitempty"`
}
RepositoryRelease represents a GitHub release in a repository.
func (r *RepositoryRelease) GetAssetsURL() string
GetAssetsURL returns the AssetsURL field if it's non-nil, zero value otherwise.
func (r *RepositoryRelease) GetAuthor() *User
GetAuthor returns the Author field.
func (r *RepositoryRelease) GetBody() string
GetBody returns the Body field if it's non-nil, zero value otherwise.
func (r *RepositoryRelease) GetCreatedAt() Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (r *RepositoryRelease) GetDraft() bool
GetDraft returns the Draft field if it's non-nil, zero value otherwise.
func (r *RepositoryRelease) GetHTMLURL() string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (r *RepositoryRelease) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (r *RepositoryRelease) GetName() string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (r *RepositoryRelease) GetNodeID() string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (r *RepositoryRelease) GetPrerelease() bool
GetPrerelease returns the Prerelease field if it's non-nil, zero value otherwise.
func (r *RepositoryRelease) GetPublishedAt() Timestamp
GetPublishedAt returns the PublishedAt field if it's non-nil, zero value otherwise.
func (r *RepositoryRelease) GetTagName() string
GetTagName returns the TagName field if it's non-nil, zero value otherwise.
func (r *RepositoryRelease) GetTarballURL() string
GetTarballURL returns the TarballURL field if it's non-nil, zero value otherwise.
func (r *RepositoryRelease) GetTargetCommitish() string
GetTargetCommitish returns the TargetCommitish field if it's non-nil, zero value otherwise.
func (r *RepositoryRelease) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (r *RepositoryRelease) GetUploadURL() string
GetUploadURL returns the UploadURL field if it's non-nil, zero value otherwise.
func (r *RepositoryRelease) GetZipballURL() string
GetZipballURL returns the ZipballURL field if it's non-nil, zero value otherwise.
func (r RepositoryRelease) String() string
type RepositoryTag struct {
Name *string `json:"name,omitempty"`
Commit *Commit `json:"commit,omitempty"`
ZipballURL *string `json:"zipball_url,omitempty"`
TarballURL *string `json:"tarball_url,omitempty"`
}
RepositoryTag represents a repository tag.
func (r *RepositoryTag) GetCommit() *Commit
GetCommit returns the Commit field.
func (r *RepositoryTag) GetName() string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (r *RepositoryTag) GetTarballURL() string
GetTarballURL returns the TarballURL field if it's non-nil, zero value otherwise.
func (r *RepositoryTag) GetZipballURL() string
GetZipballURL returns the ZipballURL field if it's non-nil, zero value otherwise.
type RequestCheckSuiteOptions struct {
HeadSHA string `json:"head_sha"` // The sha of the head commit. (Required.)
}
RequestCheckSuiteOptions sets up the parameters for a request check suite endpoint.
type RequiredStatusChecks struct {
// Require branches to be up to date before merging. (Required.)
Strict bool `json:"strict"`
// The list of status checks to require in order to merge into this
// branch. (Required; use []string{} instead of nil for empty list.)
Contexts []string `json:"contexts"`
}
RequiredStatusChecks represents the protection status of a individual branch.
type RequiredStatusChecksRequest struct {
Strict *bool `json:"strict,omitempty"`
Contexts []string `json:"contexts,omitempty"`
}
RequiredStatusChecksRequest represents a request to edit a protected branch's status checks.
func (r *RequiredStatusChecksRequest) GetStrict() bool
GetStrict returns the Strict field if it's non-nil, zero value otherwise.
type Response struct {
*http.Response
NextPage int
PrevPage int
FirstPage int
LastPage int
Rate
}
Response is a GitHub API response. This wraps the standard http.Response returned from GitHub and provides convenient access to things like pagination links.
type Reviewers struct {
Users []*User `json:"users,omitempty"`
Teams []*Team `json:"teams,omitempty"`
}
Reviewers represents reviewers of a pull request.
type ReviewersRequest struct {
Reviewers []string `json:"reviewers,omitempty"`
TeamReviewers []string `json:"team_reviewers,omitempty"`
}
ReviewersRequest specifies users and teams for a pull request review request.
type Scope string
Scope models a GitHub authorization scope.
GitHub API docs: https://developer.github.com/v3/oauth/#scopes
const ( ScopeNone Scope = "(no scope)" // REVISIT: is this actually returned, or just a documentation artifact? ScopeUser Scope = "user" ScopeUserEmail Scope = "user:email" ScopeUserFollow Scope = "user:follow" ScopePublicRepo Scope = "public_repo" ScopeRepo Scope = "repo" ScopeRepoDeployment Scope = "repo_deployment" ScopeRepoStatus Scope = "repo:status" ScopeDeleteRepo Scope = "delete_repo" ScopeNotifications Scope = "notifications" ScopeGist Scope = "gist" ScopeReadRepoHook Scope = "read:repo_hook" ScopeWriteRepoHook Scope = "write:repo_hook" ScopeAdminRepoHook Scope = "admin:repo_hook" ScopeAdminOrgHook Scope = "admin:org_hook" ScopeReadOrg Scope = "read:org" ScopeWriteOrg Scope = "write:org" ScopeAdminOrg Scope = "admin:org" ScopeReadPublicKey Scope = "read:public_key" ScopeWritePublicKey Scope = "write:public_key" ScopeAdminPublicKey Scope = "admin:public_key" ScopeReadGPGKey Scope = "read:gpg_key" ScopeWriteGPGKey Scope = "write:gpg_key" ScopeAdminGPGKey Scope = "admin:gpg_key" )
This is the set of scopes for GitHub API V3
type SearchOptions struct {
// How to sort the search results. Possible values are:
// - for repositories: stars, fork, updated
// - for commits: author-date, committer-date
// - for code: indexed
// - for issues: comments, created, updated
// - for users: followers, repositories, joined
//
// Default is to sort by best match.
Sort string `url:"sort,omitempty"`
// Sort order if sort parameter is provided. Possible values are: asc,
// desc. Default is desc.
Order string `url:"order,omitempty"`
// Whether to retrieve text match metadata with a query
TextMatch bool `url:"-"`
ListOptions
}
SearchOptions specifies optional parameters to the SearchService methods.
type SearchService service
SearchService provides access to the search related functions in the GitHub API.
Each method takes a query string defining the search keywords and any search qualifiers. For example, when searching issues, the query "gopher is:issue language:go" will search for issues containing the word "gopher" in Go repositories. The method call
opts := &github.SearchOptions{Sort: "created", Order: "asc"}
cl.Search.Issues(ctx, "gopher is:issue language:go", opts)
will search for such issues, sorting by creation date in ascending order (i.e., oldest first).
GitHub API docs: https://developer.github.com/v3/search/
func (s *SearchService) Code(ctx context.Context, query string, opt *SearchOptions) (*CodeSearchResult, *Response, error)
Code searches code via various criteria.
GitHub API docs: https://developer.github.com/v3/search/#search-code
func (s *SearchService) Commits(ctx context.Context, query string, opt *SearchOptions) (*CommitsSearchResult, *Response, error)
Commits searches commits via various criteria.
GitHub API docs: https://developer.github.com/v3/search/#search-commits
func (s *SearchService) Issues(ctx context.Context, query string, opt *SearchOptions) (*IssuesSearchResult, *Response, error)
Issues searches issues via various criteria.
GitHub API docs: https://developer.github.com/v3/search/#search-issues
func (s *SearchService) Labels(ctx context.Context, repoID int64, query string, opt *SearchOptions) (*LabelsSearchResult, *Response, error)
Labels searches labels in the repository with ID repoID via various criteria.
GitHub API docs: https://developer.github.com/v3/search/#search-labels
func (s *SearchService) Repositories(ctx context.Context, query string, opt *SearchOptions) (*RepositoriesSearchResult, *Response, error)
Repositories searches repositories via various criteria.
GitHub API docs: https://developer.github.com/v3/search/#search-repositories
func (s *SearchService) Users(ctx context.Context, query string, opt *SearchOptions) (*UsersSearchResult, *Response, error)
Users searches users via various criteria.
GitHub API docs: https://developer.github.com/v3/search/#search-users
type ServiceHook struct {
Name *string `json:"name,omitempty"`
Events []string `json:"events,omitempty"`
SupportedEvents []string `json:"supported_events,omitempty"`
Schema [][]string `json:"schema,omitempty"`
}
ServiceHook represents a hook that has configuration settings, a list of available events, and default events.
func (s *ServiceHook) GetName() string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (s *ServiceHook) String() string
type SignatureVerification struct {
Verified *bool `json:"verified,omitempty"`
Reason *string `json:"reason,omitempty"`
Signature *string `json:"signature,omitempty"`
Payload *string `json:"payload,omitempty"`
}
SignatureVerification represents GPG signature verification.
func (s *SignatureVerification) GetPayload() string
GetPayload returns the Payload field if it's non-nil, zero value otherwise.
func (s *SignatureVerification) GetReason() string
GetReason returns the Reason field if it's non-nil, zero value otherwise.
func (s *SignatureVerification) GetSignature() string
GetSignature returns the Signature field if it's non-nil, zero value otherwise.
func (s *SignatureVerification) GetVerified() bool
GetVerified returns the Verified field if it's non-nil, zero value otherwise.
type Source struct {
ID *int64 `json:"id,omitempty"`
URL *string `json:"url,omitempty"`
Actor *User `json:"actor,omitempty"`
}
Source represents a reference's source.
func (s *Source) GetActor() *User
GetActor returns the Actor field.
func (s *Source) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (s *Source) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
type SourceImportAuthor struct {
ID *int64 `json:"id,omitempty"`
RemoteID *string `json:"remote_id,omitempty"`
RemoteName *string `json:"remote_name,omitempty"`
Email *string `json:"email,omitempty"`
Name *string `json:"name,omitempty"`
URL *string `json:"url,omitempty"`
ImportURL *string `json:"import_url,omitempty"`
}
SourceImportAuthor identifies an author imported from a source repository.
GitHub API docs: https://developer.github.com/v3/migration/source_imports/#get-commit-authors
func (s *SourceImportAuthor) GetEmail() string
GetEmail returns the Email field if it's non-nil, zero value otherwise.
func (s *SourceImportAuthor) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (s *SourceImportAuthor) GetImportURL() string
GetImportURL returns the ImportURL field if it's non-nil, zero value otherwise.
func (s *SourceImportAuthor) GetName() string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (s *SourceImportAuthor) GetRemoteID() string
GetRemoteID returns the RemoteID field if it's non-nil, zero value otherwise.
func (s *SourceImportAuthor) GetRemoteName() string
GetRemoteName returns the RemoteName field if it's non-nil, zero value otherwise.
func (s *SourceImportAuthor) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (a SourceImportAuthor) String() string
type Stargazer struct {
StarredAt *Timestamp `json:"starred_at,omitempty"`
User *User `json:"user,omitempty"`
}
Stargazer represents a user that has starred a repository.
func (s *Stargazer) GetStarredAt() Timestamp
GetStarredAt returns the StarredAt field if it's non-nil, zero value otherwise.
func (s *Stargazer) GetUser() *User
GetUser returns the User field.
type StarredRepository struct {
StarredAt *Timestamp `json:"starred_at,omitempty"`
Repository *Repository `json:"repo,omitempty"`
}
StarredRepository is returned by ListStarred.
func (s *StarredRepository) GetRepository() *Repository
GetRepository returns the Repository field.
func (s *StarredRepository) GetStarredAt() Timestamp
GetStarredAt returns the StarredAt field if it's non-nil, zero value otherwise.
type StatusEvent struct {
SHA *string `json:"sha,omitempty"`
// State is the new state. Possible values are: "pending", "success", "failure", "error".
State *string `json:"state,omitempty"`
Description *string `json:"description,omitempty"`
TargetURL *string `json:"target_url,omitempty"`
Branches []*Branch `json:"branches,omitempty"`
// The following fields are only populated by Webhook events.
ID *int64 `json:"id,omitempty"`
Name *string `json:"name,omitempty"`
Context *string `json:"context,omitempty"`
Commit *RepositoryCommit `json:"commit,omitempty"`
CreatedAt *Timestamp `json:"created_at,omitempty"`
UpdatedAt *Timestamp `json:"updated_at,omitempty"`
Repo *Repository `json:"repository,omitempty"`
Sender *User `json:"sender,omitempty"`
Installation *Installation `json:"installation,omitempty"`
}
StatusEvent is triggered when the status of a Git commit changes. The Webhook event name is "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/#statusevent
func (s *StatusEvent) GetCommit() *RepositoryCommit
GetCommit returns the Commit field.
func (s *StatusEvent) GetContext() string
GetContext returns the Context field if it's non-nil, zero value otherwise.
func (s *StatusEvent) GetCreatedAt() Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (s *StatusEvent) GetDescription() string
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (s *StatusEvent) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (s *StatusEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (s *StatusEvent) GetName() string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (s *StatusEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (s *StatusEvent) GetSHA() string
GetSHA returns the SHA field if it's non-nil, zero value otherwise.
func (s *StatusEvent) GetSender() *User
GetSender returns the Sender field.
func (s *StatusEvent) GetState() string
GetState returns the State field if it's non-nil, zero value otherwise.
func (s *StatusEvent) GetTargetURL() string
GetTargetURL returns the TargetURL field if it's non-nil, zero value otherwise.
func (s *StatusEvent) GetUpdatedAt() Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
type Subscription struct {
Subscribed *bool `json:"subscribed,omitempty"`
Ignored *bool `json:"ignored,omitempty"`
Reason *string `json:"reason,omitempty"`
CreatedAt *Timestamp `json:"created_at,omitempty"`
URL *string `json:"url,omitempty"`
// only populated for repository subscriptions
RepositoryURL *string `json:"repository_url,omitempty"`
// only populated for thread subscriptions
ThreadURL *string `json:"thread_url,omitempty"`
}
Subscription identifies a repository or thread subscription.
func (s *Subscription) GetCreatedAt() Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (s *Subscription) GetIgnored() bool
GetIgnored returns the Ignored field if it's non-nil, zero value otherwise.
func (s *Subscription) GetReason() string
GetReason returns the Reason field if it's non-nil, zero value otherwise.
func (s *Subscription) GetRepositoryURL() string
GetRepositoryURL returns the RepositoryURL field if it's non-nil, zero value otherwise.
func (s *Subscription) GetSubscribed() bool
GetSubscribed returns the Subscribed field if it's non-nil, zero value otherwise.
func (s *Subscription) GetThreadURL() string
GetThreadURL returns the ThreadURL field if it's non-nil, zero value otherwise.
func (s *Subscription) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
type Tag struct {
Tag *string `json:"tag,omitempty"`
SHA *string `json:"sha,omitempty"`
URL *string `json:"url,omitempty"`
Message *string `json:"message,omitempty"`
Tagger *CommitAuthor `json:"tagger,omitempty"`
Object *GitObject `json:"object,omitempty"`
Verification *SignatureVerification `json:"verification,omitempty"`
NodeID *string `json:"node_id,omitempty"`
}
Tag represents a tag object.
func (t *Tag) GetMessage() string
GetMessage returns the Message field if it's non-nil, zero value otherwise.
func (t *Tag) GetNodeID() string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (t *Tag) GetObject() *GitObject
GetObject returns the Object field.
func (t *Tag) GetSHA() string
GetSHA returns the SHA field if it's non-nil, zero value otherwise.
func (t *Tag) GetTag() string
GetTag returns the Tag field if it's non-nil, zero value otherwise.
func (t *Tag) GetTagger() *CommitAuthor
GetTagger returns the Tagger field.
func (t *Tag) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (t *Tag) GetVerification() *SignatureVerification
GetVerification returns the Verification field.
type Team struct {
ID *int64 `json:"id,omitempty"`
Name *string `json:"name,omitempty"`
Description *string `json:"description,omitempty"`
URL *string `json:"url,omitempty"`
Slug *string `json:"slug,omitempty"`
// Permission specifies the default permission for repositories owned by the team.
Permission *string `json:"permission,omitempty"`
// Privacy identifies the level of privacy this team should have.
// Possible values are:
// secret - only visible to organization owners and members of this team
// closed - visible to all members of this organization
// Default is "secret".
Privacy *string `json:"privacy,omitempty"`
MembersCount *int `json:"members_count,omitempty"`
ReposCount *int `json:"repos_count,omitempty"`
Organization *Organization `json:"organization,omitempty"`
MembersURL *string `json:"members_url,omitempty"`
RepositoriesURL *string `json:"repositories_url,omitempty"`
Parent *Team `json:"parent,omitempty"`
// LDAPDN is only available in GitHub Enterprise and when the team
// membership is synchronized with LDAP.
LDAPDN *string `json:"ldap_dn,omitempty"`
}
Team represents a team within a GitHub organization. Teams are used to manage access to an organization's repositories.
func (t *Team) GetDescription() string
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (t *Team) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (t *Team) GetLDAPDN() string
GetLDAPDN returns the LDAPDN field if it's non-nil, zero value otherwise.
func (t *Team) GetMembersCount() int
GetMembersCount returns the MembersCount field if it's non-nil, zero value otherwise.
func (t *Team) GetMembersURL() string
GetMembersURL returns the MembersURL field if it's non-nil, zero value otherwise.
func (t *Team) GetName() string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (t *Team) GetOrganization() *Organization
GetOrganization returns the Organization field.
func (t *Team) GetParent() *Team
GetParent returns the Parent field.
func (t *Team) GetPermission() string
GetPermission returns the Permission field if it's non-nil, zero value otherwise.
func (t *Team) GetPrivacy() string
GetPrivacy returns the Privacy field if it's non-nil, zero value otherwise.
func (t *Team) GetReposCount() int
GetReposCount returns the ReposCount field if it's non-nil, zero value otherwise.
func (t *Team) GetRepositoriesURL() string
GetRepositoriesURL returns the RepositoriesURL field if it's non-nil, zero value otherwise.
func (t *Team) GetSlug() string
GetSlug returns the Slug field if it's non-nil, zero value otherwise.
func (t *Team) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (t Team) String() string
type TeamAddEvent struct {
Team *Team `json:"team,omitempty"`
Repo *Repository `json:"repository,omitempty"`
// The following fields are only populated by Webhook events.
Org *Organization `json:"organization,omitempty"`
Sender *User `json:"sender,omitempty"`
Installation *Installation `json:"installation,omitempty"`
}
TeamAddEvent is triggered when a repository is added to a team. The Webhook event name is "team_add".
Events of this type are not visible in timelines. These events are only used to trigger hooks.
GitHub API docs: https://developer.github.com/v3/activity/events/types/#teamaddevent
func (t *TeamAddEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (t *TeamAddEvent) GetOrg() *Organization
GetOrg returns the Org field.
func (t *TeamAddEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (t *TeamAddEvent) GetSender() *User
GetSender returns the Sender field.
func (t *TeamAddEvent) GetTeam() *Team
GetTeam returns the Team field.
type TeamAddTeamMembershipOptions struct {
// Role specifies the role the user should have in the team. Possible
// values are:
// member - a normal member of the team
// maintainer - a team maintainer. Able to add/remove other team
// members, promote other team members to team
// maintainer, and edit the team’s name and description
//
// Default value is "member".
Role string `json:"role,omitempty"`
}
TeamAddTeamMembershipOptions specifies the optional parameters to the TeamsService.AddTeamMembership method.
type TeamAddTeamRepoOptions struct {
// Permission specifies the permission to grant the team on this repository.
// Possible values are:
// pull - team members can pull, but not push to or administer this repository
// push - team members can pull and push, but not administer this repository
// admin - team members can pull, push and administer this repository
//
// If not specified, the team's permission attribute will be used.
Permission string `json:"permission,omitempty"`
}
TeamAddTeamRepoOptions specifies the optional parameters to the TeamsService.AddTeamRepo method.
type TeamChange struct {
Description *struct {
From *string `json:"from,omitempty"`
} `json:"description,omitempty"`
Name *struct {
From *string `json:"from,omitempty"`
} `json:"name,omitempty"`
Privacy *struct {
From *string `json:"from,omitempty"`
} `json:"privacy,omitempty"`
Repository *struct {
Permissions *struct {
From *struct {
Admin *bool `json:"admin,omitempty"`
Pull *bool `json:"pull,omitempty"`
Push *bool `json:"push,omitempty"`
} `json:"from,omitempty"`
} `json:"permissions,omitempty"`
} `json:"repository,omitempty"`
}
TeamChange represents the changes when a team has been edited.
type TeamDiscussion struct {
Author *User `json:"author,omitempty"`
Body *string `json:"body,omitempty"`
BodyHTML *string `json:"body_html,omitempty"`
BodyVersion *string `json:"body_version,omitempty"`
CommentsCount *int `json:"comments_count,omitempty"`
CommentsURL *string `json:"comments_url,omitempty"`
CreatedAt *Timestamp `json:"created_at,omitempty"`
LastEditedAt *Timestamp `json:"last_edited_at,omitempty"`
HTMLURL *string `json:"html_url,omitempty"`
NodeID *string `json:"node_id,omitempty"`
Number *int `json:"number,omitempty"`
Pinned *bool `json:"pinned,omitempty"`
Private *bool `json:"private,omitempty"`
TeamURL *string `json:"team_url,omitempty"`
Title *string `json:"title,omitempty"`
UpdatedAt *Timestamp `json:"updated_at,omitempty"`
URL *string `json:"url,omitempty"`
}
TeamDiscussion represents a GitHub dicussion in a team.
func (t *TeamDiscussion) GetAuthor() *User
GetAuthor returns the Author field.
func (t *TeamDiscussion) GetBody() string
GetBody returns the Body field if it's non-nil, zero value otherwise.
func (t *TeamDiscussion) GetBodyHTML() string
GetBodyHTML returns the BodyHTML field if it's non-nil, zero value otherwise.
func (t *TeamDiscussion) GetBodyVersion() string
GetBodyVersion returns the BodyVersion field if it's non-nil, zero value otherwise.
func (t *TeamDiscussion) GetCommentsCount() int
GetCommentsCount returns the CommentsCount field if it's non-nil, zero value otherwise.
func (t *TeamDiscussion) GetCommentsURL() string
GetCommentsURL returns the CommentsURL field if it's non-nil, zero value otherwise.
func (t *TeamDiscussion) GetCreatedAt() Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (t *TeamDiscussion) GetHTMLURL() string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (t *TeamDiscussion) GetLastEditedAt() Timestamp
GetLastEditedAt returns the LastEditedAt field if it's non-nil, zero value otherwise.
func (t *TeamDiscussion) GetNodeID() string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (t *TeamDiscussion) GetNumber() int
GetNumber returns the Number field if it's non-nil, zero value otherwise.
func (t *TeamDiscussion) GetPinned() bool
GetPinned returns the Pinned field if it's non-nil, zero value otherwise.
func (t *TeamDiscussion) GetPrivate() bool
GetPrivate returns the Private field if it's non-nil, zero value otherwise.
func (t *TeamDiscussion) GetTeamURL() string
GetTeamURL returns the TeamURL field if it's non-nil, zero value otherwise.
func (t *TeamDiscussion) GetTitle() string
GetTitle returns the Title field if it's non-nil, zero value otherwise.
func (t *TeamDiscussion) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (t *TeamDiscussion) GetUpdatedAt() Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (d TeamDiscussion) String() string
type TeamEvent struct {
Action *string `json:"action,omitempty"`
Team *Team `json:"team,omitempty"`
Changes *TeamChange `json:"changes,omitempty"`
Repo *Repository `json:"repository,omitempty"`
// The following fields are only populated by Webhook events.
Org *Organization `json:"organization,omitempty"`
Sender *User `json:"sender,omitempty"`
Installation *Installation `json:"installation,omitempty"`
}
TeamEvent is triggered when an organization's team is created, modified or deleted. The Webhook event name is "team".
Events of this type are not visible in timelines. These events are only used to trigger hooks.
GitHub API docs: https://developer.github.com/v3/activity/events/types/#teamevent
func (t *TeamEvent) GetAction() string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (t *TeamEvent) GetChanges() *TeamChange
GetChanges returns the Changes field.
func (t *TeamEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (t *TeamEvent) GetOrg() *Organization
GetOrg returns the Org field.
func (t *TeamEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (t *TeamEvent) GetSender() *User
GetSender returns the Sender field.
func (t *TeamEvent) GetTeam() *Team
GetTeam returns the Team field.
type TeamLDAPMapping struct {
ID *int64 `json:"id,omitempty"`
LDAPDN *string `json:"ldap_dn,omitempty"`
URL *string `json:"url,omitempty"`
Name *string `json:"name,omitempty"`
Slug *string `json:"slug,omitempty"`
Description *string `json:"description,omitempty"`
Privacy *string `json:"privacy,omitempty"`
Permission *string `json:"permission,omitempty"`
MembersURL *string `json:"members_url,omitempty"`
RepositoriesURL *string `json:"repositories_url,omitempty"`
}
TeamLDAPMapping represents the mapping between a GitHub team and an LDAP group.
func (t *TeamLDAPMapping) GetDescription() string
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (t *TeamLDAPMapping) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (t *TeamLDAPMapping) GetLDAPDN() string
GetLDAPDN returns the LDAPDN field if it's non-nil, zero value otherwise.
func (t *TeamLDAPMapping) GetMembersURL() string
GetMembersURL returns the MembersURL field if it's non-nil, zero value otherwise.
func (t *TeamLDAPMapping) GetName() string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (t *TeamLDAPMapping) GetPermission() string
GetPermission returns the Permission field if it's non-nil, zero value otherwise.
func (t *TeamLDAPMapping) GetPrivacy() string
GetPrivacy returns the Privacy field if it's non-nil, zero value otherwise.
func (t *TeamLDAPMapping) GetRepositoriesURL() string
GetRepositoriesURL returns the RepositoriesURL field if it's non-nil, zero value otherwise.
func (t *TeamLDAPMapping) GetSlug() string
GetSlug returns the Slug field if it's non-nil, zero value otherwise.
func (t *TeamLDAPMapping) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (m TeamLDAPMapping) String() string
type TeamListTeamMembersOptions struct {
// Role filters members returned by their role in the team. Possible
// values are "all", "member", "maintainer". Default is "all".
Role string `url:"role,omitempty"`
ListOptions
}
TeamListTeamMembersOptions specifies the optional parameters to the TeamsService.ListTeamMembers method.
type TeamsService service
TeamsService provides access to the team-related functions in the GitHub API.
GitHub API docs: https://developer.github.com/v3/teams/
func (s *TeamsService) AddTeamMembership(ctx context.Context, team int64, user string, opt *TeamAddTeamMembershipOptions) (*Membership, *Response, error)
AddTeamMembership adds or invites a user to a team.
In order to add a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with.
If the user is already a part of the team's organization (meaning they're on at least one other team in the organization), this endpoint will add the user to the team.
If the user is completely unaffiliated with the team's organization (meaning they're on none of the organization's teams), this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team.
GitHub API docs: https://developer.github.com/v3/teams/members/#add-or-update-team-membership
func (s *TeamsService) AddTeamRepo(ctx context.Context, team int64, owner string, repo string, opt *TeamAddTeamRepoOptions) (*Response, error)
AddTeamRepo adds a repository to be managed by the specified team. The specified repository must be owned by the organization to which the team belongs, or a direct fork of a repository owned by the organization.
GitHub API docs: https://developer.github.com/v3/teams/#add-team-repo
func (s *TeamsService) CreateComment(ctx context.Context, teamID int64, discsusionNumber int, comment DiscussionComment) (*DiscussionComment, *Response, error)
CreateComment creates a new discussion post on a team discussion. Authenticated user must grant write:discussion scope.
GitHub API docs: https://developer.github.com/v3/teams/discussion_comments/#create-a-comment
func (s *TeamsService) CreateDiscussion(ctx context.Context, teamID int64, discussion TeamDiscussion) (*TeamDiscussion, *Response, error)
CreateDiscussion creates a new discussion post on a team's page. Authenticated user must grant write:discussion scope.
GitHub API docs: https://developer.github.com/v3/teams/discussions/#create-a-discussion
func (s *TeamsService) CreateTeam(ctx context.Context, org string, team NewTeam) (*Team, *Response, error)
CreateTeam creates a new team within an organization.
GitHub API docs: https://developer.github.com/v3/teams/#create-team
func (s *TeamsService) DeleteComment(ctx context.Context, teamID int64, discussionNumber, commentNumber int) (*Response, error)
DeleteComment deletes a comment on a team discussion. Authenticated user must grant write:discussion scope.
GitHub API docs: https://developer.github.com/v3/teams/discussion_comments/#delete-a-comment
func (s *TeamsService) DeleteDiscussion(ctx context.Context, teamID int64, discussionNumber int) (*Response, error)
DeleteDiscussion deletes a discussion from team's page. Authenticated user must grant write:discussion scope.
GitHub API docs: https://developer.github.com/v3/teams/discussions/#delete-a-discussion
func (s *TeamsService) DeleteTeam(ctx context.Context, team int64) (*Response, error)
DeleteTeam deletes a team.
GitHub API docs: https://developer.github.com/v3/teams/#delete-team
func (s *TeamsService) EditComment(ctx context.Context, teamID int64, discussionNumber, commentNumber int, comment DiscussionComment) (*DiscussionComment, *Response, error)
EditComment edits the body text of a discussion comment. Authenticated user must grant write:discussion scope. User is allowed to edit body of a comment only.
GitHub API docs: https://developer.github.com/v3/teams/discussion_comments/#edit-a-comment
func (s *TeamsService) EditDiscussion(ctx context.Context, teamID int64, discussionNumber int, discussion TeamDiscussion) (*TeamDiscussion, *Response, error)
EditDiscussion edits the title and body text of a discussion post. Authenticated user must grant write:discussion scope. User is allowed to change Title and Body of a discussion only.
GitHub API docs: https://developer.github.com/v3/teams/discussions/#edit-a-discussion
func (s *TeamsService) EditTeam(ctx context.Context, id int64, team NewTeam) (*Team, *Response, error)
EditTeam edits a team.
GitHub API docs: https://developer.github.com/v3/teams/#edit-team
func (s *TeamsService) GetComment(ctx context.Context, teamID int64, discussionNumber, commentNumber int) (*DiscussionComment, *Response, error)
GetComment gets a specific comment on a team discussion. Authenticated user must grant read:discussion scope.
GitHub API docs: https://developer.github.com/v3/teams/discussion_comments/#get-a-single-comment
func (s *TeamsService) GetDiscussion(ctx context.Context, teamID int64, discussionNumber int) (*TeamDiscussion, *Response, error)
GetDiscussion gets a specific discussion on a team's page. Authenticated user must grant read:discussion scope.
GitHub API docs: https://developer.github.com/v3/teams/discussions/#get-a-single-discussion
func (s *TeamsService) GetTeam(ctx context.Context, team int64) (*Team, *Response, error)
GetTeam fetches a team by ID.
GitHub API docs: https://developer.github.com/v3/teams/#get-team
func (s *TeamsService) GetTeamMembership(ctx context.Context, team int64, user string) (*Membership, *Response, error)
GetTeamMembership returns the membership status for a user in a team.
GitHub API docs: https://developer.github.com/v3/teams/members/#get-team-membership
func (s *TeamsService) IsTeamMember(ctx context.Context, team int64, user string) (bool, *Response, error)
IsTeamMember checks if a user is a member of the specified team.
GitHub API docs: https://developer.github.com/v3/teams/members/#get-team-member
Deprecated: This API has been marked as deprecated in the Github API docs, TeamsService.GetTeamMembership method should be used instead.
func (s *TeamsService) IsTeamRepo(ctx context.Context, team int64, owner string, repo string) (*Repository, *Response, error)
IsTeamRepo checks if a team manages the specified repository. If the repository is managed by team, a Repository is returned which includes the permissions team has for that repo.
GitHub API docs: https://developer.github.com/v3/teams/#check-if-a-team-manages-a-repository
func (s *TeamsService) ListChildTeams(ctx context.Context, teamID int64, opt *ListOptions) ([]*Team, *Response, error)
ListChildTeams lists child teams for a team.
GitHub API docs: https://developer.github.com/v3/teams/#list-child-teams
func (s *TeamsService) ListComments(ctx context.Context, teamID int64, discussionNumber int, options *DiscussionCommentListOptions) ([]*DiscussionComment, *Response, error)
ListComments lists all comments on a team discussion. Authenticated user must grant read:discussion scope.
GitHub API docs: https://developer.github.com/v3/teams/discussion_comments/#list-comments
func (s *TeamsService) ListDiscussions(ctx context.Context, teamID int64, options *DiscussionListOptions) ([]*TeamDiscussion, *Response, error)
ListDiscussions lists all discussions on team's page. Authenticated user must grant read:discussion scope.
GitHub API docs: https://developer.github.com/v3/teams/discussions/#list-discussions
func (s *TeamsService) ListPendingTeamInvitations(ctx context.Context, team int64, opt *ListOptions) ([]*Invitation, *Response, error)
ListPendingTeamInvitations get pending invitaion list in team. Warning: The API may change without advance notice during the preview period. Preview features are not supported for production use.
GitHub API docs: https://developer.github.com/v3/teams/members/#list-pending-team-invitations
func (s *TeamsService) ListTeamMembers(ctx context.Context, team int64, opt *TeamListTeamMembersOptions) ([]*User, *Response, error)
ListTeamMembers lists all of the users who are members of the specified team.
GitHub API docs: https://developer.github.com/v3/teams/members/#list-team-members
func (s *TeamsService) ListTeamRepos(ctx context.Context, team int64, opt *ListOptions) ([]*Repository, *Response, error)
ListTeamRepos lists the repositories that the specified team has access to.
GitHub API docs: https://developer.github.com/v3/teams/#list-team-repos
func (s *TeamsService) ListTeams(ctx context.Context, org string, opt *ListOptions) ([]*Team, *Response, error)
ListTeams lists all of the teams for an organization.
GitHub API docs: https://developer.github.com/v3/teams/#list-teams
Code:
package main
import (
"context"
"fmt"
"github.com/google/go-github/github"
)
func main() {
// This example shows how to get a team ID corresponding to a given team name.
// Note that authentication is needed here as you are performing a lookup on
// an organization's administrative configuration, so you will need to modify
// the example to provide an oauth client to github.NewClient() instead of nil.
// See the following documentation for more information on how to authenticate
// with the client:
// https://godoc.org/github.com/google/go-github/github#hdr-Authentication
client := github.NewClient(nil)
teamName := "Developers team"
ctx := context.Background()
opts := &github.ListOptions{}
for {
teams, resp, err := client.Teams.ListTeams(ctx, "myOrganization", opts)
if err != nil {
fmt.Println(err)
return
}
for _, t := range teams {
if t.GetName() == teamName {
fmt.Printf("Team %q has ID %d\n", teamName, t.GetID())
return
}
}
if resp.NextPage == 0 {
break
}
opts.Page = resp.NextPage
}
fmt.Printf("Team %q was not found\n", teamName)
}
func (s *TeamsService) ListUserTeams(ctx context.Context, opt *ListOptions) ([]*Team, *Response, error)
ListUserTeams lists a user's teams GitHub API docs: https://developer.github.com/v3/teams/#list-user-teams
func (s *TeamsService) RemoveTeamMembership(ctx context.Context, team int64, user string) (*Response, error)
RemoveTeamMembership removes a user from a team.
GitHub API docs: https://developer.github.com/v3/teams/members/#remove-team-membership
func (s *TeamsService) RemoveTeamRepo(ctx context.Context, team int64, owner string, repo string) (*Response, error)
RemoveTeamRepo removes a repository from being managed by the specified team. Note that this does not delete the repository, it just removes it from the team.
GitHub API docs: https://developer.github.com/v3/teams/#remove-team-repo
type TextMatch struct {
ObjectURL *string `json:"object_url,omitempty"`
ObjectType *string `json:"object_type,omitempty"`
Property *string `json:"property,omitempty"`
Fragment *string `json:"fragment,omitempty"`
Matches []Match `json:"matches,omitempty"`
}
TextMatch represents a text match for a SearchResult
func (t *TextMatch) GetFragment() string
GetFragment returns the Fragment field if it's non-nil, zero value otherwise.
func (t *TextMatch) GetObjectType() string
GetObjectType returns the ObjectType field if it's non-nil, zero value otherwise.
func (t *TextMatch) GetObjectURL() string
GetObjectURL returns the ObjectURL field if it's non-nil, zero value otherwise.
func (t *TextMatch) GetProperty() string
GetProperty returns the Property field if it's non-nil, zero value otherwise.
func (tm TextMatch) String() string
type Timeline struct {
ID *int64 `json:"id,omitempty"`
URL *string `json:"url,omitempty"`
CommitURL *string `json:"commit_url,omitempty"`
// The User object that generated the event.
Actor *User `json:"actor,omitempty"`
// Event identifies the actual type of Event that occurred. Possible values
// are:
//
// assigned
// The issue was assigned to the assignee.
//
// closed
// The issue was closed by the actor. When the commit_id is present, it
// identifies the commit that closed the issue using "closes / fixes #NN"
// syntax.
//
// commented
// A comment was added to the issue.
//
// committed
// A commit was added to the pull request's 'HEAD' branch. Only provided
// for pull requests.
//
// cross-referenced
// The issue was referenced from another issue. The 'source' attribute
// contains the 'id', 'actor', and 'url' of the reference's source.
//
// demilestoned
// The issue was removed from a milestone.
//
// head_ref_deleted
// The pull request's branch was deleted.
//
// head_ref_restored
// The pull request's branch was restored.
//
// labeled
// A label was added to the issue.
//
// locked
// The issue was locked by the actor.
//
// mentioned
// The actor was @mentioned in an issue body.
//
// merged
// The issue was merged by the actor. The 'commit_id' attribute is the
// SHA1 of the HEAD commit that was merged.
//
// milestoned
// The issue was added to a milestone.
//
// referenced
// The issue was referenced from a commit message. The 'commit_id'
// attribute is the commit SHA1 of where that happened.
//
// renamed
// The issue title was changed.
//
// reopened
// The issue was reopened by the actor.
//
// subscribed
// The actor subscribed to receive notifications for an issue.
//
// unassigned
// The assignee was unassigned from the issue.
//
// unlabeled
// A label was removed from the issue.
//
// unlocked
// The issue was unlocked by the actor.
//
// unsubscribed
// The actor unsubscribed to stop receiving notifications for an issue.
//
Event *string `json:"event,omitempty"`
// The string SHA of a commit that referenced this Issue or Pull Request.
CommitID *string `json:"commit_id,omitempty"`
// The timestamp indicating when the event occurred.
CreatedAt *time.Time `json:"created_at,omitempty"`
// The Label object including `name` and `color` attributes. Only provided for
// 'labeled' and 'unlabeled' events.
Label *Label `json:"label,omitempty"`
// The User object which was assigned to (or unassigned from) this Issue or
// Pull Request. Only provided for 'assigned' and 'unassigned' events.
Assignee *User `json:"assignee,omitempty"`
// The Milestone object including a 'title' attribute.
// Only provided for 'milestoned' and 'demilestoned' events.
Milestone *Milestone `json:"milestone,omitempty"`
// The 'id', 'actor', and 'url' for the source of a reference from another issue.
// Only provided for 'cross-referenced' events.
Source *Source `json:"source,omitempty"`
// An object containing rename details including 'from' and 'to' attributes.
// Only provided for 'renamed' events.
Rename *Rename `json:"rename,omitempty"`
}
Timeline represents an event that occurred around an Issue or Pull Request.
It is similar to an IssueEvent but may contain more information. GitHub API docs: https://developer.github.com/v3/issues/timeline/
func (t *Timeline) GetActor() *User
GetActor returns the Actor field.
func (t *Timeline) GetAssignee() *User
GetAssignee returns the Assignee field.
func (t *Timeline) GetCommitID() string
GetCommitID returns the CommitID field if it's non-nil, zero value otherwise.
func (t *Timeline) GetCommitURL() string
GetCommitURL returns the CommitURL field if it's non-nil, zero value otherwise.
func (t *Timeline) GetCreatedAt() time.Time
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (t *Timeline) GetEvent() string
GetEvent returns the Event field if it's non-nil, zero value otherwise.
func (t *Timeline) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (t *Timeline) GetLabel() *Label
GetLabel returns the Label field.
func (t *Timeline) GetMilestone() *Milestone
GetMilestone returns the Milestone field.
func (t *Timeline) GetRename() *Rename
GetRename returns the Rename field.
func (t *Timeline) GetSource() *Source
GetSource returns the Source field.
func (t *Timeline) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
type Timestamp struct {
time.Time
}
Timestamp represents a time that can be unmarshalled from a JSON string formatted as either an RFC3339 or Unix timestamp. This is necessary for some fields since the GitHub API is inconsistent in how it represents times. All exported methods of time.Time can be called on Timestamp.
func (t Timestamp) Equal(u Timestamp) bool
Equal reports whether t and u are equal based on time.Equal
func (t Timestamp) String() string
func (t *Timestamp) UnmarshalJSON(data []byte) (err error)
UnmarshalJSON implements the json.Unmarshaler interface. Time is expected in RFC3339 or Unix format.
type TrafficBreakdownOptions struct {
Per string `url:"per,omitempty"`
}
TrafficBreakdownOptions specifies the parameters to methods that support breakdown per day or week. Can be one of: day, week. Default: day.
type TrafficClones struct {
Clones []*TrafficData `json:"clones,omitempty"`
Count *int `json:"count,omitempty"`
Uniques *int `json:"uniques,omitempty"`
}
TrafficClones represent information about the number of clones in the last 14 days.
func (t *TrafficClones) GetCount() int
GetCount returns the Count field if it's non-nil, zero value otherwise.
func (t *TrafficClones) GetUniques() int
GetUniques returns the Uniques field if it's non-nil, zero value otherwise.
type TrafficData struct {
Timestamp *Timestamp `json:"timestamp,omitempty"`
Count *int `json:"count,omitempty"`
Uniques *int `json:"uniques,omitempty"`
}
TrafficData represent information about a specific timestamp in views or clones list.
func (t *TrafficData) GetCount() int
GetCount returns the Count field if it's non-nil, zero value otherwise.
func (t *TrafficData) GetTimestamp() Timestamp
GetTimestamp returns the Timestamp field if it's non-nil, zero value otherwise.
func (t *TrafficData) GetUniques() int
GetUniques returns the Uniques field if it's non-nil, zero value otherwise.
type TrafficPath struct {
Path *string `json:"path,omitempty"`
Title *string `json:"title,omitempty"`
Count *int `json:"count,omitempty"`
Uniques *int `json:"uniques,omitempty"`
}
TrafficPath represent information about the traffic on a path of the repo.
func (t *TrafficPath) GetCount() int
GetCount returns the Count field if it's non-nil, zero value otherwise.
func (t *TrafficPath) GetPath() string
GetPath returns the Path field if it's non-nil, zero value otherwise.
func (t *TrafficPath) GetTitle() string
GetTitle returns the Title field if it's non-nil, zero value otherwise.
func (t *TrafficPath) GetUniques() int
GetUniques returns the Uniques field if it's non-nil, zero value otherwise.
type TrafficReferrer struct {
Referrer *string `json:"referrer,omitempty"`
Count *int `json:"count,omitempty"`
Uniques *int `json:"uniques,omitempty"`
}
TrafficReferrer represent information about traffic from a referrer .
func (t *TrafficReferrer) GetCount() int
GetCount returns the Count field if it's non-nil, zero value otherwise.
func (t *TrafficReferrer) GetReferrer() string
GetReferrer returns the Referrer field if it's non-nil, zero value otherwise.
func (t *TrafficReferrer) GetUniques() int
GetUniques returns the Uniques field if it's non-nil, zero value otherwise.
type TrafficViews struct {
Views []*TrafficData `json:"views,omitempty"`
Count *int `json:"count,omitempty"`
Uniques *int `json:"uniques,omitempty"`
}
TrafficViews represent information about the number of views in the last 14 days.
func (t *TrafficViews) GetCount() int
GetCount returns the Count field if it's non-nil, zero value otherwise.
func (t *TrafficViews) GetUniques() int
GetUniques returns the Uniques field if it's non-nil, zero value otherwise.
type TransferRequest struct {
NewOwner string `json:"new_owner"`
TeamID []int64 `json:"team_ids,omitempty"`
}
TransferRequest represents a request to transfer a repository.
type Tree struct {
SHA *string `json:"sha,omitempty"`
Entries []TreeEntry `json:"tree,omitempty"`
// Truncated is true if the number of items in the tree
// exceeded GitHub's maximum limit and the Entries were truncated
// in the response. Only populated for requests that fetch
// trees like Git.GetTree.
Truncated *bool `json:"truncated,omitempty"`
}
Tree represents a GitHub tree.
func (t *Tree) GetSHA() string
GetSHA returns the SHA field if it's non-nil, zero value otherwise.
func (t *Tree) GetTruncated() bool
GetTruncated returns the Truncated field if it's non-nil, zero value otherwise.
func (t Tree) String() string
type TreeEntry struct {
SHA *string `json:"sha,omitempty"`
Path *string `json:"path,omitempty"`
Mode *string `json:"mode,omitempty"`
Type *string `json:"type,omitempty"`
Size *int `json:"size,omitempty"`
Content *string `json:"content,omitempty"`
URL *string `json:"url,omitempty"`
}
TreeEntry represents the contents of a tree structure. TreeEntry can represent either a blob, a commit (in the case of a submodule), or another tree.
func (t *TreeEntry) GetContent() string
GetContent returns the Content field if it's non-nil, zero value otherwise.
func (t *TreeEntry) GetMode() string
GetMode returns the Mode field if it's non-nil, zero value otherwise.
func (t *TreeEntry) GetPath() string
GetPath returns the Path field if it's non-nil, zero value otherwise.
func (t *TreeEntry) GetSHA() string
GetSHA returns the SHA field if it's non-nil, zero value otherwise.
func (t *TreeEntry) GetSize() int
GetSize returns the Size field if it's non-nil, zero value otherwise.
func (t *TreeEntry) GetType() string
GetType returns the Type field if it's non-nil, zero value otherwise.
func (t *TreeEntry) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (t TreeEntry) String() string
type TwoFactorAuthError ErrorResponse
TwoFactorAuthError occurs when using HTTP Basic Authentication for a user that has two-factor authentication enabled. The request can be reattempted by providing a one-time password in the request.
func (r *TwoFactorAuthError) Error() string
type UnauthenticatedRateLimitedTransport struct {
// ClientID is the GitHub OAuth client ID of the current application, which
// can be found by selecting its entry in the list at
// https://github.com/settings/applications.
ClientID string
// ClientSecret is the GitHub OAuth client secret of the current
// application.
ClientSecret string
// Transport is the underlying HTTP transport to use when making requests.
// It will default to http.DefaultTransport if nil.
Transport http.RoundTripper
}
UnauthenticatedRateLimitedTransport allows you to make unauthenticated calls that need to use a higher rate limit associated with your OAuth application.
t := &github.UnauthenticatedRateLimitedTransport{
ClientID: "your app's client ID",
ClientSecret: "your app's client secret",
}
client := github.NewClient(t.Client())
This will append the querystring params client_id=xxx&client_secret=yyy to all requests.
See https://developer.github.com/v3/#unauthenticated-rate-limited-requests for more information.
func (t *UnauthenticatedRateLimitedTransport) Client() *http.Client
Client returns an *http.Client that makes requests which are subject to the rate limit of your OAuth application.
func (t *UnauthenticatedRateLimitedTransport) RoundTrip(req *http.Request) (*http.Response, error)
RoundTrip implements the RoundTripper interface.
type UpdateCheckRunOptions struct {
Name string `json:"name"` // The name of the check (e.g., "code-coverage"). (Required.)
HeadBranch *string `json:"head_branch,omitempty"` // The name of the branch to perform a check against. (Optional.)
HeadSHA *string `json:"head_sha,omitempty"` // The SHA of the commit. (Optional.)
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".)
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)
}
UpdateCheckRunOptions sets up parameters needed to update a CheckRun.
func (u *UpdateCheckRunOptions) GetCompletedAt() Timestamp
GetCompletedAt returns the CompletedAt field if it's non-nil, zero value otherwise.
func (u *UpdateCheckRunOptions) GetConclusion() string
GetConclusion returns the Conclusion field if it's non-nil, zero value otherwise.
func (u *UpdateCheckRunOptions) GetDetailsURL() string
GetDetailsURL returns the DetailsURL field if it's non-nil, zero value otherwise.
func (u *UpdateCheckRunOptions) GetExternalID() string
GetExternalID returns the ExternalID field if it's non-nil, zero value otherwise.
func (u *UpdateCheckRunOptions) GetHeadBranch() string
GetHeadBranch returns the HeadBranch field if it's non-nil, zero value otherwise.
func (u *UpdateCheckRunOptions) GetHeadSHA() string
GetHeadSHA returns the HeadSHA field if it's non-nil, zero value otherwise.
func (u *UpdateCheckRunOptions) GetOutput() *CheckRunOutput
GetOutput returns the Output field.
func (u *UpdateCheckRunOptions) GetStatus() string
GetStatus returns the Status field if it's non-nil, zero value otherwise.
type UploadOptions struct {
Name string `url:"name,omitempty"`
}
UploadOptions specifies the parameters to methods that support uploads.
type User struct {
Login *string `json:"login,omitempty"`
ID *int64 `json:"id,omitempty"`
NodeID *string `json:"node_id,omitempty"`
AvatarURL *string `json:"avatar_url,omitempty"`
HTMLURL *string `json:"html_url,omitempty"`
GravatarID *string `json:"gravatar_id,omitempty"`
Name *string `json:"name,omitempty"`
Company *string `json:"company,omitempty"`
Blog *string `json:"blog,omitempty"`
Location *string `json:"location,omitempty"`
Email *string `json:"email,omitempty"`
Hireable *bool `json:"hireable,omitempty"`
Bio *string `json:"bio,omitempty"`
PublicRepos *int `json:"public_repos,omitempty"`
PublicGists *int `json:"public_gists,omitempty"`
Followers *int `json:"followers,omitempty"`
Following *int `json:"following,omitempty"`
CreatedAt *Timestamp `json:"created_at,omitempty"`
UpdatedAt *Timestamp `json:"updated_at,omitempty"`
SuspendedAt *Timestamp `json:"suspended_at,omitempty"`
Type *string `json:"type,omitempty"`
SiteAdmin *bool `json:"site_admin,omitempty"`
TotalPrivateRepos *int `json:"total_private_repos,omitempty"`
OwnedPrivateRepos *int `json:"owned_private_repos,omitempty"`
PrivateGists *int `json:"private_gists,omitempty"`
DiskUsage *int `json:"disk_usage,omitempty"`
Collaborators *int `json:"collaborators,omitempty"`
Plan *Plan `json:"plan,omitempty"`
// API URLs
URL *string `json:"url,omitempty"`
EventsURL *string `json:"events_url,omitempty"`
FollowingURL *string `json:"following_url,omitempty"`
FollowersURL *string `json:"followers_url,omitempty"`
GistsURL *string `json:"gists_url,omitempty"`
OrganizationsURL *string `json:"organizations_url,omitempty"`
ReceivedEventsURL *string `json:"received_events_url,omitempty"`
ReposURL *string `json:"repos_url,omitempty"`
StarredURL *string `json:"starred_url,omitempty"`
SubscriptionsURL *string `json:"subscriptions_url,omitempty"`
// TextMatches is only populated from search results that request text matches
// See: search.go and https://developer.github.com/v3/search/#text-match-metadata
TextMatches []TextMatch `json:"text_matches,omitempty"`
// Permissions identifies the permissions that a user has on a given
// repository. This is only populated when calling Repositories.ListCollaborators.
Permissions *map[string]bool `json:"permissions,omitempty"`
}
User represents a GitHub user.
func (u *User) GetAvatarURL() string
GetAvatarURL returns the AvatarURL field if it's non-nil, zero value otherwise.
func (u *User) GetBio() string
GetBio returns the Bio field if it's non-nil, zero value otherwise.
func (u *User) GetBlog() string
GetBlog returns the Blog field if it's non-nil, zero value otherwise.
func (u *User) GetCollaborators() int
GetCollaborators returns the Collaborators field if it's non-nil, zero value otherwise.
func (u *User) GetCompany() string
GetCompany returns the Company field if it's non-nil, zero value otherwise.
func (u *User) GetCreatedAt() Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (u *User) GetDiskUsage() int
GetDiskUsage returns the DiskUsage field if it's non-nil, zero value otherwise.
func (u *User) GetEmail() string
GetEmail returns the Email field if it's non-nil, zero value otherwise.
func (u *User) GetEventsURL() string
GetEventsURL returns the EventsURL field if it's non-nil, zero value otherwise.
func (u *User) GetFollowers() int
GetFollowers returns the Followers field if it's non-nil, zero value otherwise.
func (u *User) GetFollowersURL() string
GetFollowersURL returns the FollowersURL field if it's non-nil, zero value otherwise.
func (u *User) GetFollowing() int
GetFollowing returns the Following field if it's non-nil, zero value otherwise.
func (u *User) GetFollowingURL() string
GetFollowingURL returns the FollowingURL field if it's non-nil, zero value otherwise.
func (u *User) GetGistsURL() string
GetGistsURL returns the GistsURL field if it's non-nil, zero value otherwise.
func (u *User) GetGravatarID() string
GetGravatarID returns the GravatarID field if it's non-nil, zero value otherwise.
func (u *User) GetHTMLURL() string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (u *User) GetHireable() bool
GetHireable returns the Hireable field if it's non-nil, zero value otherwise.
func (u *User) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (u *User) GetLocation() string
GetLocation returns the Location field if it's non-nil, zero value otherwise.
func (u *User) GetLogin() string
GetLogin returns the Login field if it's non-nil, zero value otherwise.
func (u *User) GetName() string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (u *User) GetNodeID() string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (u *User) GetOrganizationsURL() string
GetOrganizationsURL returns the OrganizationsURL field if it's non-nil, zero value otherwise.
func (u *User) GetOwnedPrivateRepos() int
GetOwnedPrivateRepos returns the OwnedPrivateRepos field if it's non-nil, zero value otherwise.
func (u *User) GetPermissions() map[string]bool
GetPermissions returns the Permissions field if it's non-nil, zero value otherwise.
func (u *User) GetPlan() *Plan
GetPlan returns the Plan field.
func (u *User) GetPrivateGists() int
GetPrivateGists returns the PrivateGists field if it's non-nil, zero value otherwise.
func (u *User) GetPublicGists() int
GetPublicGists returns the PublicGists field if it's non-nil, zero value otherwise.
func (u *User) GetPublicRepos() int
GetPublicRepos returns the PublicRepos field if it's non-nil, zero value otherwise.
func (u *User) GetReceivedEventsURL() string
GetReceivedEventsURL returns the ReceivedEventsURL field if it's non-nil, zero value otherwise.
func (u *User) GetReposURL() string
GetReposURL returns the ReposURL field if it's non-nil, zero value otherwise.
func (u *User) GetSiteAdmin() bool
GetSiteAdmin returns the SiteAdmin field if it's non-nil, zero value otherwise.
func (u *User) GetStarredURL() string
GetStarredURL returns the StarredURL field if it's non-nil, zero value otherwise.
func (u *User) GetSubscriptionsURL() string
GetSubscriptionsURL returns the SubscriptionsURL field if it's non-nil, zero value otherwise.
func (u *User) GetSuspendedAt() Timestamp
GetSuspendedAt returns the SuspendedAt field if it's non-nil, zero value otherwise.
func (u *User) GetTotalPrivateRepos() int
GetTotalPrivateRepos returns the TotalPrivateRepos field if it's non-nil, zero value otherwise.
func (u *User) GetType() string
GetType returns the Type field if it's non-nil, zero value otherwise.
func (u *User) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (u *User) GetUpdatedAt() Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (u User) String() string
type UserContext struct {
Message *string `json:"message,omitempty"`
Octicon *string `json:"octicon,omitempty"`
}
UserContext represents the contextual information about user.
func (u *UserContext) GetMessage() string
GetMessage returns the Message field if it's non-nil, zero value otherwise.
func (u *UserContext) GetOcticon() string
GetOcticon returns the Octicon field if it's non-nil, zero value otherwise.
type UserEmail struct {
Email *string `json:"email,omitempty"`
Primary *bool `json:"primary,omitempty"`
Verified *bool `json:"verified,omitempty"`
}
UserEmail represents user's email address
func (u *UserEmail) GetEmail() string
GetEmail returns the Email field if it's non-nil, zero value otherwise.
func (u *UserEmail) GetPrimary() bool
GetPrimary returns the Primary field if it's non-nil, zero value otherwise.
func (u *UserEmail) GetVerified() bool
GetVerified returns the Verified field if it's non-nil, zero value otherwise.
type UserLDAPMapping struct {
ID *int64 `json:"id,omitempty"`
LDAPDN *string `json:"ldap_dn,omitempty"`
Login *string `json:"login,omitempty"`
AvatarURL *string `json:"avatar_url,omitempty"`
GravatarID *string `json:"gravatar_id,omitempty"`
Type *string `json:"type,omitempty"`
SiteAdmin *bool `json:"site_admin,omitempty"`
URL *string `json:"url,omitempty"`
EventsURL *string `json:"events_url,omitempty"`
FollowingURL *string `json:"following_url,omitempty"`
FollowersURL *string `json:"followers_url,omitempty"`
GistsURL *string `json:"gists_url,omitempty"`
OrganizationsURL *string `json:"organizations_url,omitempty"`
ReceivedEventsURL *string `json:"received_events_url,omitempty"`
ReposURL *string `json:"repos_url,omitempty"`
StarredURL *string `json:"starred_url,omitempty"`
SubscriptionsURL *string `json:"subscriptions_url,omitempty"`
}
UserLDAPMapping represents the mapping between a GitHub user and an LDAP user.
func (u *UserLDAPMapping) GetAvatarURL() string
GetAvatarURL returns the AvatarURL field if it's non-nil, zero value otherwise.
func (u *UserLDAPMapping) GetEventsURL() string
GetEventsURL returns the EventsURL field if it's non-nil, zero value otherwise.
func (u *UserLDAPMapping) GetFollowersURL() string
GetFollowersURL returns the FollowersURL field if it's non-nil, zero value otherwise.
func (u *UserLDAPMapping) GetFollowingURL() string
GetFollowingURL returns the FollowingURL field if it's non-nil, zero value otherwise.
func (u *UserLDAPMapping) GetGistsURL() string
GetGistsURL returns the GistsURL field if it's non-nil, zero value otherwise.
func (u *UserLDAPMapping) GetGravatarID() string
GetGravatarID returns the GravatarID field if it's non-nil, zero value otherwise.
func (u *UserLDAPMapping) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (u *UserLDAPMapping) GetLDAPDN() string
GetLDAPDN returns the LDAPDN field if it's non-nil, zero value otherwise.
func (u *UserLDAPMapping) GetLogin() string
GetLogin returns the Login field if it's non-nil, zero value otherwise.
func (u *UserLDAPMapping) GetOrganizationsURL() string
GetOrganizationsURL returns the OrganizationsURL field if it's non-nil, zero value otherwise.
func (u *UserLDAPMapping) GetReceivedEventsURL() string
GetReceivedEventsURL returns the ReceivedEventsURL field if it's non-nil, zero value otherwise.
func (u *UserLDAPMapping) GetReposURL() string
GetReposURL returns the ReposURL field if it's non-nil, zero value otherwise.
func (u *UserLDAPMapping) GetSiteAdmin() bool
GetSiteAdmin returns the SiteAdmin field if it's non-nil, zero value otherwise.
func (u *UserLDAPMapping) GetStarredURL() string
GetStarredURL returns the StarredURL field if it's non-nil, zero value otherwise.
func (u *UserLDAPMapping) GetSubscriptionsURL() string
GetSubscriptionsURL returns the SubscriptionsURL field if it's non-nil, zero value otherwise.
func (u *UserLDAPMapping) GetType() string
GetType returns the Type field if it's non-nil, zero value otherwise.
func (u *UserLDAPMapping) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (m UserLDAPMapping) String() string
type UserListOptions struct {
// ID of the last user seen
Since int64 `url:"since,omitempty"`
// Note: Pagination is powered exclusively by the Since parameter,
// ListOptions.Page has no effect.
// ListOptions.PerPage controls an undocumented GitHub API parameter.
ListOptions
}
UserListOptions specifies optional parameters to the UsersService.ListAll method.
type UserMigration struct {
ID *int64 `json:"id,omitempty"`
GUID *string `json:"guid,omitempty"`
// State is the current state of a migration.
// Possible values are:
// "pending" which means the migration hasn't started yet,
// "exporting" which means the migration is in progress,
// "exported" which means the migration finished successfully, or
// "failed" which means the migration failed.
State *string `json:"state,omitempty"`
// LockRepositories indicates whether repositories are locked (to prevent
// manipulation) while migrating data.
LockRepositories *bool `json:"lock_repositories,omitempty"`
// ExcludeAttachments indicates whether attachments should be excluded from
// the migration (to reduce migration archive file size).
ExcludeAttachments *bool `json:"exclude_attachments,omitempty"`
URL *string `json:"url,omitempty"`
CreatedAt *string `json:"created_at,omitempty"`
UpdatedAt *string `json:"updated_at,omitempty"`
Repositories []*Repository `json:"repositories,omitempty"`
}
UserMigration represents a GitHub migration (archival).
func (u *UserMigration) GetCreatedAt() string
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (u *UserMigration) GetExcludeAttachments() bool
GetExcludeAttachments returns the ExcludeAttachments field if it's non-nil, zero value otherwise.
func (u *UserMigration) GetGUID() string
GetGUID returns the GUID field if it's non-nil, zero value otherwise.
func (u *UserMigration) GetID() int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (u *UserMigration) GetLockRepositories() bool
GetLockRepositories returns the LockRepositories field if it's non-nil, zero value otherwise.
func (u *UserMigration) GetState() string
GetState returns the State field if it's non-nil, zero value otherwise.
func (u *UserMigration) GetURL() string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (u *UserMigration) GetUpdatedAt() string
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (m UserMigration) String() string
type UserMigrationOptions struct {
// LockRepositories indicates whether repositories should be locked (to prevent
// manipulation) while migrating data.
LockRepositories bool
// ExcludeAttachments indicates whether attachments should be excluded from
// the migration (to reduce migration archive file size).
ExcludeAttachments bool
}
UserMigrationOptions specifies the optional parameters to Migration methods.
type UserStats struct {
TotalUsers *int `json:"total_users,omitempty"`
AdminUsers *int `json:"admin_users,omitempty"`
SuspendedUsers *int `json:"suspended_users,omitempty"`
}
UserStats represents the number of total, admin and suspended users.
func (u *UserStats) GetAdminUsers() int
GetAdminUsers returns the AdminUsers field if it's non-nil, zero value otherwise.
func (u *UserStats) GetSuspendedUsers() int
GetSuspendedUsers returns the SuspendedUsers field if it's non-nil, zero value otherwise.
func (u *UserStats) GetTotalUsers() int
GetTotalUsers returns the TotalUsers field if it's non-nil, zero value otherwise.
func (s UserStats) String() string
type UsersSearchResult struct {
Total *int `json:"total_count,omitempty"`
IncompleteResults *bool `json:"incomplete_results,omitempty"`
Users []User `json:"items,omitempty"`
}
UsersSearchResult represents the result of a users search.
func (u *UsersSearchResult) GetIncompleteResults() bool
GetIncompleteResults returns the IncompleteResults field if it's non-nil, zero value otherwise.
func (u *UsersSearchResult) GetTotal() int
GetTotal returns the Total field if it's non-nil, zero value otherwise.
type UsersService service
UsersService handles communication with the user related methods of the GitHub API.
GitHub API docs: https://developer.github.com/v3/users/
func (s *UsersService) AcceptInvitation(ctx context.Context, invitationID int64) (*Response, error)
AcceptInvitation accepts the currently-open repository invitation for the authenticated user.
GitHub API docs: https://developer.github.com/v3/repos/invitations/#accept-a-repository-invitation
func (s *UsersService) AddEmails(ctx context.Context, emails []string) ([]*UserEmail, *Response, error)
AddEmails adds email addresses of the authenticated user.
GitHub API docs: https://developer.github.com/v3/users/emails/#add-email-addresses
func (s *UsersService) BlockUser(ctx context.Context, user string) (*Response, error)
BlockUser blocks specified user for the authenticated user.
GitHub API docs: https://developer.github.com/v3/users/blocking/#block-a-user
func (s *UsersService) CreateGPGKey(ctx context.Context, armoredPublicKey string) (*GPGKey, *Response, error)
CreateGPGKey creates a GPG key. It requires authenticatation via Basic Auth or OAuth with at least write:gpg_key scope.
GitHub API docs: https://developer.github.com/v3/users/gpg_keys/#create-a-gpg-key
func (s *UsersService) CreateKey(ctx context.Context, key *Key) (*Key, *Response, error)
CreateKey adds a public key for the authenticated user.
GitHub API docs: https://developer.github.com/v3/users/keys/#create-a-public-key
func (s *UsersService) DeclineInvitation(ctx context.Context, invitationID int64) (*Response, error)
DeclineInvitation declines the currently-open repository invitation for the authenticated user.
GitHub API docs: https://developer.github.com/v3/repos/invitations/#decline-a-repository-invitation
func (s *UsersService) DeleteEmails(ctx context.Context, emails []string) (*Response, error)
DeleteEmails deletes email addresses from authenticated user.
GitHub API docs: https://developer.github.com/v3/users/emails/#delete-email-addresses
func (s *UsersService) DeleteGPGKey(ctx context.Context, id int64) (*Response, error)
DeleteGPGKey deletes a GPG key. It requires authentication via Basic Auth or via OAuth with at least admin:gpg_key scope.
GitHub API docs: https://developer.github.com/v3/users/gpg_keys/#delete-a-gpg-key
func (s *UsersService) DeleteKey(ctx context.Context, id int64) (*Response, error)
DeleteKey deletes a public key.
GitHub API docs: https://developer.github.com/v3/users/keys/#delete-a-public-key
func (s *UsersService) DemoteSiteAdmin(ctx context.Context, user string) (*Response, error)
DemoteSiteAdmin demotes a user from site administrator of a GitHub Enterprise instance.
GitHub API docs: https://developer.github.com/v3/users/administration/#demote-a-site-administrator-to-an-ordinary-user
func (s *UsersService) Edit(ctx context.Context, user *User) (*User, *Response, error)
Edit the authenticated user.
GitHub API docs: https://developer.github.com/v3/users/#update-the-authenticated-user
func (s *UsersService) Follow(ctx context.Context, user string) (*Response, error)
Follow will cause the authenticated user to follow the specified user.
GitHub API docs: https://developer.github.com/v3/users/followers/#follow-a-user
func (s *UsersService) Get(ctx context.Context, user string) (*User, *Response, error)
Get fetches a user. Passing the empty string will fetch the authenticated user.
GitHub API docs: https://developer.github.com/v3/users/#get-a-single-user
func (s *UsersService) GetByID(ctx context.Context, id int64) (*User, *Response, error)
GetByID fetches a user.
Note: GetByID uses the undocumented GitHub API endpoint /user/:id.
func (s *UsersService) GetGPGKey(ctx context.Context, id int64) (*GPGKey, *Response, error)
GetGPGKey gets extended details for a single GPG key. It requires authentication via Basic Auth or via OAuth with at least read:gpg_key scope.
GitHub API docs: https://developer.github.com/v3/users/gpg_keys/#get-a-single-gpg-key
func (s *UsersService) GetHovercard(ctx context.Context, user string, opt *HovercardOptions) (*Hovercard, *Response, error)
GetHovercard fetches contextual information about user. It requires authentication via Basic Auth or via OAuth with the repo scope.
GitHub API docs: https://developer.github.com/v3/users/#get-contextual-information-about-a-user
func (s *UsersService) GetKey(ctx context.Context, id int64) (*Key, *Response, error)
GetKey fetches a single public key.
GitHub API docs: https://developer.github.com/v3/users/keys/#get-a-single-public-key
func (s *UsersService) IsBlocked(ctx context.Context, user string) (bool, *Response, error)
IsBlocked reports whether specified user is blocked by the authenticated user.
GitHub API docs: https://developer.github.com/v3/users/blocking/#check-whether-youve-blocked-a-user
func (s *UsersService) IsFollowing(ctx context.Context, user, target string) (bool, *Response, error)
IsFollowing checks if "user" is following "target". Passing the empty string for "user" will check if the authenticated user is following "target".
GitHub API docs: https://developer.github.com/v3/users/followers/#check-if-you-are-following-a-user
func (s *UsersService) ListAll(ctx context.Context, opt *UserListOptions) ([]*User, *Response, error)
ListAll lists all GitHub users.
To paginate through all users, populate 'Since' with the ID of the last user.
GitHub API docs: https://developer.github.com/v3/users/#get-all-users
Code:
package main
import (
"context"
"log"
"github.com/google/go-github/github"
)
func main() {
client := github.NewClient(nil)
opts := &github.UserListOptions{}
for {
users, _, err := client.Users.ListAll(context.Background(), opts)
if err != nil {
log.Fatalf("error listing users: %v", err)
}
if len(users) == 0 {
break
}
opts.Since = *users[len(users)-1].ID
// Process users...
}
}
func (s *UsersService) ListBlockedUsers(ctx context.Context, opt *ListOptions) ([]*User, *Response, error)
ListBlockedUsers lists all the blocked users by the authenticated user.
GitHub API docs: https://developer.github.com/v3/users/blocking/#list-blocked-users
func (s *UsersService) ListEmails(ctx context.Context, opt *ListOptions) ([]*UserEmail, *Response, error)
ListEmails lists all email addresses for the authenticated user.
GitHub API docs: https://developer.github.com/v3/users/emails/#list-email-addresses-for-a-user
func (s *UsersService) ListFollowers(ctx context.Context, user string, opt *ListOptions) ([]*User, *Response, error)
ListFollowers lists the followers for a user. Passing the empty string will fetch followers for the authenticated user.
GitHub API docs: https://developer.github.com/v3/users/followers/#list-followers-of-a-user
func (s *UsersService) ListFollowing(ctx context.Context, user string, opt *ListOptions) ([]*User, *Response, error)
ListFollowing lists the people that a user is following. Passing the empty string will list people the authenticated user is following.
GitHub API docs: https://developer.github.com/v3/users/followers/#list-users-followed-by-another-user
func (s *UsersService) ListGPGKeys(ctx context.Context, user string, opt *ListOptions) ([]*GPGKey, *Response, error)
ListGPGKeys lists the public GPG keys for a user. Passing the empty string will fetch keys for the authenticated user. It requires authentication via Basic Auth or via OAuth with at least read:gpg_key scope.
GitHub API docs: https://developer.github.com/v3/users/gpg_keys/#list-gpg-keys-for-a-user
func (s *UsersService) ListInvitations(ctx context.Context, opt *ListOptions) ([]*RepositoryInvitation, *Response, error)
ListInvitations lists all currently-open repository invitations for the authenticated user.
GitHub API docs: https://developer.github.com/v3/repos/invitations/#list-a-users-repository-invitations
func (s *UsersService) ListKeys(ctx context.Context, user string, opt *ListOptions) ([]*Key, *Response, error)
ListKeys lists the verified public keys for a user. Passing the empty string will fetch keys for the authenticated user.
GitHub API docs: https://developer.github.com/v3/users/keys/#list-public-keys-for-a-user
func (s *UsersService) PromoteSiteAdmin(ctx context.Context, user string) (*Response, error)
PromoteSiteAdmin promotes a user to a site administrator of a GitHub Enterprise instance.
GitHub API docs: https://developer.github.com/v3/users/administration/#promote-an-ordinary-user-to-a-site-administrator
func (s *UsersService) Suspend(ctx context.Context, user string) (*Response, error)
Suspend a user on a GitHub Enterprise instance.
GitHub API docs: https://developer.github.com/v3/users/administration/#suspend-a-user
func (s *UsersService) UnblockUser(ctx context.Context, user string) (*Response, error)
UnblockUser unblocks specified user for the authenticated user.
GitHub API docs: https://developer.github.com/v3/users/blocking/#unblock-a-user
func (s *UsersService) Unfollow(ctx context.Context, user string) (*Response, error)
Unfollow will cause the authenticated user to unfollow the specified user.
GitHub API docs: https://developer.github.com/v3/users/followers/#unfollow-a-user
func (s *UsersService) Unsuspend(ctx context.Context, user string) (*Response, error)
Unsuspend a user on a GitHub Enterprise instance.
GitHub API docs: https://developer.github.com/v3/users/administration/#unsuspend-a-user
type WatchEvent struct {
// Action is the action that was performed. Possible value is: "started".
Action *string `json:"action,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"`
}
WatchEvent is related to starring a repository, not watching. See this API blog post for an explanation: https://developer.github.com/changes/2012-09-05-watcher-api/
The event’s actor is the user who starred a repository, and the event’s repository is the repository that was starred.
GitHub API docs: https://developer.github.com/v3/activity/events/types/#watchevent
func (w *WatchEvent) GetAction() string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (w *WatchEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (w *WatchEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (w *WatchEvent) GetSender() *User
GetSender returns the Sender field.
type WebHookAuthor struct {
Email *string `json:"email,omitempty"`
Name *string `json:"name,omitempty"`
Username *string `json:"username,omitempty"`
}
WebHookAuthor represents the author or committer of a commit, as specified in a WebHookCommit. The commit author may not correspond to a GitHub User.
func (w *WebHookAuthor) GetEmail() string
GetEmail returns the Email field if it's non-nil, zero value otherwise.
func (w *WebHookAuthor) GetName() string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (w *WebHookAuthor) GetUsername() string
GetUsername returns the Username field if it's non-nil, zero value otherwise.
func (w WebHookAuthor) String() string
type WebHookCommit struct {
Added []string `json:"added,omitempty"`
Author *WebHookAuthor `json:"author,omitempty"`
Committer *WebHookAuthor `json:"committer,omitempty"`
Distinct *bool `json:"distinct,omitempty"`
ID *string `json:"id,omitempty"`
Message *string `json:"message,omitempty"`
Modified []string `json:"modified,omitempty"`
Removed []string `json:"removed,omitempty"`
Timestamp *time.Time `json:"timestamp,omitempty"`
}
WebHookCommit represents the commit variant we receive from GitHub in a WebHookPayload.
func (w *WebHookCommit) GetAuthor() *WebHookAuthor
GetAuthor returns the Author field.
func (w *WebHookCommit) GetCommitter() *WebHookAuthor
GetCommitter returns the Committer field.
func (w *WebHookCommit) GetDistinct() bool
GetDistinct returns the Distinct field if it's non-nil, zero value otherwise.
func (w *WebHookCommit) GetID() string
GetID returns the ID field if it's non-nil, zero value otherwise.
func (w *WebHookCommit) GetMessage() string
GetMessage returns the Message field if it's non-nil, zero value otherwise.
func (w *WebHookCommit) GetTimestamp() time.Time
GetTimestamp returns the Timestamp field if it's non-nil, zero value otherwise.
func (w WebHookCommit) String() string
type WebHookPayload struct {
After *string `json:"after,omitempty"`
Before *string `json:"before,omitempty"`
Commits []WebHookCommit `json:"commits,omitempty"`
Compare *string `json:"compare,omitempty"`
Created *bool `json:"created,omitempty"`
Deleted *bool `json:"deleted,omitempty"`
Forced *bool `json:"forced,omitempty"`
HeadCommit *WebHookCommit `json:"head_commit,omitempty"`
Pusher *User `json:"pusher,omitempty"`
Ref *string `json:"ref,omitempty"`
Repo *Repository `json:"repository,omitempty"`
Sender *User `json:"sender,omitempty"`
}
WebHookPayload represents the data that is received from GitHub when a push event hook is triggered. The format of these payloads pre-date most of the GitHub v3 API, so there are lots of minor incompatibilities with the types defined in the rest of the API. Therefore, several types are duplicated here to account for these differences.
GitHub API docs: https://help.github.com/articles/post-receive-hooks
func (w *WebHookPayload) GetAfter() string
GetAfter returns the After field if it's non-nil, zero value otherwise.
func (w *WebHookPayload) GetBefore() string
GetBefore returns the Before field if it's non-nil, zero value otherwise.
func (w *WebHookPayload) GetCompare() string
GetCompare returns the Compare field if it's non-nil, zero value otherwise.
func (w *WebHookPayload) GetCreated() bool
GetCreated returns the Created field if it's non-nil, zero value otherwise.
func (w *WebHookPayload) GetDeleted() bool
GetDeleted returns the Deleted field if it's non-nil, zero value otherwise.
func (w *WebHookPayload) GetForced() bool
GetForced returns the Forced field if it's non-nil, zero value otherwise.
func (w *WebHookPayload) GetHeadCommit() *WebHookCommit
GetHeadCommit returns the HeadCommit field.
func (w *WebHookPayload) GetPusher() *User
GetPusher returns the Pusher field.
func (w *WebHookPayload) GetRef() string
GetRef returns the Ref field if it's non-nil, zero value otherwise.
func (w *WebHookPayload) GetRepo() *Repository
GetRepo returns the Repo field.
func (w *WebHookPayload) GetSender() *User
GetSender returns the Sender field.
func (w WebHookPayload) String() string
type WeeklyCommitActivity struct {
Days []int `json:"days,omitempty"`
Total *int `json:"total,omitempty"`
Week *Timestamp `json:"week,omitempty"`
}
WeeklyCommitActivity represents the weekly commit activity for a repository. The days array is a group of commits per day, starting on Sunday.
func (w *WeeklyCommitActivity) GetTotal() int
GetTotal returns the Total field if it's non-nil, zero value otherwise.
func (w *WeeklyCommitActivity) GetWeek() Timestamp
GetWeek returns the Week field if it's non-nil, zero value otherwise.
func (w WeeklyCommitActivity) String() string
type WeeklyStats struct {
Week *Timestamp `json:"w,omitempty"`
Additions *int `json:"a,omitempty"`
Deletions *int `json:"d,omitempty"`
Commits *int `json:"c,omitempty"`
}
WeeklyStats represents the number of additions, deletions and commits a Contributor made in a given week.
func (w *WeeklyStats) GetAdditions() int
GetAdditions returns the Additions field if it's non-nil, zero value otherwise.
func (w *WeeklyStats) GetCommits() int
GetCommits returns the Commits field if it's non-nil, zero value otherwise.
func (w *WeeklyStats) GetDeletions() int
GetDeletions returns the Deletions field if it's non-nil, zero value otherwise.
func (w *WeeklyStats) GetWeek() Timestamp
GetWeek returns the Week field if it's non-nil, zero value otherwise.
func (w WeeklyStats) String() string
Version: v17.0.0+incompatible (latest)