github
packageThis package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version
Modules with tagged versions give importers more predictable builds.
Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Documentation¶
Overview¶
Package github provides a client for using the GitHub API.
Usage:
import "github.com/google/go-github/v43/github"// with go modules enabled (GO111MODULE=on or outside GOPATH)import "github.com/google/go-github/github" // with go modules disabled
Construct a new GitHub client, then use the various services on the client toaccess 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 tothe structure of the GitHub API documentation athttps://docs.github.com/en/free-pro-team@latest/rest/reference/.
NOTE: Using thehttps://godoc.org/context package, one can easilypass cancelation signals and deadlines to various services of the client forhandling 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 thehttps://github.com/google/go-github/tree/master/example directory.
Authentication¶
The go-github library does not directly handle authentication. Instead, whencreating a new client, pass an http.Client that can handle authentication foryou. The easiest and recommended way to do this is using the golang.org/x/oauth2library, 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 canuse 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 userrepos, _, err := client.Repositories.List(ctx, "", nil)}
Note that when using an authenticated Client, all calls made by the client willinclude the specified OAuth token. Therefore, authenticated clients shouldalmost 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 theBasicAuthTransport.
GitHub Apps authentication can be provided by thehttps://github.com/bradleyfalzon/ghinstallation package.It supports both authentication as an installation, using an installation access token,and as an app, using a JWT.
To authenticate as an installation:
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 clientclient := github.NewClient(&http.Client{Transport: itr})// Use client...}
To authenticate as an app, using a JWT:
import "github.com/bradleyfalzon/ghinstallation"func main() {// Wrap the shared transport for use with the application ID 1.atr, err := ghinstallation.NewAppsTransportKeyFromFile(http.DefaultTransport, 1, "2016-10-19.private-key.pem")if err != nil {// Handle error.}// Use app transport with clientclient := github.NewClient(&http.Client{Transport: atr})// Use client...}
Rate Limiting¶
GitHub imposes a rate limit on all API clients. Unauthenticated clients arelimited to 60 requests per hour, while authenticated clients can make up to5,000 requests per hour. The Search API has a custom rate limit. Unauthenticatedclients are limited to 10 requests per minute, while authenticated clientscan make up to 30 requests per minute. To receive the higher rate limit whenmaking calls that are not issued on behalf of a user,use UnauthenticatedRateLimitedTransport.
The returned Response.Rate value contains the rate limit informationfrom the most recent API call. If a recent enough response isn'tavailable, you can use RateLimits to fetch the most up-to-date ratelimit data for the client.
To detect an API rate limit error, you can check if its type is *github.RateLimitError.For secondary rate limits, you can check if its type is *github.AbuseRateLimitError:
repos, _, err := client.Repositories.List(ctx, "", nil)if _, ok := err.(*github.RateLimitError); ok {log.Println("hit rate limit")}if _, ok := err.(*github.AbuseRateLimitError); ok {log.Println("hit secondary rate limit")}
Learn more about GitHub rate limiting athttps://docs.github.com/en/free-pro-team@latest/rest/overview/resources-in-the-rest-api#rate-limiting.
Accepted Status¶
Some endpoints may return a 202 Accepted status code, meaning that theinformation required is not yet ready and was scheduled to be gathered onthe GitHub side. Methods known to behave like this are documented specifyingthis behavior.
To detect this condition of error, you can check if its type is*github.AcceptedError:
stats, _, err := client.Repositories.ListContributorsStats(ctx, org, repo)if _, ok := err.(*github.AcceptedError); ok {log.Println("scheduled on GitHub side")}
Conditional Requests¶
The GitHub API has good support for conditional requests which will helpprevent you from burning through your rate limit, as well as help speed up yourapplication. go-github does not handle conditional requests directly, but isinstead designed to work with a caching http.Transport. We recommend usinghttps://github.com/gregjones/httpcache for that.
Learn more about GitHub conditional requests athttps://docs.github.com/en/free-pro-team@latest/rest/overview/resources-in-the-rest-api#conditional-requests.
Creating and Updating Resources¶
All structs for GitHub resources use pointer values for all non-repeated fields.This allows distinguishing between unset fields and those set to a zero-value.Helper functions have been provided to easily create these pointers for string,bool, and int values. For example:
// create a new private repository named "foo"repo := &github.Repository{Name: github.String("foo"),Private: github.Bool(true),}client.Repositories.Create(ctx, "", repo)
Users who have worked with protocol buffers should find this pattern familiar.
Pagination¶
All requests for resource collections (repos, pull requests, issues, etc.)support pagination. Pagination options are described in thegithub.ListOptions struct and passed to the list methods directly or as anembedded type of a more specific list options struct (for examplegithub.PullRequestListOptions). Pages information is available via thegithub.Response struct.
client := github.NewClient(nil)opt := &github.RepositoryListByOrgOptions{ListOptions: github.ListOptions{PerPage: 10},}// get all pages of resultsvar allRepos []*github.Repositoryfor {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}
Index¶
- Constants
- Variables
- func Bool(v bool) *bool
- func CheckResponse(r *http.Response) error
- func DeliveryID(r *http.Request) string
- func Int(v int) *int
- func Int64(v int64) *int64
- func ParseWebHook(messageType string, payload []byte) (interface{}, error)
- func String(v string) *string
- func Stringify(message interface{}) string
- func ValidatePayload(r *http.Request, secretToken []byte) (payload []byte, err error)
- func ValidatePayloadFromBody(contentType string, readable io.Reader, signature string, secretToken []byte) (payload []byte, err error)
- func ValidateSignature(signature string, payload, secretToken []byte) error
- func WebHookType(r *http.Request) string
- type APIMeta
- type AbuseRateLimitError
- type AcceptedError
- type ActionBilling
- type ActionsAllowed
- type ActionsEnabledOnOrgRepos
- type ActionsPermissions
- type ActionsService
- func (s *ActionsService) AddEnabledReposInOrg(ctx context.Context, owner string, repositoryID int64) (*Response, error)
- func (s *ActionsService) AddRepositoryAccessRunnerGroup(ctx context.Context, org string, groupID, repoID int64) (*Response, error)
- func (s *ActionsService) AddRunnerGroupRunners(ctx context.Context, org string, groupID, runnerID int64) (*Response, error)
- func (s *ActionsService) AddSelectedRepoToOrgSecret(ctx context.Context, org, name string, repo *Repository) (*Response, error)
- func (s *ActionsService) CancelWorkflowRunByID(ctx context.Context, owner, repo string, runID int64) (*Response, error)
- func (s *ActionsService) CreateOrUpdateEnvSecret(ctx context.Context, repoID int, env string, eSecret *EncryptedSecret) (*Response, error)
- func (s *ActionsService) CreateOrUpdateOrgSecret(ctx context.Context, org string, eSecret *EncryptedSecret) (*Response, error)
- func (s *ActionsService) CreateOrUpdateRepoSecret(ctx context.Context, owner, repo string, eSecret *EncryptedSecret) (*Response, error)
- func (s *ActionsService) CreateOrganizationRegistrationToken(ctx context.Context, owner string) (*RegistrationToken, *Response, error)
- func (s *ActionsService) CreateOrganizationRemoveToken(ctx context.Context, owner string) (*RemoveToken, *Response, error)
- func (s *ActionsService) CreateOrganizationRunnerGroup(ctx context.Context, org string, createReq CreateRunnerGroupRequest) (*RunnerGroup, *Response, error)
- func (s *ActionsService) CreateRegistrationToken(ctx context.Context, owner, repo string) (*RegistrationToken, *Response, error)
- func (s *ActionsService) CreateRemoveToken(ctx context.Context, owner, repo string) (*RemoveToken, *Response, error)
- func (s *ActionsService) CreateWorkflowDispatchEventByFileName(ctx context.Context, owner, repo, workflowFileName string, ...) (*Response, error)
- func (s *ActionsService) CreateWorkflowDispatchEventByID(ctx context.Context, owner, repo string, workflowID int64, ...) (*Response, error)
- func (s *ActionsService) DeleteArtifact(ctx context.Context, owner, repo string, artifactID int64) (*Response, error)
- func (s *ActionsService) DeleteEnvSecret(ctx context.Context, repoID int, env, secretName string) (*Response, error)
- func (s *ActionsService) DeleteOrgSecret(ctx context.Context, org, name string) (*Response, error)
- func (s *ActionsService) DeleteOrganizationRunnerGroup(ctx context.Context, org string, groupID int64) (*Response, error)
- func (s *ActionsService) DeleteRepoSecret(ctx context.Context, owner, repo, name string) (*Response, error)
- func (s *ActionsService) DeleteWorkflowRun(ctx context.Context, owner, repo string, runID int64) (*Response, error)
- func (s *ActionsService) DeleteWorkflowRunLogs(ctx context.Context, owner, repo string, runID int64) (*Response, error)
- func (s *ActionsService) DisableWorkflowByFileName(ctx context.Context, owner, repo, workflowFileName string) (*Response, error)
- func (s *ActionsService) DisableWorkflowByID(ctx context.Context, owner, repo string, workflowID int64) (*Response, error)
- func (s *ActionsService) DownloadArtifact(ctx context.Context, owner, repo string, artifactID int64, ...) (*url.URL, *Response, error)
- func (s *ActionsService) EnableWorkflowByFileName(ctx context.Context, owner, repo, workflowFileName string) (*Response, error)
- func (s *ActionsService) EnableWorkflowByID(ctx context.Context, owner, repo string, workflowID int64) (*Response, error)
- func (s *ActionsService) GetArtifact(ctx context.Context, owner, repo string, artifactID int64) (*Artifact, *Response, error)
- func (s *ActionsService) GetEnvPublicKey(ctx context.Context, repoID int, env string) (*PublicKey, *Response, error)
- func (s *ActionsService) GetEnvSecret(ctx context.Context, repoID int, env, secretName string) (*Secret, *Response, error)
- func (s *ActionsService) GetOrgPublicKey(ctx context.Context, org string) (*PublicKey, *Response, error)
- func (s *ActionsService) GetOrgSecret(ctx context.Context, org, name string) (*Secret, *Response, error)
- func (s *ActionsService) GetOrganizationRunner(ctx context.Context, owner string, runnerID int64) (*Runner, *Response, error)
- func (s *ActionsService) GetOrganizationRunnerGroup(ctx context.Context, org string, groupID int64) (*RunnerGroup, *Response, error)
- func (s *ActionsService) GetRepoPublicKey(ctx context.Context, owner, repo string) (*PublicKey, *Response, error)
- func (s *ActionsService) GetRepoSecret(ctx context.Context, owner, repo, name string) (*Secret, *Response, error)
- func (s *ActionsService) GetRunner(ctx context.Context, owner, repo string, runnerID int64) (*Runner, *Response, error)
- func (s *ActionsService) GetWorkflowByFileName(ctx context.Context, owner, repo, workflowFileName string) (*Workflow, *Response, error)
- func (s *ActionsService) GetWorkflowByID(ctx context.Context, owner, repo string, workflowID int64) (*Workflow, *Response, error)
- func (s *ActionsService) GetWorkflowJobByID(ctx context.Context, owner, repo string, jobID int64) (*WorkflowJob, *Response, error)
- func (s *ActionsService) GetWorkflowJobLogs(ctx context.Context, owner, repo string, jobID int64, followRedirects bool) (*url.URL, *Response, error)
- func (s *ActionsService) GetWorkflowRunAttempt(ctx context.Context, owner, repo string, runID int64, attemptNumber int, ...) (*WorkflowRun, *Response, error)
- func (s *ActionsService) GetWorkflowRunByID(ctx context.Context, owner, repo string, runID int64) (*WorkflowRun, *Response, error)
- func (s *ActionsService) GetWorkflowRunLogs(ctx context.Context, owner, repo string, runID int64, followRedirects bool) (*url.URL, *Response, error)
- func (s *ActionsService) GetWorkflowRunUsageByID(ctx context.Context, owner, repo string, runID int64) (*WorkflowRunUsage, *Response, error)
- func (s *ActionsService) GetWorkflowUsageByFileName(ctx context.Context, owner, repo, workflowFileName string) (*WorkflowUsage, *Response, error)
- func (s *ActionsService) GetWorkflowUsageByID(ctx context.Context, owner, repo string, workflowID int64) (*WorkflowUsage, *Response, error)
- func (s *ActionsService) ListArtifacts(ctx context.Context, owner, repo string, opts *ListOptions) (*ArtifactList, *Response, error)
- func (s *ActionsService) ListEnabledReposInOrg(ctx context.Context, owner string, opts *ListOptions) (*ActionsEnabledOnOrgRepos, *Response, error)
- func (s *ActionsService) ListEnvSecrets(ctx context.Context, repoID int, env string, opts *ListOptions) (*Secrets, *Response, error)
- func (s *ActionsService) ListOrgSecrets(ctx context.Context, org string, opts *ListOptions) (*Secrets, *Response, error)
- func (s *ActionsService) ListOrganizationRunnerApplicationDownloads(ctx context.Context, owner string) ([]*RunnerApplicationDownload, *Response, error)
- func (s *ActionsService) ListOrganizationRunnerGroups(ctx context.Context, org string, opts *ListOptions) (*RunnerGroups, *Response, error)
- func (s *ActionsService) ListOrganizationRunners(ctx context.Context, owner string, opts *ListOptions) (*Runners, *Response, error)
- func (s *ActionsService) ListRepoSecrets(ctx context.Context, owner, repo string, opts *ListOptions) (*Secrets, *Response, error)
- func (s *ActionsService) ListRepositoryAccessRunnerGroup(ctx context.Context, org string, groupID int64, opts *ListOptions) (*ListRepositories, *Response, error)
- func (s *ActionsService) ListRepositoryWorkflowRuns(ctx context.Context, owner, repo string, opts *ListWorkflowRunsOptions) (*WorkflowRuns, *Response, error)
- func (s *ActionsService) ListRunnerApplicationDownloads(ctx context.Context, owner, repo string) ([]*RunnerApplicationDownload, *Response, error)
- func (s *ActionsService) ListRunnerGroupRunners(ctx context.Context, org string, groupID int64, opts *ListOptions) (*Runners, *Response, error)
- func (s *ActionsService) ListRunners(ctx context.Context, owner, repo string, opts *ListOptions) (*Runners, *Response, error)
- func (s *ActionsService) ListSelectedReposForOrgSecret(ctx context.Context, org, name string, opts *ListOptions) (*SelectedReposList, *Response, error)
- func (s *ActionsService) ListWorkflowJobs(ctx context.Context, owner, repo string, runID int64, ...) (*Jobs, *Response, error)
- func (s *ActionsService) ListWorkflowRunArtifacts(ctx context.Context, owner, repo string, runID int64, opts *ListOptions) (*ArtifactList, *Response, error)
- func (s *ActionsService) ListWorkflowRunsByFileName(ctx context.Context, owner, repo, workflowFileName string, ...) (*WorkflowRuns, *Response, error)
- func (s *ActionsService) ListWorkflowRunsByID(ctx context.Context, owner, repo string, workflowID int64, ...) (*WorkflowRuns, *Response, error)
- func (s *ActionsService) ListWorkflows(ctx context.Context, owner, repo string, opts *ListOptions) (*Workflows, *Response, error)
- func (s *ActionsService) RemoveEnabledRepoInOrg(ctx context.Context, owner string, repositoryID int64) (*Response, error)
- func (s *ActionsService) RemoveOrganizationRunner(ctx context.Context, owner string, runnerID int64) (*Response, error)
- func (s *ActionsService) RemoveRepositoryAccessRunnerGroup(ctx context.Context, org string, groupID, repoID int64) (*Response, error)
- func (s *ActionsService) RemoveRunner(ctx context.Context, owner, repo string, runnerID int64) (*Response, error)
- func (s *ActionsService) RemoveRunnerGroupRunners(ctx context.Context, org string, groupID, runnerID int64) (*Response, error)
- func (s *ActionsService) RemoveSelectedRepoFromOrgSecret(ctx context.Context, org, name string, repo *Repository) (*Response, error)
- func (s *ActionsService) RerunWorkflowByID(ctx context.Context, owner, repo string, runID int64) (*Response, error)
- func (s *ActionsService) SetEnabledReposInOrg(ctx context.Context, owner string, repositoryIDs []int64) (*Response, error)
- func (s *ActionsService) SetRepositoryAccessRunnerGroup(ctx context.Context, org string, groupID int64, ...) (*Response, error)
- func (s *ActionsService) SetRunnerGroupRunners(ctx context.Context, org string, groupID int64, ...) (*Response, error)
- func (s *ActionsService) SetSelectedReposForOrgSecret(ctx context.Context, org, name string, ids SelectedRepoIDs) (*Response, error)
- func (s *ActionsService) UpdateOrganizationRunnerGroup(ctx context.Context, org string, groupID int64, ...) (*RunnerGroup, *Response, error)
- type ActiveCommitters
- type ActivityListStarredOptions
- type ActivityService
- func (s *ActivityService) DeleteRepositorySubscription(ctx context.Context, owner, repo string) (*Response, error)
- func (s *ActivityService) DeleteThreadSubscription(ctx context.Context, id string) (*Response, error)
- func (s *ActivityService) GetRepositorySubscription(ctx context.Context, owner, repo string) (*Subscription, *Response, error)
- func (s *ActivityService) GetThread(ctx context.Context, id string) (*Notification, *Response, error)
- func (s *ActivityService) GetThreadSubscription(ctx context.Context, id string) (*Subscription, *Response, error)
- func (s *ActivityService) IsStarred(ctx context.Context, owner, repo string) (bool, *Response, error)
- func (s *ActivityService) ListEvents(ctx context.Context, opts *ListOptions) ([]*Event, *Response, error)
- func (s *ActivityService) ListEventsForOrganization(ctx context.Context, org string, opts *ListOptions) ([]*Event, *Response, error)
- func (s *ActivityService) ListEventsForRepoNetwork(ctx context.Context, owner, repo string, opts *ListOptions) ([]*Event, *Response, error)
- func (s *ActivityService) ListEventsPerformedByUser(ctx context.Context, user string, publicOnly bool, opts *ListOptions) ([]*Event, *Response, error)
- func (s *ActivityService) ListEventsReceivedByUser(ctx context.Context, user string, publicOnly bool, opts *ListOptions) ([]*Event, *Response, error)
- func (s *ActivityService) ListFeeds(ctx context.Context) (*Feeds, *Response, error)
- func (s *ActivityService) ListIssueEventsForRepository(ctx context.Context, owner, repo string, opts *ListOptions) ([]*IssueEvent, *Response, error)
- func (s *ActivityService) ListNotifications(ctx context.Context, opts *NotificationListOptions) ([]*Notification, *Response, error)
- func (s *ActivityService) ListRepositoryEvents(ctx context.Context, owner, repo string, opts *ListOptions) ([]*Event, *Response, error)
- func (s *ActivityService) ListRepositoryNotifications(ctx context.Context, owner, repo string, opts *NotificationListOptions) ([]*Notification, *Response, error)
- func (s *ActivityService) ListStargazers(ctx context.Context, owner, repo string, opts *ListOptions) ([]*Stargazer, *Response, error)
- func (s *ActivityService) ListStarred(ctx context.Context, user string, opts *ActivityListStarredOptions) ([]*StarredRepository, *Response, error)
- func (s *ActivityService) ListUserEventsForOrganization(ctx context.Context, org, user string, opts *ListOptions) ([]*Event, *Response, error)
- func (s *ActivityService) ListWatched(ctx context.Context, user string, opts *ListOptions) ([]*Repository, *Response, error)
- func (s *ActivityService) ListWatchers(ctx context.Context, owner, repo string, opts *ListOptions) ([]*User, *Response, error)
- func (s *ActivityService) MarkNotificationsRead(ctx context.Context, lastRead time.Time) (*Response, error)
- func (s *ActivityService) MarkRepositoryNotificationsRead(ctx context.Context, owner, repo string, lastRead time.Time) (*Response, error)
- func (s *ActivityService) MarkThreadRead(ctx context.Context, id string) (*Response, error)
- func (s *ActivityService) SetRepositorySubscription(ctx context.Context, owner, repo string, subscription *Subscription) (*Subscription, *Response, error)
- func (s *ActivityService) SetThreadSubscription(ctx context.Context, id string, subscription *Subscription) (*Subscription, *Response, error)
- func (s *ActivityService) Star(ctx context.Context, owner, repo string) (*Response, error)
- func (s *ActivityService) Unstar(ctx context.Context, owner, repo string) (*Response, error)
- type AdminEnforcement
- type AdminService
- func (s *AdminService) CreateOrg(ctx context.Context, org *Organization, admin string) (*Organization, *Response, error)
- func (s *AdminService) CreateUser(ctx context.Context, login, email string) (*User, *Response, error)
- func (s *AdminService) CreateUserImpersonation(ctx context.Context, username string, opts *ImpersonateUserOptions) (*UserAuthorization, *Response, error)
- func (s *AdminService) DeleteUser(ctx context.Context, username string) (*Response, error)
- func (s *AdminService) DeleteUserImpersonation(ctx context.Context, username string) (*Response, error)
- func (s *AdminService) GetAdminStats(ctx context.Context) (*AdminStats, *Response, error)
- func (s *AdminService) RenameOrg(ctx context.Context, org *Organization, newName string) (*RenameOrgResponse, *Response, error)
- func (s *AdminService) RenameOrgByName(ctx context.Context, org, newName string) (*RenameOrgResponse, *Response, error)
- func (s *AdminService) UpdateTeamLDAPMapping(ctx context.Context, team int64, mapping *TeamLDAPMapping) (*TeamLDAPMapping, *Response, error)
- func (s *AdminService) UpdateUserLDAPMapping(ctx context.Context, user string, mapping *UserLDAPMapping) (*UserLDAPMapping, *Response, error)
- type AdminStats
- func (a *AdminStats) GetComments() *CommentStats
- func (a *AdminStats) GetGists() *GistStats
- func (a *AdminStats) GetHooks() *HookStats
- func (a *AdminStats) GetIssues() *IssueStats
- func (a *AdminStats) GetMilestones() *MilestoneStats
- func (a *AdminStats) GetOrgs() *OrgStats
- func (a *AdminStats) GetPages() *PageStats
- func (a *AdminStats) GetPulls() *PullStats
- func (a *AdminStats) GetRepos() *RepoStats
- func (a *AdminStats) GetUsers() *UserStats
- func (s AdminStats) String() string
- type AdvancedSecurity
- type AdvancedSecurityCommittersBreakdown
- type Alert
- func (a *Alert) GetClosedAt() Timestamp
- func (a *Alert) GetClosedBy() *User
- func (a *Alert) GetCreatedAt() Timestamp
- func (a *Alert) GetDismissedAt() Timestamp
- func (a *Alert) GetDismissedBy() *User
- func (a *Alert) GetDismissedReason() string
- func (a *Alert) GetHTMLURL() string
- func (a *Alert) GetInstancesURL() string
- func (a *Alert) GetMostRecentInstance() *MostRecentInstance
- func (a *Alert) GetRule() *Rule
- func (a *Alert) GetRuleDescription() string
- func (a *Alert) GetRuleID() string
- func (a *Alert) GetRuleSeverity() string
- func (a *Alert) GetState() string
- func (a *Alert) GetTool() *Tool
- func (a *Alert) GetURL() string
- func (a *Alert) ID() int64
- type AlertListOptions
- type AllowDeletions
- type AllowForcePushes
- type AnalysesListOptions
- type App
- func (a *App) GetCreatedAt() Timestamp
- func (a *App) GetDescription() string
- func (a *App) GetExternalURL() string
- func (a *App) GetHTMLURL() string
- func (a *App) GetID() int64
- func (a *App) GetName() string
- func (a *App) GetNodeID() string
- func (a *App) GetOwner() *User
- func (a *App) GetPermissions() *InstallationPermissions
- func (a *App) GetSlug() string
- func (a *App) GetUpdatedAt() Timestamp
- type AppConfig
- func (a *AppConfig) GetClientID() string
- func (a *AppConfig) GetClientSecret() string
- func (a *AppConfig) GetCreatedAt() Timestamp
- func (a *AppConfig) GetDescription() string
- func (a *AppConfig) GetExternalURL() string
- func (a *AppConfig) GetHTMLURL() string
- func (a *AppConfig) GetID() int64
- func (a *AppConfig) GetName() string
- func (a *AppConfig) GetNodeID() string
- func (a *AppConfig) GetOwner() *User
- func (a *AppConfig) GetPEM() string
- func (a *AppConfig) GetSlug() string
- func (a *AppConfig) GetUpdatedAt() Timestamp
- func (a *AppConfig) GetWebhookSecret() string
- type AppsService
- func (s *AppsService) AddRepository(ctx context.Context, instID, repoID int64) (*Repository, *Response, error)
- func (s *AppsService) CompleteAppManifest(ctx context.Context, code string) (*AppConfig, *Response, error)
- func (s *AppsService) CreateAttachment(ctx context.Context, contentReferenceID int64, title, body string) (*Attachment, *Response, error)
- func (s *AppsService) CreateInstallationToken(ctx context.Context, id int64, opts *InstallationTokenOptions) (*InstallationToken, *Response, error)
- func (s *AppsService) DeleteInstallation(ctx context.Context, id int64) (*Response, error)
- func (s *AppsService) FindOrganizationInstallation(ctx context.Context, org string) (*Installation, *Response, error)
- func (s *AppsService) FindRepositoryInstallation(ctx context.Context, owner, repo string) (*Installation, *Response, error)
- func (s *AppsService) FindRepositoryInstallationByID(ctx context.Context, id int64) (*Installation, *Response, error)
- func (s *AppsService) FindUserInstallation(ctx context.Context, user string) (*Installation, *Response, error)
- func (s *AppsService) Get(ctx context.Context, appSlug string) (*App, *Response, error)
- func (s *AppsService) GetHookConfig(ctx context.Context) (*HookConfig, *Response, error)
- func (s *AppsService) GetHookDelivery(ctx context.Context, deliveryID int64) (*HookDelivery, *Response, error)
- func (s *AppsService) GetInstallation(ctx context.Context, id int64) (*Installation, *Response, error)
- func (s *AppsService) ListHookDeliveries(ctx context.Context, opts *ListCursorOptions) ([]*HookDelivery, *Response, error)
- func (s *AppsService) ListInstallations(ctx context.Context, opts *ListOptions) ([]*Installation, *Response, error)
- func (s *AppsService) ListRepos(ctx context.Context, opts *ListOptions) (*ListRepositories, *Response, error)
- func (s *AppsService) ListUserInstallations(ctx context.Context, opts *ListOptions) ([]*Installation, *Response, error)
- func (s *AppsService) ListUserRepos(ctx context.Context, id int64, opts *ListOptions) (*ListRepositories, *Response, error)
- func (s *AppsService) RedeliverHookDelivery(ctx context.Context, deliveryID int64) (*HookDelivery, *Response, error)
- func (s *AppsService) RemoveRepository(ctx context.Context, instID, repoID int64) (*Response, error)
- func (s *AppsService) RevokeInstallationToken(ctx context.Context) (*Response, error)
- func (s *AppsService) SuspendInstallation(ctx context.Context, id int64) (*Response, error)
- func (s *AppsService) UnsuspendInstallation(ctx context.Context, id int64) (*Response, error)
- func (s *AppsService) UpdateHookConfig(ctx context.Context, config *HookConfig) (*HookConfig, *Response, error)
- type ArchiveFormat
- type Artifact
- func (a *Artifact) GetArchiveDownloadURL() string
- func (a *Artifact) GetCreatedAt() Timestamp
- func (a *Artifact) GetExpired() bool
- func (a *Artifact) GetExpiresAt() Timestamp
- func (a *Artifact) GetID() int64
- func (a *Artifact) GetName() string
- func (a *Artifact) GetNodeID() string
- func (a *Artifact) GetSizeInBytes() int64
- type ArtifactList
- type Attachment
- type AuditEntry
- func (a *AuditEntry) GetAction() string
- func (a *AuditEntry) GetActive() bool
- func (a *AuditEntry) GetActiveWas() bool
- func (a *AuditEntry) GetActor() string
- func (a *AuditEntry) GetBlockedUser() string
- func (a *AuditEntry) GetBusiness() string
- func (a *AuditEntry) GetCancelledAt() Timestamp
- func (a *AuditEntry) GetCompletedAt() Timestamp
- func (a *AuditEntry) GetConclusion() string
- func (a *AuditEntry) GetConfig() *HookConfig
- func (a *AuditEntry) GetConfigWas() *HookConfig
- func (a *AuditEntry) GetContentType() string
- func (a *AuditEntry) GetCreatedAt() Timestamp
- func (a *AuditEntry) GetDeployKeyFingerprint() string
- func (a *AuditEntry) GetDocumentID() string
- func (a *AuditEntry) GetEmoji() string
- func (a *AuditEntry) GetEnvironmentName() string
- func (a *AuditEntry) GetEvent() string
- func (a *AuditEntry) GetExplanation() string
- func (a *AuditEntry) GetFingerprint() string
- func (a *AuditEntry) GetHeadBranch() string
- func (a *AuditEntry) GetHeadSHA() string
- func (a *AuditEntry) GetHookID() int64
- func (a *AuditEntry) GetIsHostedRunner() bool
- func (a *AuditEntry) GetJobName() string
- func (a *AuditEntry) GetLimitedAvailability() bool
- func (a *AuditEntry) GetMessage() string
- func (a *AuditEntry) GetName() string
- func (a *AuditEntry) GetOldUser() string
- func (a *AuditEntry) GetOpenSSHPublicKey() string
- func (a *AuditEntry) GetOrg() string
- func (a *AuditEntry) GetPreviousVisibility() string
- func (a *AuditEntry) GetReadOnly() string
- func (a *AuditEntry) GetRepo() string
- func (a *AuditEntry) GetRepository() string
- func (a *AuditEntry) GetRepositoryPublic() bool
- func (a *AuditEntry) GetRunnerGroupID() int64
- func (a *AuditEntry) GetRunnerGroupName() string
- func (a *AuditEntry) GetRunnerID() int64
- func (a *AuditEntry) GetRunnerName() string
- func (a *AuditEntry) GetSourceVersion() string
- func (a *AuditEntry) GetStartedAt() Timestamp
- func (a *AuditEntry) GetTargetLogin() string
- func (a *AuditEntry) GetTargetVersion() string
- func (a *AuditEntry) GetTeam() string
- func (a *AuditEntry) GetTimestamp() Timestamp
- func (a *AuditEntry) GetTransportProtocol() int
- func (a *AuditEntry) GetTransportProtocolName() string
- func (a *AuditEntry) GetTriggerID() int64
- func (a *AuditEntry) GetUser() string
- func (a *AuditEntry) GetVisibility() string
- func (a *AuditEntry) GetWorkflowID() int64
- func (a *AuditEntry) GetWorkflowRunID() int64
- type Authorization
- func (a *Authorization) GetApp() *AuthorizationApp
- func (a *Authorization) GetCreatedAt() Timestamp
- func (a *Authorization) GetFingerprint() string
- func (a *Authorization) GetHashedToken() string
- func (a *Authorization) GetID() int64
- func (a *Authorization) GetNote() string
- func (a *Authorization) GetNoteURL() string
- func (a *Authorization) GetToken() string
- func (a *Authorization) GetTokenLastEight() string
- func (a *Authorization) GetURL() string
- func (a *Authorization) GetUpdatedAt() Timestamp
- func (a *Authorization) GetUser() *User
- func (a Authorization) String() string
- type AuthorizationApp
- type AuthorizationRequest
- func (a *AuthorizationRequest) GetClientID() string
- func (a *AuthorizationRequest) GetClientSecret() string
- func (a *AuthorizationRequest) GetFingerprint() string
- func (a *AuthorizationRequest) GetNote() string
- func (a *AuthorizationRequest) GetNoteURL() string
- func (a AuthorizationRequest) String() string
- type AuthorizationUpdateRequest
- type AuthorizationsService
- func (s *AuthorizationsService) Check(ctx context.Context, clientID, accessToken string) (*Authorization, *Response, error)
- func (s *AuthorizationsService) CreateImpersonation(ctx context.Context, username string, authReq *AuthorizationRequest) (*Authorization, *Response, error)
- func (s *AuthorizationsService) DeleteGrant(ctx context.Context, clientID, accessToken string) (*Response, error)
- func (s *AuthorizationsService) DeleteImpersonation(ctx context.Context, username string) (*Response, error)
- func (s *AuthorizationsService) Reset(ctx context.Context, clientID, accessToken string) (*Authorization, *Response, error)
- func (s *AuthorizationsService) Revoke(ctx context.Context, clientID, accessToken string) (*Response, error)
- type AuthorizedActorNames
- type AuthorizedActorsOnly
- type AutoTriggerCheck
- type Autolink
- type AutolinkOptions
- type BasicAuthTransport
- type BillingService
- func (s *BillingService) GetActionsBillingOrg(ctx context.Context, org string) (*ActionBilling, *Response, error)
- func (s *BillingService) GetActionsBillingUser(ctx context.Context, user string) (*ActionBilling, *Response, error)
- func (s *BillingService) GetAdvancedSecurityActiveCommittersOrg(ctx context.Context, org string) (*ActiveCommitters, *Response, error)
- func (s *BillingService) GetPackagesBillingOrg(ctx context.Context, org string) (*PackageBilling, *Response, error)
- func (s *BillingService) GetPackagesBillingUser(ctx context.Context, user string) (*PackageBilling, *Response, error)
- func (s *BillingService) GetStorageBillingOrg(ctx context.Context, org string) (*StorageBilling, *Response, error)
- func (s *BillingService) GetStorageBillingUser(ctx context.Context, user string) (*StorageBilling, *Response, error)
- type Blob
- type Branch
- type BranchCommit
- type BranchListOptions
- type BranchPolicy
- type BranchProtectionRule
- func (b *BranchProtectionRule) GetAdminEnforced() bool
- func (b *BranchProtectionRule) GetAllowDeletionsEnforcementLevel() string
- func (b *BranchProtectionRule) GetAllowForcePushesEnforcementLevel() string
- func (b *BranchProtectionRule) GetAuthorizedActorsOnly() bool
- func (b *BranchProtectionRule) GetAuthorizedDismissalActorsOnly() bool
- func (b *BranchProtectionRule) GetCreatedAt() Timestamp
- func (b *BranchProtectionRule) GetDismissStaleReviewsOnPush() bool
- func (b *BranchProtectionRule) GetID() int64
- func (b *BranchProtectionRule) GetIgnoreApprovalsFromContributors() bool
- func (b *BranchProtectionRule) GetLinearHistoryRequirementEnforcementLevel() string
- func (b *BranchProtectionRule) GetMergeQueueEnforcementLevel() string
- func (b *BranchProtectionRule) GetName() string
- func (b *BranchProtectionRule) GetPullRequestReviewsEnforcementLevel() string
- func (b *BranchProtectionRule) GetRepositoryID() int64
- func (b *BranchProtectionRule) GetRequireCodeOwnerReview() bool
- func (b *BranchProtectionRule) GetRequiredApprovingReviewCount() int
- func (b *BranchProtectionRule) GetRequiredConversationResolutionLevel() string
- func (b *BranchProtectionRule) GetRequiredDeploymentsEnforcementLevel() string
- func (b *BranchProtectionRule) GetRequiredStatusChecksEnforcementLevel() string
- func (b *BranchProtectionRule) GetSignatureRequirementEnforcementLevel() string
- func (b *BranchProtectionRule) GetStrictRequiredStatusChecksPolicy() bool
- func (b *BranchProtectionRule) GetUpdatedAt() Timestamp
- type BranchProtectionRuleEvent
- func (b *BranchProtectionRuleEvent) GetAction() string
- func (b *BranchProtectionRuleEvent) GetChanges() *ProtectionChanges
- func (b *BranchProtectionRuleEvent) GetInstallation() *Installation
- func (b *BranchProtectionRuleEvent) GetOrg() *Organization
- func (b *BranchProtectionRuleEvent) GetRepo() *Repository
- func (b *BranchProtectionRuleEvent) GetRule() *BranchProtectionRule
- func (b *BranchProtectionRuleEvent) GetSender() *User
- type BranchRestrictions
- type BranchRestrictionsRequest
- type CheckRun
- func (c *CheckRun) GetApp() *App
- func (c *CheckRun) GetCheckSuite() *CheckSuite
- func (c *CheckRun) GetCompletedAt() Timestamp
- func (c *CheckRun) GetConclusion() string
- func (c *CheckRun) GetDetailsURL() string
- func (c *CheckRun) GetExternalID() string
- func (c *CheckRun) GetHTMLURL() string
- func (c *CheckRun) GetHeadSHA() string
- func (c *CheckRun) GetID() int64
- func (c *CheckRun) GetName() string
- func (c *CheckRun) GetNodeID() string
- func (c *CheckRun) GetOutput() *CheckRunOutput
- func (c *CheckRun) GetStartedAt() Timestamp
- func (c *CheckRun) GetStatus() string
- func (c *CheckRun) GetURL() string
- func (c CheckRun) String() string
- type CheckRunAction
- type CheckRunAnnotation
- func (c *CheckRunAnnotation) GetAnnotationLevel() string
- func (c *CheckRunAnnotation) GetEndColumn() int
- func (c *CheckRunAnnotation) GetEndLine() int
- func (c *CheckRunAnnotation) GetMessage() string
- func (c *CheckRunAnnotation) GetPath() string
- func (c *CheckRunAnnotation) GetRawDetails() string
- func (c *CheckRunAnnotation) GetStartColumn() int
- func (c *CheckRunAnnotation) GetStartLine() int
- func (c *CheckRunAnnotation) GetTitle() string
- type CheckRunEvent
- func (c *CheckRunEvent) GetAction() string
- func (c *CheckRunEvent) GetCheckRun() *CheckRun
- func (c *CheckRunEvent) GetInstallation() *Installation
- func (c *CheckRunEvent) GetOrg() *Organization
- func (c *CheckRunEvent) GetRepo() *Repository
- func (c *CheckRunEvent) GetRequestedAction() *RequestedAction
- func (c *CheckRunEvent) GetSender() *User
- type CheckRunImage
- type CheckRunOutput
- type CheckSuite
- func (c *CheckSuite) GetAfterSHA() string
- func (c *CheckSuite) GetApp() *App
- func (c *CheckSuite) GetBeforeSHA() string
- func (c *CheckSuite) GetConclusion() string
- func (c *CheckSuite) GetCreatedAt() Timestamp
- func (c *CheckSuite) GetHeadBranch() string
- func (c *CheckSuite) GetHeadCommit() *Commit
- func (c *CheckSuite) GetHeadSHA() string
- func (c *CheckSuite) GetID() int64
- func (c *CheckSuite) GetNodeID() string
- func (c *CheckSuite) GetRepository() *Repository
- func (c *CheckSuite) GetStatus() string
- func (c *CheckSuite) GetURL() string
- func (c *CheckSuite) GetUpdatedAt() Timestamp
- func (c CheckSuite) String() string
- type CheckSuiteEvent
- type CheckSuitePreferenceOptions
- type CheckSuitePreferenceResults
- type ChecksService
- func (s *ChecksService) CreateCheckRun(ctx context.Context, owner, repo string, opts CreateCheckRunOptions) (*CheckRun, *Response, error)
- func (s *ChecksService) CreateCheckSuite(ctx context.Context, owner, repo string, opts CreateCheckSuiteOptions) (*CheckSuite, *Response, error)
- func (s *ChecksService) GetCheckRun(ctx context.Context, owner, repo string, checkRunID int64) (*CheckRun, *Response, error)
- func (s *ChecksService) GetCheckSuite(ctx context.Context, owner, repo string, checkSuiteID int64) (*CheckSuite, *Response, error)
- func (s *ChecksService) ListCheckRunAnnotations(ctx context.Context, owner, repo string, checkRunID int64, opts *ListOptions) ([]*CheckRunAnnotation, *Response, error)
- func (s *ChecksService) ListCheckRunsCheckSuite(ctx context.Context, owner, repo string, checkSuiteID int64, ...) (*ListCheckRunsResults, *Response, error)
- func (s *ChecksService) ListCheckRunsForRef(ctx context.Context, owner, repo, ref string, opts *ListCheckRunsOptions) (*ListCheckRunsResults, *Response, error)
- func (s *ChecksService) ListCheckSuitesForRef(ctx context.Context, owner, repo, ref string, opts *ListCheckSuiteOptions) (*ListCheckSuiteResults, *Response, error)
- func (s *ChecksService) ReRequestCheckSuite(ctx context.Context, owner, repo string, checkSuiteID int64) (*Response, error)
- func (s *ChecksService) SetCheckSuitePreferences(ctx context.Context, owner, repo string, opts CheckSuitePreferenceOptions) (*CheckSuitePreferenceResults, *Response, error)
- func (s *ChecksService) UpdateCheckRun(ctx context.Context, owner, repo string, checkRunID int64, ...) (*CheckRun, *Response, error)
- type Client
- func (c *Client) APIMeta(ctx context.Context) (*APIMeta, *Response, error)
- func (c *Client) BareDo(ctx context.Context, req *http.Request) (*Response, error)
- func (c *Client) Client() *http.Client
- func (c *Client) Do(ctx context.Context, req *http.Request, v interface{}) (*Response, error)
- func (c *Client) GetCodeOfConduct(ctx context.Context, key string) (*CodeOfConduct, *Response, error)
- func (c *Client) ListCodesOfConduct(ctx context.Context) ([]*CodeOfConduct, *Response, error)
- func (c *Client) ListEmojis(ctx context.Context) (map[string]string, *Response, error)
- func (c *Client) ListServiceHooks(ctx context.Context) ([]*ServiceHook, *Response, error)
- func (c *Client) Markdown(ctx context.Context, text string, opts *MarkdownOptions) (string, *Response, error)
- func (c *Client) NewRequest(method, urlStr string, body interface{}) (*http.Request, error)
- func (c *Client) NewUploadRequest(urlStr string, reader io.Reader, size int64, mediaType string) (*http.Request, error)
- func (c *Client) Octocat(ctx context.Context, message string) (string, *Response, error)
- func (c *Client) RateLimits(ctx context.Context) (*RateLimits, *Response, error)
- func (c *Client) Zen(ctx context.Context) (string, *Response, error)
- type CodeOfConduct
- type CodeResult
- type CodeScanningService
- func (s *CodeScanningService) GetAlert(ctx context.Context, owner, repo string, id int64) (*Alert, *Response, error)
- func (s *CodeScanningService) GetAnalysis(ctx context.Context, owner, repo string, id int64) (*ScanningAnalysis, *Response, error)
- func (s *CodeScanningService) ListAlertsForRepo(ctx context.Context, owner, repo string, opts *AlertListOptions) ([]*Alert, *Response, error)
- func (s *CodeScanningService) ListAnalysesForRepo(ctx context.Context, owner, repo string, opts *AnalysesListOptions) ([]*ScanningAnalysis, *Response, error)
- func (s *CodeScanningService) UploadSarif(ctx context.Context, owner, repo string, sarif *SarifAnalysis) (*SarifID, *Response, error)
- type CodeSearchResult
- type CollaboratorInvitation
- func (c *CollaboratorInvitation) GetCreatedAt() Timestamp
- func (c *CollaboratorInvitation) GetHTMLURL() string
- func (c *CollaboratorInvitation) GetID() int64
- func (c *CollaboratorInvitation) GetInvitee() *User
- func (c *CollaboratorInvitation) GetInviter() *User
- func (c *CollaboratorInvitation) GetPermissions() string
- func (c *CollaboratorInvitation) GetRepo() *Repository
- func (c *CollaboratorInvitation) GetURL() string
- type CombinedStatus
- func (c *CombinedStatus) GetCommitURL() string
- func (c *CombinedStatus) GetName() string
- func (c *CombinedStatus) GetRepositoryURL() string
- func (c *CombinedStatus) GetSHA() string
- func (c *CombinedStatus) GetState() string
- func (c *CombinedStatus) GetTotalCount() int
- func (s CombinedStatus) String() string
- type Comment
- type CommentStats
- type Commit
- func (c *Commit) GetAuthor() *CommitAuthor
- func (c *Commit) GetCommentCount() int
- func (c *Commit) GetCommitter() *CommitAuthor
- func (c *Commit) GetHTMLURL() string
- func (c *Commit) GetMessage() string
- func (c *Commit) GetNodeID() string
- func (c *Commit) GetSHA() string
- func (c *Commit) GetStats() *CommitStats
- func (c *Commit) GetTree() *Tree
- func (c *Commit) GetURL() string
- func (c *Commit) GetVerification() *SignatureVerification
- func (c Commit) String() string
- type CommitAuthor
- type CommitCommentEvent
- type CommitFile
- func (c *CommitFile) GetAdditions() int
- func (c *CommitFile) GetBlobURL() string
- func (c *CommitFile) GetChanges() int
- func (c *CommitFile) GetContentsURL() string
- func (c *CommitFile) GetDeletions() int
- func (c *CommitFile) GetFilename() string
- func (c *CommitFile) GetPatch() string
- func (c *CommitFile) GetPreviousFilename() string
- func (c *CommitFile) GetRawURL() string
- func (c *CommitFile) GetSHA() string
- func (c *CommitFile) GetStatus() string
- func (c CommitFile) String() string
- type CommitResult
- func (c *CommitResult) GetAuthor() *User
- func (c *CommitResult) GetCommentsURL() string
- func (c *CommitResult) GetCommit() *Commit
- func (c *CommitResult) GetCommitter() *User
- func (c *CommitResult) GetHTMLURL() string
- func (c *CommitResult) GetRepository() *Repository
- func (c *CommitResult) GetSHA() string
- func (c *CommitResult) GetScore() *float64
- func (c *CommitResult) GetURL() string
- type CommitStats
- type CommitsComparison
- func (c *CommitsComparison) GetAheadBy() int
- func (c *CommitsComparison) GetBaseCommit() *RepositoryCommit
- func (c *CommitsComparison) GetBehindBy() int
- func (c *CommitsComparison) GetDiffURL() string
- func (c *CommitsComparison) GetHTMLURL() string
- func (c *CommitsComparison) GetMergeBaseCommit() *RepositoryCommit
- func (c *CommitsComparison) GetPatchURL() string
- func (c *CommitsComparison) GetPermalinkURL() string
- func (c *CommitsComparison) GetStatus() string
- func (c *CommitsComparison) GetTotalCommits() int
- func (c *CommitsComparison) GetURL() string
- func (c CommitsComparison) String() string
- type CommitsListOptions
- type CommitsSearchResult
- type CommunityHealthFiles
- func (c *CommunityHealthFiles) GetCodeOfConduct() *Metric
- func (c *CommunityHealthFiles) GetCodeOfConductFile() *Metric
- func (c *CommunityHealthFiles) GetContributing() *Metric
- func (c *CommunityHealthFiles) GetIssueTemplate() *Metric
- func (c *CommunityHealthFiles) GetLicense() *Metric
- func (c *CommunityHealthFiles) GetPullRequestTemplate() *Metric
- func (c *CommunityHealthFiles) GetReadme() *Metric
- type CommunityHealthMetrics
- func (c *CommunityHealthMetrics) GetContentReportsEnabled() bool
- func (c *CommunityHealthMetrics) GetDescription() string
- func (c *CommunityHealthMetrics) GetDocumentation() string
- func (c *CommunityHealthMetrics) GetFiles() *CommunityHealthFiles
- func (c *CommunityHealthMetrics) GetHealthPercentage() int
- func (c *CommunityHealthMetrics) GetUpdatedAt() time.Time
- type ContentReference
- type ContentReferenceEvent
- type Contributor
- func (c *Contributor) GetAvatarURL() string
- func (c *Contributor) GetContributions() int
- func (c *Contributor) GetEmail() string
- func (c *Contributor) GetEventsURL() string
- func (c *Contributor) GetFollowersURL() string
- func (c *Contributor) GetFollowingURL() string
- func (c *Contributor) GetGistsURL() string
- func (c *Contributor) GetGravatarID() string
- func (c *Contributor) GetHTMLURL() string
- func (c *Contributor) GetID() int64
- func (c *Contributor) GetLogin() string
- func (c *Contributor) GetName() string
- func (c *Contributor) GetNodeID() string
- func (c *Contributor) GetOrganizationsURL() string
- func (c *Contributor) GetReceivedEventsURL() string
- func (c *Contributor) GetReposURL() string
- func (c *Contributor) GetSiteAdmin() bool
- func (c *Contributor) GetStarredURL() string
- func (c *Contributor) GetSubscriptionsURL() string
- func (c *Contributor) GetType() string
- func (c *Contributor) GetURL() string
- type ContributorStats
- type CreateCheckRunOptions
- func (c *CreateCheckRunOptions) GetCompletedAt() Timestamp
- func (c *CreateCheckRunOptions) GetConclusion() string
- func (c *CreateCheckRunOptions) GetDetailsURL() string
- func (c *CreateCheckRunOptions) GetExternalID() string
- func (c *CreateCheckRunOptions) GetOutput() *CheckRunOutput
- func (c *CreateCheckRunOptions) GetStartedAt() Timestamp
- func (c *CreateCheckRunOptions) GetStatus() string
- type CreateCheckSuiteOptions
- type CreateEvent
- func (c *CreateEvent) GetDescription() string
- func (c *CreateEvent) GetInstallation() *Installation
- func (c *CreateEvent) GetMasterBranch() string
- func (c *CreateEvent) GetPusherType() string
- func (c *CreateEvent) GetRef() string
- func (c *CreateEvent) GetRefType() string
- func (c *CreateEvent) GetRepo() *Repository
- func (c *CreateEvent) GetSender() *User
- type CreateOrgInvitationOptions
- type CreateRunnerGroupRequest
- type CreateUpdateEnvironment
- type CreateUserProjectOptions
- type CreateWorkflowDispatchEventRequest
- type DeleteEvent
- type DependabotService
- func (s *DependabotService) AddSelectedRepoToOrgSecret(ctx context.Context, org, name string, repo *Repository) (*Response, error)
- func (s *DependabotService) CreateOrUpdateOrgSecret(ctx context.Context, org string, eSecret *EncryptedSecret) (*Response, error)
- func (s *DependabotService) CreateOrUpdateRepoSecret(ctx context.Context, owner, repo string, eSecret *EncryptedSecret) (*Response, error)
- func (s *DependabotService) DeleteOrgSecret(ctx context.Context, org, name string) (*Response, error)
- func (s *DependabotService) DeleteRepoSecret(ctx context.Context, owner, repo, name string) (*Response, error)
- func (s *DependabotService) GetOrgPublicKey(ctx context.Context, org string) (*PublicKey, *Response, error)
- func (s *DependabotService) GetOrgSecret(ctx context.Context, org, name string) (*Secret, *Response, error)
- func (s *DependabotService) GetRepoPublicKey(ctx context.Context, owner, repo string) (*PublicKey, *Response, error)
- func (s *DependabotService) GetRepoSecret(ctx context.Context, owner, repo, name string) (*Secret, *Response, error)
- func (s *DependabotService) ListOrgSecrets(ctx context.Context, org string, opts *ListOptions) (*Secrets, *Response, error)
- func (s *DependabotService) ListRepoSecrets(ctx context.Context, owner, repo string, opts *ListOptions) (*Secrets, *Response, error)
- func (s *DependabotService) ListSelectedReposForOrgSecret(ctx context.Context, org, name string, opts *ListOptions) (*SelectedReposList, *Response, error)
- func (s *DependabotService) RemoveSelectedRepoFromOrgSecret(ctx context.Context, org, name string, repo *Repository) (*Response, error)
- func (s *DependabotService) SetSelectedReposForOrgSecret(ctx context.Context, org, name string, ids SelectedRepoIDs) (*Response, error)
- type DeployKeyEvent
- type Deployment
- func (d *Deployment) GetCreatedAt() Timestamp
- func (d *Deployment) GetCreator() *User
- func (d *Deployment) GetDescription() string
- func (d *Deployment) GetEnvironment() string
- func (d *Deployment) GetID() int64
- func (d *Deployment) GetNodeID() string
- func (d *Deployment) GetRef() string
- func (d *Deployment) GetRepositoryURL() string
- func (d *Deployment) GetSHA() string
- func (d *Deployment) GetStatusesURL() string
- func (d *Deployment) GetTask() string
- func (d *Deployment) GetURL() string
- func (d *Deployment) GetUpdatedAt() Timestamp
- type DeploymentEvent
- type DeploymentRequest
- func (d *DeploymentRequest) GetAutoMerge() bool
- func (d *DeploymentRequest) GetDescription() string
- func (d *DeploymentRequest) GetEnvironment() string
- func (d *DeploymentRequest) GetProductionEnvironment() bool
- func (d *DeploymentRequest) GetRef() string
- func (d *DeploymentRequest) GetRequiredContexts() []string
- func (d *DeploymentRequest) GetTask() string
- func (d *DeploymentRequest) GetTransientEnvironment() bool
- type DeploymentStatus
- func (d *DeploymentStatus) GetCreatedAt() Timestamp
- func (d *DeploymentStatus) GetCreator() *User
- func (d *DeploymentStatus) GetDeploymentURL() string
- func (d *DeploymentStatus) GetDescription() string
- func (d *DeploymentStatus) GetEnvironment() string
- func (d *DeploymentStatus) GetEnvironmentURL() string
- func (d *DeploymentStatus) GetID() int64
- func (d *DeploymentStatus) GetLogURL() string
- func (d *DeploymentStatus) GetNodeID() string
- func (d *DeploymentStatus) GetRepositoryURL() string
- func (d *DeploymentStatus) GetState() string
- func (d *DeploymentStatus) GetTargetURL() string
- func (d *DeploymentStatus) GetURL() string
- func (d *DeploymentStatus) GetUpdatedAt() Timestamp
- type DeploymentStatusEvent
- type DeploymentStatusRequest
- func (d *DeploymentStatusRequest) GetAutoInactive() bool
- func (d *DeploymentStatusRequest) GetDescription() string
- func (d *DeploymentStatusRequest) GetEnvironment() string
- func (d *DeploymentStatusRequest) GetEnvironmentURL() string
- func (d *DeploymentStatusRequest) GetLogURL() string
- func (d *DeploymentStatusRequest) GetState() string
- type DeploymentsListOptions
- type Discussion
- func (d *Discussion) GetActiveLockReason() string
- func (d *Discussion) GetAnswerChosenAt() Timestamp
- func (d *Discussion) GetAnswerChosenBy() string
- func (d *Discussion) GetAnswerHTMLURL() string
- func (d *Discussion) GetAuthorAssociation() string
- func (d *Discussion) GetBody() string
- func (d *Discussion) GetComments() int
- func (d *Discussion) GetCreatedAt() Timestamp
- func (d *Discussion) GetDiscussionCategory() *DiscussionCategory
- func (d *Discussion) GetHTMLURL() string
- func (d *Discussion) GetID() int64
- func (d *Discussion) GetLocked() bool
- func (d *Discussion) GetNodeID() string
- func (d *Discussion) GetNumber() int
- func (d *Discussion) GetRepositoryURL() string
- func (d *Discussion) GetState() string
- func (d *Discussion) GetTitle() string
- func (d *Discussion) GetUpdatedAt() Timestamp
- func (d *Discussion) GetUser() *User
- type DiscussionCategory
- func (d *DiscussionCategory) GetCreatedAt() Timestamp
- func (d *DiscussionCategory) GetDescription() string
- func (d *DiscussionCategory) GetEmoji() string
- func (d *DiscussionCategory) GetID() int64
- func (d *DiscussionCategory) GetIsAnswerable() bool
- func (d *DiscussionCategory) GetName() string
- func (d *DiscussionCategory) GetNodeID() string
- func (d *DiscussionCategory) GetRepositoryID() int64
- func (d *DiscussionCategory) GetSlug() string
- func (d *DiscussionCategory) GetUpdatedAt() Timestamp
- type DiscussionComment
- func (d *DiscussionComment) GetAuthor() *User
- func (d *DiscussionComment) GetBody() string
- func (d *DiscussionComment) GetBodyHTML() string
- func (d *DiscussionComment) GetBodyVersion() string
- func (d *DiscussionComment) GetCreatedAt() Timestamp
- func (d *DiscussionComment) GetDiscussionURL() string
- func (d *DiscussionComment) GetHTMLURL() string
- func (d *DiscussionComment) GetLastEditedAt() Timestamp
- func (d *DiscussionComment) GetNodeID() string
- func (d *DiscussionComment) GetNumber() int
- func (d *DiscussionComment) GetReactions() *Reactions
- func (d *DiscussionComment) GetURL() string
- func (d *DiscussionComment) GetUpdatedAt() Timestamp
- func (c DiscussionComment) String() string
- type DiscussionCommentListOptions
- type DiscussionEvent
- type DiscussionListOptions
- type DismissalRestrictions
- type DismissalRestrictionsRequest
- type DismissedReview
- type DispatchRequestOptions
- type DraftReviewComment
- func (d *DraftReviewComment) GetBody() string
- func (d *DraftReviewComment) GetLine() int
- func (d *DraftReviewComment) GetPath() string
- func (d *DraftReviewComment) GetPosition() int
- func (d *DraftReviewComment) GetSide() string
- func (d *DraftReviewComment) GetStartLine() int
- func (d *DraftReviewComment) GetStartSide() string
- func (c DraftReviewComment) String() string
- type EditBase
- type EditBody
- type EditChange
- type EditRef
- type EditRepo
- type EditSHA
- type EditTitle
- type EncryptedSecret
- type Enterprise
- func (e *Enterprise) GetAvatarURL() string
- func (e *Enterprise) GetCreatedAt() Timestamp
- func (e *Enterprise) GetDescription() string
- func (e *Enterprise) GetHTMLURL() string
- func (e *Enterprise) GetID() int
- func (e *Enterprise) GetName() string
- func (e *Enterprise) GetNodeID() string
- func (e *Enterprise) GetSlug() string
- func (e *Enterprise) GetUpdatedAt() Timestamp
- func (e *Enterprise) GetWebsiteURL() string
- func (m Enterprise) String() string
- type EnterpriseService
- func (s *EnterpriseService) CreateRegistrationToken(ctx context.Context, enterprise string) (*RegistrationToken, *Response, error)
- func (s *EnterpriseService) GetAuditLog(ctx context.Context, enterprise string, opts *GetAuditLogOptions) ([]*AuditEntry, *Response, error)
- func (s *EnterpriseService) ListRunners(ctx context.Context, enterprise string, opts *ListOptions) (*Runners, *Response, error)
- func (s *EnterpriseService) RemoveRunner(ctx context.Context, enterprise string, runnerID int64) (*Response, error)
- type EnvResponse
- type EnvReviewers
- type Environment
- func (e *Environment) GetCreatedAt() Timestamp
- func (e *Environment) GetDeploymentBranchPolicy() *BranchPolicy
- func (e *Environment) GetEnvironmentName() string
- func (e *Environment) GetHTMLURL() string
- func (e *Environment) GetID() int64
- func (e *Environment) GetName() string
- func (e *Environment) GetNodeID() string
- func (e *Environment) GetOwner() string
- func (e *Environment) GetRepo() string
- func (e *Environment) GetURL() string
- func (e *Environment) GetUpdatedAt() Timestamp
- func (e *Environment) GetWaitTimer() int
- type EnvironmentListOptions
- type Error
- type ErrorBlock
- type ErrorResponse
- type Event
- func (e *Event) GetActor() *User
- func (e *Event) GetCreatedAt() time.Time
- func (e *Event) GetID() string
- func (e *Event) GetOrg() *Organization
- func (e *Event) GetPublic() bool
- func (e *Event) GetRawPayload() json.RawMessage
- func (e *Event) GetRepo() *Repository
- func (e *Event) GetType() string
- func (e *Event) ParsePayload() (payload interface{}, err error)
- func (e *Event) Payload() (payload interface{})deprecated
- func (e Event) String() string
- type ExternalGroup
- type ExternalGroupList
- type ExternalGroupMember
- type ExternalGroupTeam
- type FeedLink
- type FeedLinks
- type Feeds
- func (f *Feeds) GetCurrentUserActorURL() string
- func (f *Feeds) GetCurrentUserOrganizationURL() string
- func (f *Feeds) GetCurrentUserPublicURL() string
- func (f *Feeds) GetCurrentUserURL() string
- func (f *Feeds) GetLinks() *FeedLinks
- func (f *Feeds) GetTimelineURL() string
- func (f *Feeds) GetUserURL() string
- type ForkEvent
- type GPGEmail
- type GPGKey
- func (g *GPGKey) GetCanCertify() bool
- func (g *GPGKey) GetCanEncryptComms() bool
- func (g *GPGKey) GetCanEncryptStorage() bool
- func (g *GPGKey) GetCanSign() bool
- func (g *GPGKey) GetCreatedAt() time.Time
- func (g *GPGKey) GetExpiresAt() time.Time
- func (g *GPGKey) GetID() int64
- func (g *GPGKey) GetKeyID() string
- func (g *GPGKey) GetPrimaryKeyID() int64
- func (g *GPGKey) GetPublicKey() string
- func (g *GPGKey) GetRawKey() string
- func (k GPGKey) String() string
- type GenerateNotesOptions
- type GetAuditLogOptions
- type Gist
- func (g *Gist) GetComments() int
- func (g *Gist) GetCreatedAt() time.Time
- func (g *Gist) GetDescription() string
- func (g *Gist) GetFiles() map[GistFilename]GistFile
- func (g *Gist) GetGitPullURL() string
- func (g *Gist) GetGitPushURL() string
- func (g *Gist) GetHTMLURL() string
- func (g *Gist) GetID() string
- func (g *Gist) GetNodeID() string
- func (g *Gist) GetOwner() *User
- func (g *Gist) GetPublic() bool
- func (g *Gist) GetUpdatedAt() time.Time
- func (g Gist) String() string
- type GistComment
- type GistCommit
- type GistFile
- type GistFilename
- type GistFork
- type GistListOptions
- type GistStats
- type GistsService
- func (s *GistsService) Create(ctx context.Context, gist *Gist) (*Gist, *Response, error)
- func (s *GistsService) CreateComment(ctx context.Context, gistID string, comment *GistComment) (*GistComment, *Response, error)
- func (s *GistsService) Delete(ctx context.Context, id string) (*Response, error)
- func (s *GistsService) DeleteComment(ctx context.Context, gistID string, commentID int64) (*Response, error)
- func (s *GistsService) Edit(ctx context.Context, id string, gist *Gist) (*Gist, *Response, error)
- func (s *GistsService) EditComment(ctx context.Context, gistID string, commentID int64, comment *GistComment) (*GistComment, *Response, error)
- func (s *GistsService) Fork(ctx context.Context, id string) (*Gist, *Response, error)
- func (s *GistsService) Get(ctx context.Context, id string) (*Gist, *Response, error)
- func (s *GistsService) GetComment(ctx context.Context, gistID string, commentID int64) (*GistComment, *Response, error)
- func (s *GistsService) GetRevision(ctx context.Context, id, sha string) (*Gist, *Response, error)
- func (s *GistsService) IsStarred(ctx context.Context, id string) (bool, *Response, error)
- func (s *GistsService) List(ctx context.Context, user string, opts *GistListOptions) ([]*Gist, *Response, error)
- func (s *GistsService) ListAll(ctx context.Context, opts *GistListOptions) ([]*Gist, *Response, error)
- func (s *GistsService) ListComments(ctx context.Context, gistID string, opts *ListOptions) ([]*GistComment, *Response, error)
- func (s *GistsService) ListCommits(ctx context.Context, id string, opts *ListOptions) ([]*GistCommit, *Response, error)
- func (s *GistsService) ListForks(ctx context.Context, id string, opts *ListOptions) ([]*GistFork, *Response, error)
- func (s *GistsService) ListStarred(ctx context.Context, opts *GistListOptions) ([]*Gist, *Response, error)
- func (s *GistsService) Star(ctx context.Context, id string) (*Response, error)
- func (s *GistsService) Unstar(ctx context.Context, id string) (*Response, error)
- type GitHubAppAuthorizationEvent
- type GitObject
- type GitService
- func (s *GitService) CreateBlob(ctx context.Context, owner string, repo string, blob *Blob) (*Blob, *Response, error)
- func (s *GitService) CreateCommit(ctx context.Context, owner string, repo string, commit *Commit) (*Commit, *Response, error)
- func (s *GitService) CreateRef(ctx context.Context, owner string, repo string, ref *Reference) (*Reference, *Response, error)
- func (s *GitService) CreateTag(ctx context.Context, owner string, repo string, tag *Tag) (*Tag, *Response, error)
- func (s *GitService) CreateTree(ctx context.Context, owner string, repo string, baseTree string, ...) (*Tree, *Response, error)
- func (s *GitService) DeleteRef(ctx context.Context, owner string, repo string, ref string) (*Response, error)
- func (s *GitService) GetBlob(ctx context.Context, owner string, repo string, sha string) (*Blob, *Response, error)
- func (s *GitService) GetBlobRaw(ctx context.Context, owner, repo, sha string) ([]byte, *Response, error)
- func (s *GitService) GetCommit(ctx context.Context, owner string, repo string, sha string) (*Commit, *Response, error)
- func (s *GitService) GetRef(ctx context.Context, owner string, repo string, ref string) (*Reference, *Response, error)
- func (s *GitService) GetTag(ctx context.Context, owner string, repo string, sha string) (*Tag, *Response, error)
- func (s *GitService) GetTree(ctx context.Context, owner string, repo string, sha string, recursive bool) (*Tree, *Response, error)
- func (s *GitService) ListMatchingRefs(ctx context.Context, owner, repo string, opts *ReferenceListOptions) ([]*Reference, *Response, error)
- func (s *GitService) UpdateRef(ctx context.Context, owner string, repo string, ref *Reference, force bool) (*Reference, *Response, error)
- type Gitignore
- type GitignoresService
- type GollumEvent
- type Grant
- type HeadCommit
- func (h *HeadCommit) GetAuthor() *CommitAuthor
- func (h *HeadCommit) GetCommitter() *CommitAuthor
- func (h *HeadCommit) GetDistinct() bool
- func (h *HeadCommit) GetID() string
- func (h *HeadCommit) GetMessage() string
- func (h *HeadCommit) GetSHA() string
- func (h *HeadCommit) GetTimestamp() Timestamp
- func (h *HeadCommit) GetTreeID() string
- func (h *HeadCommit) GetURL() string
- func (p HeadCommit) String() string
- type Hook
- func (h *Hook) GetActive() bool
- func (h *Hook) GetCreatedAt() time.Time
- func (h *Hook) GetID() int64
- func (h *Hook) GetName() string
- func (h *Hook) GetPingURL() string
- func (h *Hook) GetTestURL() string
- func (h *Hook) GetType() string
- func (h *Hook) GetURL() string
- func (h *Hook) GetUpdatedAt() time.Time
- func (h Hook) String() string
- type HookConfig
- type HookDelivery
- func (h *HookDelivery) GetAction() string
- func (h *HookDelivery) GetDeliveredAt() Timestamp
- func (h *HookDelivery) GetDuration() *float64
- func (h *HookDelivery) GetEvent() string
- func (h *HookDelivery) GetGUID() string
- func (h *HookDelivery) GetID() int64
- func (h *HookDelivery) GetInstallationID() int64
- func (h *HookDelivery) GetRedelivery() bool
- func (h *HookDelivery) GetRepositoryID() int64
- func (h *HookDelivery) GetRequest() *HookRequest
- func (h *HookDelivery) GetResponse() *HookResponse
- func (h *HookDelivery) GetStatus() string
- func (h *HookDelivery) GetStatusCode() int
- func (d *HookDelivery) ParseRequestPayload() (interface{}, error)
- func (d HookDelivery) String() string
- type HookRequest
- type HookResponse
- type HookStats
- type Hovercard
- type HovercardOptions
- type IDPGroup
- type IDPGroupList
- type ImpersonateUserOptions
- type Import
- func (i *Import) GetAuthorsCount() int
- func (i *Import) GetAuthorsURL() string
- func (i *Import) GetCommitCount() int
- func (i *Import) GetFailedStep() string
- func (i *Import) GetHTMLURL() string
- func (i *Import) GetHasLargeFiles() bool
- func (i *Import) GetHumanName() string
- func (i *Import) GetLargeFilesCount() int
- func (i *Import) GetLargeFilesSize() int
- func (i *Import) GetMessage() string
- func (i *Import) GetPercent() int
- func (i *Import) GetPushPercent() int
- func (i *Import) GetRepositoryURL() string
- func (i *Import) GetStatus() string
- func (i *Import) GetStatusText() string
- func (i *Import) GetTFVCProject() string
- func (i *Import) GetURL() string
- func (i *Import) GetUseLFS() string
- func (i *Import) GetVCS() string
- func (i *Import) GetVCSPassword() string
- func (i *Import) GetVCSURL() string
- func (i *Import) GetVCSUsername() string
- func (i Import) String() string
- type Installation
- func (i *Installation) GetAccessTokensURL() string
- func (i *Installation) GetAccount() *User
- func (i *Installation) GetAppID() int64
- func (i *Installation) GetAppSlug() string
- func (i *Installation) GetCreatedAt() Timestamp
- func (i *Installation) GetHTMLURL() string
- func (i *Installation) GetHasMultipleSingleFiles() bool
- func (i *Installation) GetID() int64
- func (i *Installation) GetNodeID() string
- func (i *Installation) GetPermissions() *InstallationPermissions
- func (i *Installation) GetRepositoriesURL() string
- func (i *Installation) GetRepositorySelection() string
- func (i *Installation) GetSingleFileName() string
- func (i *Installation) GetSuspendedAt() Timestamp
- func (i *Installation) GetSuspendedBy() *User
- func (i *Installation) GetTargetID() int64
- func (i *Installation) GetTargetType() string
- func (i *Installation) GetUpdatedAt() Timestamp
- func (i Installation) String() string
- type InstallationEvent
- type InstallationPermissions
- func (i *InstallationPermissions) GetActions() string
- func (i *InstallationPermissions) GetAdministration() string
- func (i *InstallationPermissions) GetBlocking() string
- func (i *InstallationPermissions) GetChecks() string
- func (i *InstallationPermissions) GetContentReferences() string
- func (i *InstallationPermissions) GetContents() string
- func (i *InstallationPermissions) GetDeployments() string
- func (i *InstallationPermissions) GetEmails() string
- func (i *InstallationPermissions) GetEnvironments() string
- func (i *InstallationPermissions) GetFollowers() string
- func (i *InstallationPermissions) GetIssues() string
- func (i *InstallationPermissions) GetMembers() string
- func (i *InstallationPermissions) GetMetadata() string
- func (i *InstallationPermissions) GetOrganizationAdministration() string
- func (i *InstallationPermissions) GetOrganizationHooks() string
- func (i *InstallationPermissions) GetOrganizationPlan() string
- func (i *InstallationPermissions) GetOrganizationPreReceiveHooks() string
- func (i *InstallationPermissions) GetOrganizationProjects() string
- func (i *InstallationPermissions) GetOrganizationSecrets() string
- func (i *InstallationPermissions) GetOrganizationSelfHostedRunners() string
- func (i *InstallationPermissions) GetOrganizationUserBlocking() string
- func (i *InstallationPermissions) GetPackages() string
- func (i *InstallationPermissions) GetPages() string
- func (i *InstallationPermissions) GetPullRequests() string
- func (i *InstallationPermissions) GetRepositoryHooks() string
- func (i *InstallationPermissions) GetRepositoryPreReceiveHooks() string
- func (i *InstallationPermissions) GetRepositoryProjects() string
- func (i *InstallationPermissions) GetSecretScanningAlerts() string
- func (i *InstallationPermissions) GetSecrets() string
- func (i *InstallationPermissions) GetSecurityEvents() string
- func (i *InstallationPermissions) GetSingleFile() string
- func (i *InstallationPermissions) GetStatuses() string
- func (i *InstallationPermissions) GetTeamDiscussions() string
- func (i *InstallationPermissions) GetVulnerabilityAlerts() string
- func (i *InstallationPermissions) GetWorkflows() string
- type InstallationRepositoriesEvent
- type InstallationToken
- type InstallationTokenOptions
- type InteractionRestriction
- type InteractionsService
- func (s *InteractionsService) GetRestrictionsForOrg(ctx context.Context, organization string) (*InteractionRestriction, *Response, error)
- func (s *InteractionsService) GetRestrictionsForRepo(ctx context.Context, owner, repo string) (*InteractionRestriction, *Response, error)
- func (s *InteractionsService) RemoveRestrictionsFromOrg(ctx context.Context, organization string) (*Response, error)
- func (s *InteractionsService) RemoveRestrictionsFromRepo(ctx context.Context, owner, repo string) (*Response, error)
- func (s *InteractionsService) UpdateRestrictionsForOrg(ctx context.Context, organization, limit string) (*InteractionRestriction, *Response, error)
- func (s *InteractionsService) UpdateRestrictionsForRepo(ctx context.Context, owner, repo, limit string) (*InteractionRestriction, *Response, error)
- type Invitation
- func (i *Invitation) GetCreatedAt() time.Time
- func (i *Invitation) GetEmail() string
- func (i *Invitation) GetFailedAt() Timestamp
- func (i *Invitation) GetFailedReason() string
- func (i *Invitation) GetID() int64
- func (i *Invitation) GetInvitationTeamURL() string
- func (i *Invitation) GetInviter() *User
- func (i *Invitation) GetLogin() string
- func (i *Invitation) GetNodeID() string
- func (i *Invitation) GetRole() string
- func (i *Invitation) GetTeamCount() int
- func (i Invitation) String() string
- type Issue
- func (i *Issue) GetActiveLockReason() string
- func (i *Issue) GetAssignee() *User
- func (i *Issue) GetAuthorAssociation() string
- func (i *Issue) GetBody() string
- func (i *Issue) GetClosedAt() time.Time
- func (i *Issue) GetClosedBy() *User
- func (i *Issue) GetComments() int
- func (i *Issue) GetCommentsURL() string
- func (i *Issue) GetCreatedAt() time.Time
- func (i *Issue) GetEventsURL() string
- func (i *Issue) GetHTMLURL() string
- func (i *Issue) GetID() int64
- func (i *Issue) GetLabelsURL() string
- func (i *Issue) GetLocked() bool
- func (i *Issue) GetMilestone() *Milestone
- func (i *Issue) GetNodeID() string
- func (i *Issue) GetNumber() int
- func (i *Issue) GetPullRequestLinks() *PullRequestLinks
- func (i *Issue) GetReactions() *Reactions
- func (i *Issue) GetRepository() *Repository
- func (i *Issue) GetRepositoryURL() string
- func (i *Issue) GetState() string
- func (i *Issue) GetTitle() string
- func (i *Issue) GetURL() string
- func (i *Issue) GetUpdatedAt() time.Time
- func (i *Issue) GetUser() *User
- func (i Issue) IsPullRequest() bool
- func (i Issue) String() string
- type IssueComment
- func (i *IssueComment) GetAuthorAssociation() string
- func (i *IssueComment) GetBody() string
- func (i *IssueComment) GetCreatedAt() time.Time
- func (i *IssueComment) GetHTMLURL() string
- func (i *IssueComment) GetID() int64
- func (i *IssueComment) GetIssueURL() string
- func (i *IssueComment) GetNodeID() string
- func (i *IssueComment) GetReactions() *Reactions
- func (i *IssueComment) GetURL() string
- func (i *IssueComment) GetUpdatedAt() time.Time
- func (i *IssueComment) GetUser() *User
- func (i IssueComment) String() string
- type IssueCommentEvent
- func (i *IssueCommentEvent) GetAction() string
- func (i *IssueCommentEvent) GetChanges() *EditChange
- func (i *IssueCommentEvent) GetComment() *IssueComment
- func (i *IssueCommentEvent) GetInstallation() *Installation
- func (i *IssueCommentEvent) GetIssue() *Issue
- func (i *IssueCommentEvent) GetOrganization() *Organization
- func (i *IssueCommentEvent) GetRepo() *Repository
- func (i *IssueCommentEvent) GetSender() *User
- type IssueEvent
- func (i *IssueEvent) GetActor() *User
- func (i *IssueEvent) GetAssignee() *User
- func (i *IssueEvent) GetAssigner() *User
- func (i *IssueEvent) GetCommitID() string
- func (i *IssueEvent) GetCreatedAt() time.Time
- func (i *IssueEvent) GetDismissedReview() *DismissedReview
- func (i *IssueEvent) GetEvent() string
- func (i *IssueEvent) GetID() int64
- func (i *IssueEvent) GetIssue() *Issue
- func (i *IssueEvent) GetLabel() *Label
- func (i *IssueEvent) GetLockReason() string
- func (i *IssueEvent) GetMilestone() *Milestone
- func (i *IssueEvent) GetProjectCard() *ProjectCard
- func (i *IssueEvent) GetRename() *Rename
- func (i *IssueEvent) GetRequestedReviewer() *User
- func (i *IssueEvent) GetReviewRequester() *User
- func (i *IssueEvent) GetURL() string
- type IssueImport
- type IssueImportError
- type IssueImportRequest
- type IssueImportResponse
- func (i *IssueImportResponse) GetCreatedAt() time.Time
- func (i *IssueImportResponse) GetDocumentationURL() string
- func (i *IssueImportResponse) GetID() int
- func (i *IssueImportResponse) GetImportIssuesURL() string
- func (i *IssueImportResponse) GetMessage() string
- func (i *IssueImportResponse) GetRepositoryURL() string
- func (i *IssueImportResponse) GetStatus() string
- func (i *IssueImportResponse) GetURL() string
- func (i *IssueImportResponse) GetUpdatedAt() time.Time
- type IssueImportService
- func (s *IssueImportService) CheckStatus(ctx context.Context, owner, repo string, issueID int64) (*IssueImportResponse, *Response, error)
- func (s *IssueImportService) CheckStatusSince(ctx context.Context, owner, repo string, since time.Time) ([]*IssueImportResponse, *Response, error)
- func (s *IssueImportService) Create(ctx context.Context, owner, repo string, issue *IssueImportRequest) (*IssueImportResponse, *Response, error)
- type IssueListByRepoOptions
- type IssueListCommentsOptions
- type IssueListOptions
- type IssueRequest
- type IssueStats
- type IssuesEvent
- func (i *IssuesEvent) GetAction() string
- func (i *IssuesEvent) GetAssignee() *User
- func (i *IssuesEvent) GetChanges() *EditChange
- func (i *IssuesEvent) GetInstallation() *Installation
- func (i *IssuesEvent) GetIssue() *Issue
- func (i *IssuesEvent) GetLabel() *Label
- func (i *IssuesEvent) GetRepo() *Repository
- func (i *IssuesEvent) GetSender() *User
- type IssuesSearchResult
- type IssuesService
- func (s *IssuesService) AddAssignees(ctx context.Context, owner, repo string, number int, assignees []string) (*Issue, *Response, error)
- func (s *IssuesService) AddLabelsToIssue(ctx context.Context, owner string, repo string, number int, labels []string) ([]*Label, *Response, error)
- func (s *IssuesService) Create(ctx context.Context, owner string, repo string, issue *IssueRequest) (*Issue, *Response, error)
- func (s *IssuesService) CreateComment(ctx context.Context, owner string, repo string, number int, ...) (*IssueComment, *Response, error)
- func (s *IssuesService) CreateLabel(ctx context.Context, owner string, repo string, label *Label) (*Label, *Response, error)
- func (s *IssuesService) CreateMilestone(ctx context.Context, owner string, repo string, milestone *Milestone) (*Milestone, *Response, error)
- func (s *IssuesService) DeleteComment(ctx context.Context, owner string, repo string, commentID int64) (*Response, error)
- func (s *IssuesService) DeleteLabel(ctx context.Context, owner string, repo string, name string) (*Response, error)
- func (s *IssuesService) DeleteMilestone(ctx context.Context, owner string, repo string, number int) (*Response, error)
- func (s *IssuesService) Edit(ctx context.Context, owner string, repo string, number int, ...) (*Issue, *Response, error)
- func (s *IssuesService) EditComment(ctx context.Context, owner string, repo string, commentID int64, ...) (*IssueComment, *Response, error)
- func (s *IssuesService) EditLabel(ctx context.Context, owner string, repo string, name string, label *Label) (*Label, *Response, error)
- func (s *IssuesService) EditMilestone(ctx context.Context, owner string, repo string, number int, ...) (*Milestone, *Response, error)
- func (s *IssuesService) Get(ctx context.Context, owner string, repo string, number int) (*Issue, *Response, error)
- func (s *IssuesService) GetComment(ctx context.Context, owner string, repo string, commentID int64) (*IssueComment, *Response, error)
- func (s *IssuesService) GetEvent(ctx context.Context, owner, repo string, id int64) (*IssueEvent, *Response, error)
- func (s *IssuesService) GetLabel(ctx context.Context, owner string, repo string, name string) (*Label, *Response, error)
- func (s *IssuesService) GetMilestone(ctx context.Context, owner string, repo string, number int) (*Milestone, *Response, error)
- func (s *IssuesService) IsAssignee(ctx context.Context, owner, repo, user string) (bool, *Response, error)
- func (s *IssuesService) List(ctx context.Context, all bool, opts *IssueListOptions) ([]*Issue, *Response, error)
- func (s *IssuesService) ListAssignees(ctx context.Context, owner, repo string, opts *ListOptions) ([]*User, *Response, error)
- func (s *IssuesService) ListByOrg(ctx context.Context, org string, opts *IssueListOptions) ([]*Issue, *Response, error)
- func (s *IssuesService) ListByRepo(ctx context.Context, owner string, repo string, opts *IssueListByRepoOptions) ([]*Issue, *Response, error)
- func (s *IssuesService) ListComments(ctx context.Context, owner string, repo string, number int, ...) ([]*IssueComment, *Response, error)
- func (s *IssuesService) ListIssueEvents(ctx context.Context, owner, repo string, number int, opts *ListOptions) ([]*IssueEvent, *Response, error)
- func (s *IssuesService) ListIssueTimeline(ctx context.Context, owner, repo string, number int, opts *ListOptions) ([]*Timeline, *Response, error)
- func (s *IssuesService) ListLabels(ctx context.Context, owner string, repo string, opts *ListOptions) ([]*Label, *Response, error)
- func (s *IssuesService) ListLabelsByIssue(ctx context.Context, owner string, repo string, number int, opts *ListOptions) ([]*Label, *Response, error)
- func (s *IssuesService) ListLabelsForMilestone(ctx context.Context, owner string, repo string, number int, opts *ListOptions) ([]*Label, *Response, error)
- func (s *IssuesService) ListMilestones(ctx context.Context, owner string, repo string, opts *MilestoneListOptions) ([]*Milestone, *Response, error)
- func (s *IssuesService) ListRepositoryEvents(ctx context.Context, owner, repo string, opts *ListOptions) ([]*IssueEvent, *Response, error)
- func (s *IssuesService) Lock(ctx context.Context, owner string, repo string, number int, ...) (*Response, error)
- func (s *IssuesService) RemoveAssignees(ctx context.Context, owner, repo string, number int, assignees []string) (*Issue, *Response, error)
- func (s *IssuesService) RemoveLabelForIssue(ctx context.Context, owner string, repo string, number int, label string) (*Response, error)
- func (s *IssuesService) RemoveLabelsForIssue(ctx context.Context, owner string, repo string, number int) (*Response, error)
- func (s *IssuesService) RemoveMilestone(ctx context.Context, owner, repo string, issueNumber int) (*Issue, *Response, error)
- func (s *IssuesService) ReplaceLabelsForIssue(ctx context.Context, owner string, repo string, number int, labels []string) ([]*Label, *Response, error)
- func (s *IssuesService) Unlock(ctx context.Context, owner string, repo string, number int) (*Response, error)
- type Jobs
- type Key
- type Label
- type LabelEvent
- type LabelResult
- func (l *LabelResult) GetColor() string
- func (l *LabelResult) GetDefault() bool
- func (l *LabelResult) GetDescription() string
- func (l *LabelResult) GetID() int64
- func (l *LabelResult) GetName() string
- func (l *LabelResult) GetScore() *float64
- func (l *LabelResult) GetURL() string
- func (l LabelResult) String() string
- type LabelsSearchResult
- type LargeFile
- type License
- func (l *License) GetBody() string
- func (l *License) GetConditions() []string
- func (l *License) GetDescription() string
- func (l *License) GetFeatured() bool
- func (l *License) GetHTMLURL() string
- func (l *License) GetImplementation() string
- func (l *License) GetKey() string
- func (l *License) GetLimitations() []string
- func (l *License) GetName() string
- func (l *License) GetPermissions() []string
- func (l *License) GetSPDXID() string
- func (l *License) GetURL() string
- func (l License) String() string
- type LicensesService
- type ListCheckRunsOptions
- type ListCheckRunsResults
- type ListCheckSuiteOptions
- type ListCheckSuiteResults
- type ListCollaboratorOptions
- type ListCollaboratorsOptions
- type ListCommentReactionOptions
- type ListContributorsOptions
- type ListCursorOptions
- type ListExternalGroupsOptions
- type ListMembersOptions
- type ListOptions
- type ListOrgMembershipsOptions
- type ListOutsideCollaboratorsOptions
- type ListRepositories
- type ListSCIMProvisionedIdentitiesOptions
- type ListWorkflowJobsOptions
- type ListWorkflowRunsOptions
- type Location
- type LockIssueOptions
- type MarkdownOptions
- type MarketplacePendingChange
- type MarketplacePlan
- func (m *MarketplacePlan) GetAccountsURL() string
- func (m *MarketplacePlan) GetBullets() []string
- func (m *MarketplacePlan) GetDescription() string
- func (m *MarketplacePlan) GetHasFreeTrial() bool
- func (m *MarketplacePlan) GetID() int64
- func (m *MarketplacePlan) GetMonthlyPriceInCents() int
- func (m *MarketplacePlan) GetName() string
- func (m *MarketplacePlan) GetNumber() int
- func (m *MarketplacePlan) GetPriceModel() string
- func (m *MarketplacePlan) GetState() string
- func (m *MarketplacePlan) GetURL() string
- func (m *MarketplacePlan) GetUnitName() string
- func (m *MarketplacePlan) GetYearlyPriceInCents() int
- type MarketplacePlanAccount
- func (m *MarketplacePlanAccount) GetID() int64
- func (m *MarketplacePlanAccount) GetLogin() string
- func (m *MarketplacePlanAccount) GetMarketplacePendingChange() *MarketplacePendingChange
- func (m *MarketplacePlanAccount) GetMarketplacePurchase() *MarketplacePurchase
- func (m *MarketplacePlanAccount) GetOrganizationBillingEmail() string
- func (m *MarketplacePlanAccount) GetType() string
- func (m *MarketplacePlanAccount) GetURL() string
- type MarketplacePurchase
- func (m *MarketplacePurchase) GetBillingCycle() string
- func (m *MarketplacePurchase) GetFreeTrialEndsOn() Timestamp
- func (m *MarketplacePurchase) GetNextBillingDate() Timestamp
- func (m *MarketplacePurchase) GetOnFreeTrial() bool
- func (m *MarketplacePurchase) GetPlan() *MarketplacePlan
- func (m *MarketplacePurchase) GetUnitCount() int
- func (m *MarketplacePurchase) GetUpdatedAt() Timestamp
- type MarketplacePurchaseEvent
- func (m *MarketplacePurchaseEvent) GetAction() string
- func (m *MarketplacePurchaseEvent) GetEffectiveDate() Timestamp
- func (m *MarketplacePurchaseEvent) GetInstallation() *Installation
- func (m *MarketplacePurchaseEvent) GetMarketplacePurchase() *MarketplacePurchase
- func (m *MarketplacePurchaseEvent) GetPreviousMarketplacePurchase() *MarketplacePurchase
- func (m *MarketplacePurchaseEvent) GetSender() *User
- type MarketplaceService
- func (s *MarketplaceService) GetPlanAccountForAccount(ctx context.Context, accountID int64) (*MarketplacePlanAccount, *Response, error)
- func (s *MarketplaceService) ListMarketplacePurchasesForUser(ctx context.Context, opts *ListOptions) ([]*MarketplacePurchase, *Response, error)
- func (s *MarketplaceService) ListPlanAccountsForPlan(ctx context.Context, planID int64, opts *ListOptions) ([]*MarketplacePlanAccount, *Response, error)
- func (s *MarketplaceService) ListPlans(ctx context.Context, opts *ListOptions) ([]*MarketplacePlan, *Response, error)
- type Match
- type MemberEvent
- type Membership
- type MembershipEvent
- func (m *MembershipEvent) GetAction() string
- func (m *MembershipEvent) GetInstallation() *Installation
- func (m *MembershipEvent) GetMember() *User
- func (m *MembershipEvent) GetOrg() *Organization
- func (m *MembershipEvent) GetScope() string
- func (m *MembershipEvent) GetSender() *User
- func (m *MembershipEvent) GetTeam() *Team
- type Message
- type MetaEvent
- type Metric
- type Migration
- func (m *Migration) GetCreatedAt() string
- func (m *Migration) GetExcludeAttachments() bool
- func (m *Migration) GetGUID() string
- func (m *Migration) GetID() int64
- func (m *Migration) GetLockRepositories() bool
- func (m *Migration) GetState() string
- func (m *Migration) GetURL() string
- func (m *Migration) GetUpdatedAt() string
- func (m Migration) String() string
- type MigrationOptions
- type MigrationService
- func (s *MigrationService) CancelImport(ctx context.Context, owner, repo string) (*Response, error)
- func (s *MigrationService) CommitAuthors(ctx context.Context, owner, repo string) ([]*SourceImportAuthor, *Response, error)
- func (s *MigrationService) DeleteMigration(ctx context.Context, org string, id int64) (*Response, error)
- func (s *MigrationService) DeleteUserMigration(ctx context.Context, id int64) (*Response, error)
- func (s *MigrationService) ImportProgress(ctx context.Context, owner, repo string) (*Import, *Response, error)
- func (s *MigrationService) LargeFiles(ctx context.Context, owner, repo string) ([]*LargeFile, *Response, error)
- func (s *MigrationService) ListMigrations(ctx context.Context, org string, opts *ListOptions) ([]*Migration, *Response, error)
- func (s *MigrationService) ListUserMigrations(ctx context.Context) ([]*UserMigration, *Response, error)
- func (s *MigrationService) MapCommitAuthor(ctx context.Context, owner, repo string, id int64, author *SourceImportAuthor) (*SourceImportAuthor, *Response, error)
- func (s *MigrationService) MigrationArchiveURL(ctx context.Context, org string, id int64) (url string, err error)
- func (s *MigrationService) MigrationStatus(ctx context.Context, org string, id int64) (*Migration, *Response, error)
- func (s *MigrationService) SetLFSPreference(ctx context.Context, owner, repo string, in *Import) (*Import, *Response, error)
- func (s *MigrationService) StartImport(ctx context.Context, owner, repo string, in *Import) (*Import, *Response, error)
- func (s *MigrationService) StartMigration(ctx context.Context, org string, repos []string, opts *MigrationOptions) (*Migration, *Response, error)
- func (s *MigrationService) StartUserMigration(ctx context.Context, repos []string, opts *UserMigrationOptions) (*UserMigration, *Response, error)
- func (s *MigrationService) UnlockRepo(ctx context.Context, org string, id int64, repo string) (*Response, error)
- func (s *MigrationService) UnlockUserRepo(ctx context.Context, id int64, repo string) (*Response, error)
- func (s *MigrationService) UpdateImport(ctx context.Context, owner, repo string, in *Import) (*Import, *Response, error)
- func (s *MigrationService) UserMigrationArchiveURL(ctx context.Context, id int64) (string, error)
- func (s *MigrationService) UserMigrationStatus(ctx context.Context, id int64) (*UserMigration, *Response, error)
- type Milestone
- func (m *Milestone) GetClosedAt() time.Time
- func (m *Milestone) GetClosedIssues() int
- func (m *Milestone) GetCreatedAt() time.Time
- func (m *Milestone) GetCreator() *User
- func (m *Milestone) GetDescription() string
- func (m *Milestone) GetDueOn() time.Time
- func (m *Milestone) GetHTMLURL() string
- func (m *Milestone) GetID() int64
- func (m *Milestone) GetLabelsURL() string
- func (m *Milestone) GetNodeID() string
- func (m *Milestone) GetNumber() int
- func (m *Milestone) GetOpenIssues() int
- func (m *Milestone) GetState() string
- func (m *Milestone) GetTitle() string
- func (m *Milestone) GetURL() string
- func (m *Milestone) GetUpdatedAt() time.Time
- func (m Milestone) String() string
- type MilestoneEvent
- func (m *MilestoneEvent) GetAction() string
- func (m *MilestoneEvent) GetChanges() *EditChange
- func (m *MilestoneEvent) GetInstallation() *Installation
- func (m *MilestoneEvent) GetMilestone() *Milestone
- func (m *MilestoneEvent) GetOrg() *Organization
- func (m *MilestoneEvent) GetRepo() *Repository
- func (m *MilestoneEvent) GetSender() *User
- type MilestoneListOptions
- type MilestoneStats
- type MinutesUsedBreakdown
- type MostRecentInstance
- func (m *MostRecentInstance) GetAnalysisKey() string
- func (m *MostRecentInstance) GetCommitSHA() string
- func (m *MostRecentInstance) GetEnvironment() string
- func (m *MostRecentInstance) GetLocation() *Location
- func (m *MostRecentInstance) GetMessage() *Message
- func (m *MostRecentInstance) GetRef() string
- func (m *MostRecentInstance) GetState() string
- type NewPullRequest
- type NewTeam
- type Notification
- func (n *Notification) GetID() string
- func (n *Notification) GetLastReadAt() time.Time
- func (n *Notification) GetReason() string
- func (n *Notification) GetRepository() *Repository
- func (n *Notification) GetSubject() *NotificationSubject
- func (n *Notification) GetURL() string
- func (n *Notification) GetUnread() bool
- func (n *Notification) GetUpdatedAt() time.Time
- type NotificationListOptions
- type NotificationSubject
- type OAuthAPP
- type OrgBlockEvent
- type OrgStats
- type Organization
- func (o *Organization) GetAvatarURL() string
- func (o *Organization) GetBillingEmail() string
- func (o *Organization) GetBlog() string
- func (o *Organization) GetCollaborators() int
- func (o *Organization) GetCompany() string
- func (o *Organization) GetCreatedAt() time.Time
- func (o *Organization) GetDefaultRepoPermission() string
- func (o *Organization) GetDefaultRepoSettings() string
- func (o *Organization) GetDescription() string
- func (o *Organization) GetDiskUsage() int
- func (o *Organization) GetEmail() string
- func (o *Organization) GetEventsURL() string
- func (o *Organization) GetFollowers() int
- func (o *Organization) GetFollowing() int
- func (o *Organization) GetHTMLURL() string
- func (o *Organization) GetHasOrganizationProjects() bool
- func (o *Organization) GetHasRepositoryProjects() bool
- func (o *Organization) GetHooksURL() string
- func (o *Organization) GetID() int64
- func (o *Organization) GetIsVerified() bool
- func (o *Organization) GetIssuesURL() string
- func (o *Organization) GetLocation() string
- func (o *Organization) GetLogin() string
- func (o *Organization) GetMembersAllowedRepositoryCreationType() string
- func (o *Organization) GetMembersCanCreateInternalRepos() bool
- func (o *Organization) GetMembersCanCreatePages() bool
- func (o *Organization) GetMembersCanCreatePrivatePages() bool
- func (o *Organization) GetMembersCanCreatePrivateRepos() bool
- func (o *Organization) GetMembersCanCreatePublicPages() bool
- func (o *Organization) GetMembersCanCreatePublicRepos() bool
- func (o *Organization) GetMembersCanCreateRepos() bool
- func (o *Organization) GetMembersURL() string
- func (o *Organization) GetName() string
- func (o *Organization) GetNodeID() string
- func (o *Organization) GetOwnedPrivateRepos() int
- func (o *Organization) GetPlan() *Plan
- func (o *Organization) GetPrivateGists() int
- func (o *Organization) GetPublicGists() int
- func (o *Organization) GetPublicMembersURL() string
- func (o *Organization) GetPublicRepos() int
- func (o *Organization) GetReposURL() string
- func (o *Organization) GetTotalPrivateRepos() int
- func (o *Organization) GetTwitterUsername() string
- func (o *Organization) GetTwoFactorRequirementEnabled() bool
- func (o *Organization) GetType() string
- func (o *Organization) GetURL() string
- func (o *Organization) GetUpdatedAt() time.Time
- func (o Organization) String() string
- type OrganizationEvent
- func (o *OrganizationEvent) GetAction() string
- func (o *OrganizationEvent) GetInstallation() *Installation
- func (o *OrganizationEvent) GetInvitation() *Invitation
- func (o *OrganizationEvent) GetMembership() *Membership
- func (o *OrganizationEvent) GetOrganization() *Organization
- func (o *OrganizationEvent) GetSender() *User
- type OrganizationInstallations
- type OrganizationsListOptions
- type OrganizationsService
- func (s *OrganizationsService) BlockUser(ctx context.Context, org string, user string) (*Response, error)
- func (s *OrganizationsService) ConcealMembership(ctx context.Context, org, user string) (*Response, error)
- func (s *OrganizationsService) ConvertMemberToOutsideCollaborator(ctx context.Context, org string, user string) (*Response, error)
- func (s *OrganizationsService) CreateHook(ctx context.Context, org string, hook *Hook) (*Hook, *Response, error)
- func (s *OrganizationsService) CreateOrgInvitation(ctx context.Context, org string, opts *CreateOrgInvitationOptions) (*Invitation, *Response, error)
- func (s *OrganizationsService) CreateProject(ctx context.Context, org string, opts *ProjectOptions) (*Project, *Response, error)
- func (s *OrganizationsService) DeleteHook(ctx context.Context, org string, id int64) (*Response, error)
- func (s *OrganizationsService) DeletePackage(ctx context.Context, org, packageType, packageName string) (*Response, error)
- func (s *OrganizationsService) Edit(ctx context.Context, name string, org *Organization) (*Organization, *Response, error)
- func (s *OrganizationsService) EditActionsAllowed(ctx context.Context, org string, actionsAllowed ActionsAllowed) (*ActionsAllowed, *Response, error)
- func (s *OrganizationsService) EditActionsPermissions(ctx context.Context, org string, actionsPermissions ActionsPermissions) (*ActionsPermissions, *Response, error)
- func (s *OrganizationsService) EditHook(ctx context.Context, org string, id int64, hook *Hook) (*Hook, *Response, error)
- func (s *OrganizationsService) EditOrgMembership(ctx context.Context, user, org string, membership *Membership) (*Membership, *Response, error)
- func (s *OrganizationsService) Get(ctx context.Context, org string) (*Organization, *Response, error)
- func (s *OrganizationsService) GetActionsAllowed(ctx context.Context, org string) (*ActionsAllowed, *Response, error)
- func (s *OrganizationsService) GetActionsPermissions(ctx context.Context, org string) (*ActionsPermissions, *Response, error)
- func (s *OrganizationsService) GetAuditLog(ctx context.Context, org string, opts *GetAuditLogOptions) ([]*AuditEntry, *Response, error)
- func (s *OrganizationsService) GetByID(ctx context.Context, id int64) (*Organization, *Response, error)
- func (s *OrganizationsService) GetHook(ctx context.Context, org string, id int64) (*Hook, *Response, error)
- func (s *OrganizationsService) GetHookDelivery(ctx context.Context, owner string, hookID, deliveryID int64) (*HookDelivery, *Response, error)
- func (s *OrganizationsService) GetOrgMembership(ctx context.Context, user, org string) (*Membership, *Response, error)
- func (s *OrganizationsService) GetPackage(ctx context.Context, org, packageType, packageName string) (*Package, *Response, error)
- func (s *OrganizationsService) IsBlocked(ctx context.Context, org string, user string) (bool, *Response, error)
- func (s *OrganizationsService) IsMember(ctx context.Context, org, user string) (bool, *Response, error)
- func (s *OrganizationsService) IsPublicMember(ctx context.Context, org, user string) (bool, *Response, error)
- func (s *OrganizationsService) List(ctx context.Context, user string, opts *ListOptions) ([]*Organization, *Response, error)
- func (s *OrganizationsService) ListAll(ctx context.Context, opts *OrganizationsListOptions) ([]*Organization, *Response, error)
- func (s *OrganizationsService) ListBlockedUsers(ctx context.Context, org string, opts *ListOptions) ([]*User, *Response, error)
- func (s *OrganizationsService) ListFailedOrgInvitations(ctx context.Context, org string, opts *ListOptions) ([]*Invitation, *Response, error)
- func (s *OrganizationsService) ListHookDeliveries(ctx context.Context, org string, id int64, opts *ListCursorOptions) ([]*HookDelivery, *Response, error)
- func (s *OrganizationsService) ListHooks(ctx context.Context, org string, opts *ListOptions) ([]*Hook, *Response, error)
- func (s *OrganizationsService) ListInstallations(ctx context.Context, org string, opts *ListOptions) (*OrganizationInstallations, *Response, error)
- func (s *OrganizationsService) ListMembers(ctx context.Context, org string, opts *ListMembersOptions) ([]*User, *Response, error)
- func (s *OrganizationsService) ListOrgInvitationTeams(ctx context.Context, org, invitationID string, opts *ListOptions) ([]*Team, *Response, error)
- func (s *OrganizationsService) ListOrgMemberships(ctx context.Context, opts *ListOrgMembershipsOptions) ([]*Membership, *Response, error)
- func (s *OrganizationsService) ListOutsideCollaborators(ctx context.Context, org string, opts *ListOutsideCollaboratorsOptions) ([]*User, *Response, error)
- func (s *OrganizationsService) ListPackages(ctx context.Context, org string, opts *PackageListOptions) ([]*Package, *Response, error)
- func (s *OrganizationsService) ListPendingOrgInvitations(ctx context.Context, org string, opts *ListOptions) ([]*Invitation, *Response, error)
- func (s *OrganizationsService) ListProjects(ctx context.Context, org string, opts *ProjectListOptions) ([]*Project, *Response, error)
- func (s *OrganizationsService) PackageDeleteVersion(ctx context.Context, org, packageType, packageName string, ...) (*Response, error)
- func (s *OrganizationsService) PackageGetAllVersions(ctx context.Context, org, packageType, packageName string, ...) ([]*PackageVersion, *Response, error)
- func (s *OrganizationsService) PackageGetVersion(ctx context.Context, org, packageType, packageName string, ...) (*PackageVersion, *Response, error)
- func (s *OrganizationsService) PackageRestoreVersion(ctx context.Context, org, packageType, packageName string, ...) (*Response, error)
- func (s *OrganizationsService) PingHook(ctx context.Context, org string, id int64) (*Response, error)
- func (s *OrganizationsService) PublicizeMembership(ctx context.Context, org, user string) (*Response, error)
- func (s *OrganizationsService) RedeliverHookDelivery(ctx context.Context, owner string, hookID, deliveryID int64) (*HookDelivery, *Response, error)
- func (s *OrganizationsService) RemoveMember(ctx context.Context, org, user string) (*Response, error)
- func (s *OrganizationsService) RemoveOrgMembership(ctx context.Context, user, org string) (*Response, error)
- func (s *OrganizationsService) RemoveOutsideCollaborator(ctx context.Context, org string, user string) (*Response, error)
- func (s *OrganizationsService) RestorePackage(ctx context.Context, org, packageType, packageName string) (*Response, error)
- func (s *OrganizationsService) UnblockUser(ctx context.Context, org string, user string) (*Response, error)
- type PRLink
- type PRLinks
- func (p *PRLinks) GetComments() *PRLink
- func (p *PRLinks) GetCommits() *PRLink
- func (p *PRLinks) GetHTML() *PRLink
- func (p *PRLinks) GetIssue() *PRLink
- func (p *PRLinks) GetReviewComment() *PRLink
- func (p *PRLinks) GetReviewComments() *PRLink
- func (p *PRLinks) GetSelf() *PRLink
- func (p *PRLinks) GetStatuses() *PRLink
- type Package
- func (p *Package) GetCreatedAt() Timestamp
- func (p *Package) GetHTMLURL() string
- func (p *Package) GetID() int64
- func (p *Package) GetName() string
- func (p *Package) GetOwner() *User
- func (p *Package) GetPackageType() string
- func (p *Package) GetPackageVersion() *PackageVersion
- func (p *Package) GetRegistry() *PackageRegistry
- func (p *Package) GetRepository() *Repository
- func (p *Package) GetURL() string
- func (p *Package) GetUpdatedAt() Timestamp
- func (p *Package) GetVersionCount() int64
- func (p *Package) GetVisibility() string
- func (p Package) String() string
- type PackageBilling
- type PackageContainerMetadata
- type PackageEvent
- type PackageFile
- func (p *PackageFile) GetAuthor() *User
- func (p *PackageFile) GetContentType() string
- func (p *PackageFile) GetCreatedAt() Timestamp
- func (p *PackageFile) GetDownloadURL() string
- func (p *PackageFile) GetID() int64
- func (p *PackageFile) GetMD5() string
- func (p *PackageFile) GetName() string
- func (p *PackageFile) GetSHA1() string
- func (p *PackageFile) GetSHA256() string
- func (p *PackageFile) GetSize() int64
- func (p *PackageFile) GetState() string
- func (p *PackageFile) GetUpdatedAt() Timestamp
- func (pf PackageFile) String() string
- type PackageListOptions
- type PackageMetadata
- type PackageRegistry
- type PackageRelease
- func (p *PackageRelease) GetAuthor() *User
- func (p *PackageRelease) GetCreatedAt() Timestamp
- func (p *PackageRelease) GetDraft() bool
- func (p *PackageRelease) GetHTMLURL() string
- func (p *PackageRelease) GetID() int64
- func (p *PackageRelease) GetName() string
- func (p *PackageRelease) GetPrerelease() bool
- func (p *PackageRelease) GetPublishedAt() Timestamp
- func (p *PackageRelease) GetTagName() string
- func (p *PackageRelease) GetTargetCommitish() string
- func (p *PackageRelease) GetURL() string
- func (r PackageRelease) String() string
- type PackageVersion
- func (p *PackageVersion) GetAuthor() *User
- func (p *PackageVersion) GetBody() string
- func (p *PackageVersion) GetBodyHTML() string
- func (p *PackageVersion) GetCreatedAt() Timestamp
- func (p *PackageVersion) GetDraft() bool
- func (p *PackageVersion) GetHTMLURL() string
- func (p *PackageVersion) GetID() int64
- func (p *PackageVersion) GetInstallationCommand() string
- func (p *PackageVersion) GetManifest() string
- func (p *PackageVersion) GetMetadata() *PackageMetadata
- func (p *PackageVersion) GetName() string
- func (p *PackageVersion) GetPackageHTMLURL() string
- func (p *PackageVersion) GetPrerelease() bool
- func (p *PackageVersion) GetRelease() *PackageRelease
- func (p *PackageVersion) GetSummary() string
- func (p *PackageVersion) GetTagName() string
- func (p *PackageVersion) GetTargetCommitish() string
- func (p *PackageVersion) GetTargetOID() string
- func (p *PackageVersion) GetURL() string
- func (p *PackageVersion) GetUpdatedAt() Timestamp
- func (p *PackageVersion) GetVersion() string
- func (pv PackageVersion) String() string
- type Page
- type PageBuildEvent
- type PageStats
- type Pages
- func (p *Pages) GetCNAME() string
- func (p *Pages) GetCustom404() bool
- func (p *Pages) GetHTMLURL() string
- func (p *Pages) GetHTTPSCertificate() *PagesHTTPSCertificate
- func (p *Pages) GetHTTPSEnforced() bool
- func (p *Pages) GetPublic() bool
- func (p *Pages) GetSource() *PagesSource
- func (p *Pages) GetStatus() string
- func (p *Pages) GetURL() string
- type PagesBuild
- func (p *PagesBuild) GetCommit() string
- func (p *PagesBuild) GetCreatedAt() Timestamp
- func (p *PagesBuild) GetDuration() int
- func (p *PagesBuild) GetError() *PagesError
- func (p *PagesBuild) GetPusher() *User
- func (p *PagesBuild) GetStatus() string
- func (p *PagesBuild) GetURL() string
- func (p *PagesBuild) GetUpdatedAt() Timestamp
- type PagesError
- type PagesHTTPSCertificate
- type PagesSource
- type PagesUpdate
- type PingEvent
- type Plan
- type PreReceiveHook
- type PreferenceList
- type Project
- func (p *Project) GetBody() string
- func (p *Project) GetColumnsURL() string
- func (p *Project) GetCreatedAt() Timestamp
- func (p *Project) GetCreator() *User
- func (p *Project) GetHTMLURL() string
- func (p *Project) GetID() int64
- func (p *Project) GetName() string
- func (p *Project) GetNodeID() string
- func (p *Project) GetNumber() int
- func (p *Project) GetOrganizationPermission() string
- func (p *Project) GetOwnerURL() string
- func (p *Project) GetPrivate() bool
- func (p *Project) GetState() string
- func (p *Project) GetURL() string
- func (p *Project) GetUpdatedAt() Timestamp
- func (p Project) String() string
- type ProjectBody
- type ProjectCard
- func (p *ProjectCard) GetArchived() bool
- func (p *ProjectCard) GetColumnID() int64
- func (p *ProjectCard) GetColumnName() string
- func (p *ProjectCard) GetColumnURL() string
- func (p *ProjectCard) GetContentURL() string
- func (p *ProjectCard) GetCreatedAt() Timestamp
- func (p *ProjectCard) GetCreator() *User
- func (p *ProjectCard) GetID() int64
- func (p *ProjectCard) GetNodeID() string
- func (p *ProjectCard) GetNote() string
- func (p *ProjectCard) GetPreviousColumnName() string
- func (p *ProjectCard) GetProjectID() int64
- func (p *ProjectCard) GetProjectURL() string
- func (p *ProjectCard) GetURL() string
- func (p *ProjectCard) GetUpdatedAt() Timestamp
- type ProjectCardChange
- type ProjectCardEvent
- func (p *ProjectCardEvent) GetAction() string
- func (p *ProjectCardEvent) GetAfterID() int64
- func (p *ProjectCardEvent) GetChanges() *ProjectCardChange
- func (p *ProjectCardEvent) GetInstallation() *Installation
- func (p *ProjectCardEvent) GetOrg() *Organization
- func (p *ProjectCardEvent) GetProjectCard() *ProjectCard
- func (p *ProjectCardEvent) GetRepo() *Repository
- func (p *ProjectCardEvent) GetSender() *User
- type ProjectCardListOptions
- type ProjectCardMoveOptions
- type ProjectCardNote
- type ProjectCardOptions
- type ProjectChange
- type ProjectCollaboratorOptions
- type ProjectColumn
- func (p *ProjectColumn) GetCardsURL() string
- func (p *ProjectColumn) GetCreatedAt() Timestamp
- func (p *ProjectColumn) GetID() int64
- func (p *ProjectColumn) GetName() string
- func (p *ProjectColumn) GetNodeID() string
- func (p *ProjectColumn) GetProjectURL() string
- func (p *ProjectColumn) GetURL() string
- func (p *ProjectColumn) GetUpdatedAt() Timestamp
- type ProjectColumnChange
- type ProjectColumnEvent
- func (p *ProjectColumnEvent) GetAction() string
- func (p *ProjectColumnEvent) GetAfterID() int64
- func (p *ProjectColumnEvent) GetChanges() *ProjectColumnChange
- func (p *ProjectColumnEvent) GetInstallation() *Installation
- func (p *ProjectColumnEvent) GetOrg() *Organization
- func (p *ProjectColumnEvent) GetProjectColumn() *ProjectColumn
- func (p *ProjectColumnEvent) GetRepo() *Repository
- func (p *ProjectColumnEvent) GetSender() *User
- type ProjectColumnMoveOptions
- type ProjectColumnName
- type ProjectColumnOptions
- type ProjectEvent
- func (p *ProjectEvent) GetAction() string
- func (p *ProjectEvent) GetChanges() *ProjectChange
- func (p *ProjectEvent) GetInstallation() *Installation
- func (p *ProjectEvent) GetOrg() *Organization
- func (p *ProjectEvent) GetProject() *Project
- func (p *ProjectEvent) GetRepo() *Repository
- func (p *ProjectEvent) GetSender() *User
- type ProjectListOptions
- type ProjectName
- type ProjectOptions
- type ProjectPermissionLevel
- type ProjectsService
- func (s *ProjectsService) AddProjectCollaborator(ctx context.Context, id int64, username string, ...) (*Response, error)
- func (s *ProjectsService) CreateProjectCard(ctx context.Context, columnID int64, opts *ProjectCardOptions) (*ProjectCard, *Response, error)
- func (s *ProjectsService) CreateProjectColumn(ctx context.Context, projectID int64, opts *ProjectColumnOptions) (*ProjectColumn, *Response, error)
- func (s *ProjectsService) DeleteProject(ctx context.Context, id int64) (*Response, error)
- func (s *ProjectsService) DeleteProjectCard(ctx context.Context, cardID int64) (*Response, error)
- func (s *ProjectsService) DeleteProjectColumn(ctx context.Context, columnID int64) (*Response, error)
- func (s *ProjectsService) GetProject(ctx context.Context, id int64) (*Project, *Response, error)
- func (s *ProjectsService) GetProjectCard(ctx context.Context, cardID int64) (*ProjectCard, *Response, error)
- func (s *ProjectsService) GetProjectColumn(ctx context.Context, id int64) (*ProjectColumn, *Response, error)
- func (s *ProjectsService) ListProjectCards(ctx context.Context, columnID int64, opts *ProjectCardListOptions) ([]*ProjectCard, *Response, error)
- func (s *ProjectsService) ListProjectCollaborators(ctx context.Context, id int64, opts *ListCollaboratorOptions) ([]*User, *Response, error)
- func (s *ProjectsService) ListProjectColumns(ctx context.Context, projectID int64, opts *ListOptions) ([]*ProjectColumn, *Response, error)
- func (s *ProjectsService) MoveProjectCard(ctx context.Context, cardID int64, opts *ProjectCardMoveOptions) (*Response, error)
- func (s *ProjectsService) MoveProjectColumn(ctx context.Context, columnID int64, opts *ProjectColumnMoveOptions) (*Response, error)
- func (s *ProjectsService) RemoveProjectCollaborator(ctx context.Context, id int64, username string) (*Response, error)
- func (s *ProjectsService) ReviewProjectCollaboratorPermission(ctx context.Context, id int64, username string) (*ProjectPermissionLevel, *Response, error)
- func (s *ProjectsService) UpdateProject(ctx context.Context, id int64, opts *ProjectOptions) (*Project, *Response, error)
- func (s *ProjectsService) UpdateProjectCard(ctx context.Context, cardID int64, opts *ProjectCardOptions) (*ProjectCard, *Response, error)
- func (s *ProjectsService) UpdateProjectColumn(ctx context.Context, columnID int64, opts *ProjectColumnOptions) (*ProjectColumn, *Response, error)
- type Protection
- func (p *Protection) GetAllowDeletions() *AllowDeletions
- func (p *Protection) GetAllowForcePushes() *AllowForcePushes
- func (p *Protection) GetEnforceAdmins() *AdminEnforcement
- func (p *Protection) GetRequireLinearHistory() *RequireLinearHistory
- func (p *Protection) GetRequiredConversationResolution() *RequiredConversationResolution
- func (p *Protection) GetRequiredPullRequestReviews() *PullRequestReviewsEnforcement
- func (p *Protection) GetRequiredStatusChecks() *RequiredStatusChecks
- func (p *Protection) GetRestrictions() *BranchRestrictions
- type ProtectionChanges
- type ProtectionRequest
- func (p *ProtectionRequest) GetAllowDeletions() bool
- func (p *ProtectionRequest) GetAllowForcePushes() bool
- func (p *ProtectionRequest) GetRequireLinearHistory() bool
- func (p *ProtectionRequest) GetRequiredConversationResolution() bool
- func (p *ProtectionRequest) GetRequiredPullRequestReviews() *PullRequestReviewsEnforcementRequest
- func (p *ProtectionRequest) GetRequiredStatusChecks() *RequiredStatusChecks
- func (p *ProtectionRequest) GetRestrictions() *BranchRestrictionsRequest
- type ProtectionRule
- type PublicEvent
- type PublicKey
- type PullRequest
- func (p *PullRequest) GetActiveLockReason() string
- func (p *PullRequest) GetAdditions() int
- func (p *PullRequest) GetAssignee() *User
- func (p *PullRequest) GetAuthorAssociation() string
- func (p *PullRequest) GetAutoMerge() *PullRequestAutoMerge
- func (p *PullRequest) GetBase() *PullRequestBranch
- func (p *PullRequest) GetBody() string
- func (p *PullRequest) GetChangedFiles() int
- func (p *PullRequest) GetClosedAt() time.Time
- func (p *PullRequest) GetComments() int
- func (p *PullRequest) GetCommentsURL() string
- func (p *PullRequest) GetCommits() int
- func (p *PullRequest) GetCommitsURL() string
- func (p *PullRequest) GetCreatedAt() time.Time
- func (p *PullRequest) GetDeletions() int
- func (p *PullRequest) GetDiffURL() string
- func (p *PullRequest) GetDraft() bool
- func (p *PullRequest) GetHTMLURL() string
- func (p *PullRequest) GetHead() *PullRequestBranch
- func (p *PullRequest) GetID() int64
- func (p *PullRequest) GetIssueURL() string
- func (p *PullRequest) GetLinks() *PRLinks
- func (p *PullRequest) GetLocked() bool
- func (p *PullRequest) GetMaintainerCanModify() bool
- func (p *PullRequest) GetMergeCommitSHA() string
- func (p *PullRequest) GetMergeable() bool
- func (p *PullRequest) GetMergeableState() string
- func (p *PullRequest) GetMerged() bool
- func (p *PullRequest) GetMergedAt() time.Time
- func (p *PullRequest) GetMergedBy() *User
- func (p *PullRequest) GetMilestone() *Milestone
- func (p *PullRequest) GetNodeID() string
- func (p *PullRequest) GetNumber() int
- func (p *PullRequest) GetPatchURL() string
- func (p *PullRequest) GetRebaseable() bool
- func (p *PullRequest) GetReviewCommentURL() string
- func (p *PullRequest) GetReviewComments() int
- func (p *PullRequest) GetReviewCommentsURL() string
- func (p *PullRequest) GetState() string
- func (p *PullRequest) GetStatusesURL() string
- func (p *PullRequest) GetTitle() string
- func (p *PullRequest) GetURL() string
- func (p *PullRequest) GetUpdatedAt() time.Time
- func (p *PullRequest) GetUser() *User
- func (p PullRequest) String() string
- type PullRequestAutoMerge
- type PullRequestBranch
- type PullRequestBranchUpdateOptions
- type PullRequestBranchUpdateResponse
- type PullRequestComment
- func (p *PullRequestComment) GetAuthorAssociation() string
- func (p *PullRequestComment) GetBody() string
- func (p *PullRequestComment) GetCommitID() string
- func (p *PullRequestComment) GetCreatedAt() time.Time
- func (p *PullRequestComment) GetDiffHunk() string
- func (p *PullRequestComment) GetHTMLURL() string
- func (p *PullRequestComment) GetID() int64
- func (p *PullRequestComment) GetInReplyTo() int64
- func (p *PullRequestComment) GetLine() int
- func (p *PullRequestComment) GetNodeID() string
- func (p *PullRequestComment) GetOriginalCommitID() string
- func (p *PullRequestComment) GetOriginalLine() int
- func (p *PullRequestComment) GetOriginalPosition() int
- func (p *PullRequestComment) GetOriginalStartLine() int
- func (p *PullRequestComment) GetPath() string
- func (p *PullRequestComment) GetPosition() int
- func (p *PullRequestComment) GetPullRequestReviewID() int64
- func (p *PullRequestComment) GetPullRequestURL() string
- func (p *PullRequestComment) GetReactions() *Reactions
- func (p *PullRequestComment) GetSide() string
- func (p *PullRequestComment) GetStartLine() int
- func (p *PullRequestComment) GetStartSide() string
- func (p *PullRequestComment) GetURL() string
- func (p *PullRequestComment) GetUpdatedAt() time.Time
- func (p *PullRequestComment) GetUser() *User
- func (p PullRequestComment) String() string
- type PullRequestEvent
- func (p *PullRequestEvent) GetAction() string
- func (p *PullRequestEvent) GetAfter() string
- func (p *PullRequestEvent) GetAssignee() *User
- func (p *PullRequestEvent) GetBefore() string
- func (p *PullRequestEvent) GetChanges() *EditChange
- func (p *PullRequestEvent) GetInstallation() *Installation
- func (p *PullRequestEvent) GetLabel() *Label
- func (p *PullRequestEvent) GetNumber() int
- func (p *PullRequestEvent) GetOrganization() *Organization
- func (p *PullRequestEvent) GetPullRequest() *PullRequest
- func (p *PullRequestEvent) GetRepo() *Repository
- func (p *PullRequestEvent) GetRequestedReviewer() *User
- func (p *PullRequestEvent) GetRequestedTeam() *Team
- func (p *PullRequestEvent) GetSender() *User
- type PullRequestLinks
- type PullRequestListCommentsOptions
- type PullRequestListOptions
- type PullRequestMergeResult
- type PullRequestOptions
- type PullRequestReview
- func (p *PullRequestReview) GetAuthorAssociation() string
- func (p *PullRequestReview) GetBody() string
- func (p *PullRequestReview) GetCommitID() string
- func (p *PullRequestReview) GetHTMLURL() string
- func (p *PullRequestReview) GetID() int64
- func (p *PullRequestReview) GetNodeID() string
- func (p *PullRequestReview) GetPullRequestURL() string
- func (p *PullRequestReview) GetState() string
- func (p *PullRequestReview) GetSubmittedAt() time.Time
- func (p *PullRequestReview) GetUser() *User
- func (p PullRequestReview) String() string
- type PullRequestReviewCommentEvent
- func (p *PullRequestReviewCommentEvent) GetAction() string
- func (p *PullRequestReviewCommentEvent) GetChanges() *EditChange
- func (p *PullRequestReviewCommentEvent) GetComment() *PullRequestComment
- func (p *PullRequestReviewCommentEvent) GetInstallation() *Installation
- func (p *PullRequestReviewCommentEvent) GetPullRequest() *PullRequest
- func (p *PullRequestReviewCommentEvent) GetRepo() *Repository
- func (p *PullRequestReviewCommentEvent) GetSender() *User
- type PullRequestReviewDismissalRequest
- type PullRequestReviewEvent
- func (p *PullRequestReviewEvent) GetAction() string
- func (p *PullRequestReviewEvent) GetInstallation() *Installation
- func (p *PullRequestReviewEvent) GetOrganization() *Organization
- func (p *PullRequestReviewEvent) GetPullRequest() *PullRequest
- func (p *PullRequestReviewEvent) GetRepo() *Repository
- func (p *PullRequestReviewEvent) GetReview() *PullRequestReview
- func (p *PullRequestReviewEvent) GetSender() *User
- type PullRequestReviewRequest
- type PullRequestReviewsEnforcement
- type PullRequestReviewsEnforcementRequest
- type PullRequestReviewsEnforcementUpdate
- type PullRequestTargetEvent
- func (p *PullRequestTargetEvent) GetAction() string
- func (p *PullRequestTargetEvent) GetAfter() string
- func (p *PullRequestTargetEvent) GetAssignee() *User
- func (p *PullRequestTargetEvent) GetBefore() string
- func (p *PullRequestTargetEvent) GetChanges() *EditChange
- func (p *PullRequestTargetEvent) GetInstallation() *Installation
- func (p *PullRequestTargetEvent) GetLabel() *Label
- func (p *PullRequestTargetEvent) GetNumber() int
- func (p *PullRequestTargetEvent) GetOrganization() *Organization
- func (p *PullRequestTargetEvent) GetPullRequest() *PullRequest
- func (p *PullRequestTargetEvent) GetRepo() *Repository
- func (p *PullRequestTargetEvent) GetRequestedReviewer() *User
- func (p *PullRequestTargetEvent) GetRequestedTeam() *Team
- func (p *PullRequestTargetEvent) GetSender() *User
- type PullRequestsService
- func (s *PullRequestsService) Create(ctx context.Context, owner string, repo string, pull *NewPullRequest) (*PullRequest, *Response, error)
- func (s *PullRequestsService) CreateComment(ctx context.Context, owner, repo string, number int, ...) (*PullRequestComment, *Response, error)
- func (s *PullRequestsService) CreateCommentInReplyTo(ctx context.Context, owner, repo string, number int, body string, ...) (*PullRequestComment, *Response, error)
- func (s *PullRequestsService) CreateReview(ctx context.Context, owner, repo string, number int, ...) (*PullRequestReview, *Response, error)
- func (s *PullRequestsService) DeleteComment(ctx context.Context, owner, repo string, commentID int64) (*Response, error)
- func (s *PullRequestsService) DeletePendingReview(ctx context.Context, owner, repo string, number int, reviewID int64) (*PullRequestReview, *Response, error)
- func (s *PullRequestsService) DismissReview(ctx context.Context, owner, repo string, number int, reviewID int64, ...) (*PullRequestReview, *Response, error)
- func (s *PullRequestsService) Edit(ctx context.Context, owner string, repo string, number int, pull *PullRequest) (*PullRequest, *Response, error)
- func (s *PullRequestsService) EditComment(ctx context.Context, owner, repo string, commentID int64, ...) (*PullRequestComment, *Response, error)
- func (s *PullRequestsService) Get(ctx context.Context, owner string, repo string, number int) (*PullRequest, *Response, error)
- func (s *PullRequestsService) GetComment(ctx context.Context, owner, repo string, commentID int64) (*PullRequestComment, *Response, error)
- func (s *PullRequestsService) GetRaw(ctx context.Context, owner string, repo string, number int, opts RawOptions) (string, *Response, error)
- func (s *PullRequestsService) GetReview(ctx context.Context, owner, repo string, number int, reviewID int64) (*PullRequestReview, *Response, error)
- func (s *PullRequestsService) IsMerged(ctx context.Context, owner string, repo string, number int) (bool, *Response, error)
- func (s *PullRequestsService) List(ctx context.Context, owner string, repo string, opts *PullRequestListOptions) ([]*PullRequest, *Response, error)
- func (s *PullRequestsService) ListComments(ctx context.Context, owner, repo string, number int, ...) ([]*PullRequestComment, *Response, error)
- func (s *PullRequestsService) ListCommits(ctx context.Context, owner string, repo string, number int, opts *ListOptions) ([]*RepositoryCommit, *Response, error)
- func (s *PullRequestsService) ListFiles(ctx context.Context, owner string, repo string, number int, opts *ListOptions) ([]*CommitFile, *Response, error)
- func (s *PullRequestsService) ListPullRequestsWithCommit(ctx context.Context, owner, repo, sha string, opts *PullRequestListOptions) ([]*PullRequest, *Response, error)
- func (s *PullRequestsService) ListReviewComments(ctx context.Context, owner, repo string, number int, reviewID int64, ...) ([]*PullRequestComment, *Response, error)
- func (s *PullRequestsService) ListReviewers(ctx context.Context, owner, repo string, number int, opts *ListOptions) (*Reviewers, *Response, error)
- func (s *PullRequestsService) ListReviews(ctx context.Context, owner, repo string, number int, opts *ListOptions) ([]*PullRequestReview, *Response, error)
- func (s *PullRequestsService) Merge(ctx context.Context, owner string, repo string, number int, ...) (*PullRequestMergeResult, *Response, error)
- func (s *PullRequestsService) RemoveReviewers(ctx context.Context, owner, repo string, number int, ...) (*Response, error)
- func (s *PullRequestsService) RequestReviewers(ctx context.Context, owner, repo string, number int, ...) (*PullRequest, *Response, error)
- func (s *PullRequestsService) SubmitReview(ctx context.Context, owner, repo string, number int, reviewID int64, ...) (*PullRequestReview, *Response, error)
- func (s *PullRequestsService) UpdateBranch(ctx context.Context, owner, repo string, number int, ...) (*PullRequestBranchUpdateResponse, *Response, error)
- func (s *PullRequestsService) UpdateReview(ctx context.Context, owner, repo string, number int, reviewID int64, ...) (*PullRequestReview, *Response, error)
- type PullStats
- type PunchCard
- type PushEvent
- func (p *PushEvent) GetAfter() string
- func (p *PushEvent) GetBaseRef() string
- func (p *PushEvent) GetBefore() string
- func (p *PushEvent) GetCompare() string
- func (p *PushEvent) GetCreated() bool
- func (p *PushEvent) GetDeleted() bool
- func (p *PushEvent) GetDistinctSize() int
- func (p *PushEvent) GetForced() bool
- func (p *PushEvent) GetHead() string
- func (p *PushEvent) GetHeadCommit() *HeadCommit
- func (p *PushEvent) GetInstallation() *Installation
- func (p *PushEvent) GetOrganization() *Organization
- func (p *PushEvent) GetPushID() int64
- func (p *PushEvent) GetPusher() *User
- func (p *PushEvent) GetRef() string
- func (p *PushEvent) GetRepo() *PushEventRepository
- func (p *PushEvent) GetSender() *User
- func (p *PushEvent) GetSize() int
- func (p PushEvent) String() string
- type PushEventRepoOwner
- type PushEventRepository
- func (p *PushEventRepository) GetArchiveURL() string
- func (p *PushEventRepository) GetArchived() bool
- func (p *PushEventRepository) GetCloneURL() string
- func (p *PushEventRepository) GetCreatedAt() Timestamp
- func (p *PushEventRepository) GetDefaultBranch() string
- func (p *PushEventRepository) GetDescription() string
- func (p *PushEventRepository) GetDisabled() bool
- func (p *PushEventRepository) GetFork() bool
- func (p *PushEventRepository) GetForksCount() int
- func (p *PushEventRepository) GetFullName() string
- func (p *PushEventRepository) GetGitURL() string
- func (p *PushEventRepository) GetHTMLURL() string
- func (p *PushEventRepository) GetHasDownloads() bool
- func (p *PushEventRepository) GetHasIssues() bool
- func (p *PushEventRepository) GetHasPages() bool
- func (p *PushEventRepository) GetHasWiki() bool
- func (p *PushEventRepository) GetHomepage() string
- func (p *PushEventRepository) GetID() int64
- func (p *PushEventRepository) GetLanguage() string
- func (p *PushEventRepository) GetMasterBranch() string
- func (p *PushEventRepository) GetName() string
- func (p *PushEventRepository) GetNodeID() string
- func (p *PushEventRepository) GetOpenIssuesCount() int
- func (p *PushEventRepository) GetOrganization() string
- func (p *PushEventRepository) GetOwner() *User
- func (p *PushEventRepository) GetPrivate() bool
- func (p *PushEventRepository) GetPullsURL() string
- func (p *PushEventRepository) GetPushedAt() Timestamp
- func (p *PushEventRepository) GetSSHURL() string
- func (p *PushEventRepository) GetSVNURL() string
- func (p *PushEventRepository) GetSize() int
- func (p *PushEventRepository) GetStargazersCount() int
- func (p *PushEventRepository) GetStatusesURL() string
- func (p *PushEventRepository) GetURL() string
- func (p *PushEventRepository) GetUpdatedAt() Timestamp
- func (p *PushEventRepository) GetWatchersCount() int
- type Rate
- type RateLimitError
- type RateLimits
- type RawOptions
- type RawType
- type Reaction
- type Reactions
- func (r *Reactions) GetConfused() int
- func (r *Reactions) GetEyes() int
- func (r *Reactions) GetHeart() int
- func (r *Reactions) GetHooray() int
- func (r *Reactions) GetLaugh() int
- func (r *Reactions) GetMinusOne() int
- func (r *Reactions) GetPlusOne() int
- func (r *Reactions) GetRocket() int
- func (r *Reactions) GetTotalCount() int
- func (r *Reactions) GetURL() string
- type ReactionsService
- func (s *ReactionsService) CreateCommentReaction(ctx context.Context, owner, repo string, id int64, content string) (*Reaction, *Response, error)
- func (s *ReactionsService) CreateIssueCommentReaction(ctx context.Context, owner, repo string, id int64, content string) (*Reaction, *Response, error)
- func (s *ReactionsService) CreateIssueReaction(ctx context.Context, owner, repo string, number int, content string) (*Reaction, *Response, error)
- func (s *ReactionsService) CreatePullRequestCommentReaction(ctx context.Context, owner, repo string, id int64, content string) (*Reaction, *Response, error)
- func (s *ReactionsService) CreateReleaseReaction(ctx context.Context, owner, repo string, releaseID int64, content string) (*Reaction, *Response, error)
- func (s *ReactionsService) CreateTeamDiscussionCommentReaction(ctx context.Context, teamID int64, discussionNumber, commentNumber int, ...) (*Reaction, *Response, error)
- func (s *ReactionsService) CreateTeamDiscussionReaction(ctx context.Context, teamID int64, discussionNumber int, content string) (*Reaction, *Response, error)
- func (s *ReactionsService) DeleteCommentReaction(ctx context.Context, owner, repo string, commentID, reactionID int64) (*Response, error)
- func (s *ReactionsService) DeleteCommentReactionByID(ctx context.Context, repoID, commentID, reactionID int64) (*Response, error)
- func (s *ReactionsService) DeleteIssueCommentReaction(ctx context.Context, owner, repo string, commentID, reactionID int64) (*Response, error)
- func (s *ReactionsService) DeleteIssueCommentReactionByID(ctx context.Context, repoID, commentID, reactionID int64) (*Response, error)
- func (s *ReactionsService) DeleteIssueReaction(ctx context.Context, owner, repo string, issueNumber int, reactionID int64) (*Response, error)
- func (s *ReactionsService) DeleteIssueReactionByID(ctx context.Context, repoID, issueNumber int, reactionID int64) (*Response, error)
- func (s *ReactionsService) DeletePullRequestCommentReaction(ctx context.Context, owner, repo string, commentID, reactionID int64) (*Response, error)
- func (s *ReactionsService) DeletePullRequestCommentReactionByID(ctx context.Context, repoID, commentID, reactionID int64) (*Response, error)
- func (s *ReactionsService) DeleteTeamDiscussionCommentReaction(ctx context.Context, org, teamSlug string, discussionNumber, commentNumber int, ...) (*Response, error)
- func (s *ReactionsService) DeleteTeamDiscussionCommentReactionByOrgIDAndTeamID(ctx context.Context, orgID, teamID, discussionNumber, commentNumber int, ...) (*Response, error)
- func (s *ReactionsService) DeleteTeamDiscussionReaction(ctx context.Context, org, teamSlug string, discussionNumber int, ...) (*Response, error)
- func (s *ReactionsService) DeleteTeamDiscussionReactionByOrgIDAndTeamID(ctx context.Context, orgID, teamID, discussionNumber int, reactionID int64) (*Response, error)
- func (s *ReactionsService) ListCommentReactions(ctx context.Context, owner, repo string, id int64, ...) ([]*Reaction, *Response, error)
- func (s *ReactionsService) ListIssueCommentReactions(ctx context.Context, owner, repo string, id int64, opts *ListOptions) ([]*Reaction, *Response, error)
- func (s *ReactionsService) ListIssueReactions(ctx context.Context, owner, repo string, number int, opts *ListOptions) ([]*Reaction, *Response, error)
- func (s *ReactionsService) ListPullRequestCommentReactions(ctx context.Context, owner, repo string, id int64, opts *ListOptions) ([]*Reaction, *Response, error)
- func (s *ReactionsService) ListTeamDiscussionCommentReactions(ctx context.Context, teamID int64, discussionNumber, commentNumber int, ...) ([]*Reaction, *Response, error)
- func (s *ReactionsService) ListTeamDiscussionReactions(ctx context.Context, teamID int64, discussionNumber int, opts *ListOptions) ([]*Reaction, *Response, error)
- type Reference
- type ReferenceListOptions
- type RegistrationToken
- type ReleaseAsset
- func (r *ReleaseAsset) GetBrowserDownloadURL() string
- func (r *ReleaseAsset) GetContentType() string
- func (r *ReleaseAsset) GetCreatedAt() Timestamp
- func (r *ReleaseAsset) GetDownloadCount() int
- func (r *ReleaseAsset) GetID() int64
- func (r *ReleaseAsset) GetLabel() string
- func (r *ReleaseAsset) GetName() string
- func (r *ReleaseAsset) GetNodeID() string
- func (r *ReleaseAsset) GetSize() int
- func (r *ReleaseAsset) GetState() string
- func (r *ReleaseAsset) GetURL() string
- func (r *ReleaseAsset) GetUpdatedAt() Timestamp
- func (r *ReleaseAsset) GetUploader() *User
- func (r ReleaseAsset) String() string
- type ReleaseEvent
- type RemoveToken
- type Rename
- type RenameOrgResponse
- type RepoName
- type RepoStats
- type RepoStatus
- func (r *RepoStatus) GetAvatarURL() string
- func (r *RepoStatus) GetContext() string
- func (r *RepoStatus) GetCreatedAt() time.Time
- func (r *RepoStatus) GetCreator() *User
- func (r *RepoStatus) GetDescription() string
- func (r *RepoStatus) GetID() int64
- func (r *RepoStatus) GetNodeID() string
- func (r *RepoStatus) GetState() string
- func (r *RepoStatus) GetTargetURL() string
- func (r *RepoStatus) GetURL() string
- func (r *RepoStatus) GetUpdatedAt() time.Time
- func (r RepoStatus) String() string
- type RepositoriesSearchResult
- type RepositoriesService
- func (s *RepositoriesService) AddAdminEnforcement(ctx context.Context, owner, repo, branch string) (*AdminEnforcement, *Response, error)
- func (s *RepositoriesService) AddAppRestrictions(ctx context.Context, owner, repo, branch string, slug []string) ([]*App, *Response, error)
- func (s *RepositoriesService) AddAutolink(ctx context.Context, owner, repo string, opts *AutolinkOptions) (*Autolink, *Response, error)
- func (s *RepositoriesService) AddCollaborator(ctx context.Context, owner, repo, user string, ...) (*CollaboratorInvitation, *Response, error)
- func (s *RepositoriesService) CompareCommits(ctx context.Context, owner, repo string, base, head string, opts *ListOptions) (*CommitsComparison, *Response, error)
- func (s *RepositoriesService) CompareCommitsRaw(ctx context.Context, owner, repo, base, head string, opts RawOptions) (string, *Response, error)
- func (s *RepositoriesService) Create(ctx context.Context, org string, repo *Repository) (*Repository, *Response, error)
- func (s *RepositoriesService) CreateComment(ctx context.Context, owner, repo, sha string, comment *RepositoryComment) (*RepositoryComment, *Response, error)
- func (s *RepositoriesService) CreateDeployment(ctx context.Context, owner, repo string, request *DeploymentRequest) (*Deployment, *Response, error)
- func (s *RepositoriesService) CreateDeploymentStatus(ctx context.Context, owner, repo string, deployment int64, ...) (*DeploymentStatus, *Response, error)
- func (s *RepositoriesService) CreateFile(ctx context.Context, owner, repo, path string, ...) (*RepositoryContentResponse, *Response, error)
- func (s *RepositoriesService) CreateFork(ctx context.Context, owner, repo string, opts *RepositoryCreateForkOptions) (*Repository, *Response, error)
- func (s *RepositoriesService) CreateFromTemplate(ctx context.Context, templateOwner, templateRepo string, ...) (*Repository, *Response, error)
- func (s *RepositoriesService) CreateHook(ctx context.Context, owner, repo string, hook *Hook) (*Hook, *Response, error)
- func (s *RepositoriesService) CreateKey(ctx context.Context, owner string, repo string, key *Key) (*Key, *Response, error)
- func (s *RepositoriesService) CreateProject(ctx context.Context, owner, repo string, opts *ProjectOptions) (*Project, *Response, error)
- func (s *RepositoriesService) CreateRelease(ctx context.Context, owner, repo string, release *RepositoryRelease) (*RepositoryRelease, *Response, error)
- func (s *RepositoriesService) CreateStatus(ctx context.Context, owner, repo, ref string, status *RepoStatus) (*RepoStatus, *Response, error)
- func (s *RepositoriesService) CreateUpdateEnvironment(ctx context.Context, owner, repo, name string, ...) (*Environment, *Response, error)
- func (s *RepositoriesService) Delete(ctx context.Context, owner, repo string) (*Response, error)
- func (s *RepositoriesService) DeleteAutolink(ctx context.Context, owner, repo string, id int64) (*Response, error)
- func (s *RepositoriesService) DeleteComment(ctx context.Context, owner, repo string, id int64) (*Response, error)
- func (s *RepositoriesService) DeleteDeployment(ctx context.Context, owner, repo string, deploymentID int64) (*Response, error)
- func (s *RepositoriesService) DeleteEnvironment(ctx context.Context, owner, repo, name string) (*Response, error)
- func (s *RepositoriesService) DeleteFile(ctx context.Context, owner, repo, path string, ...) (*RepositoryContentResponse, *Response, error)
- func (s *RepositoriesService) DeleteHook(ctx context.Context, owner, repo string, id int64) (*Response, error)
- func (s *RepositoriesService) DeleteInvitation(ctx context.Context, owner, repo string, invitationID int64) (*Response, error)
- func (s *RepositoriesService) DeleteKey(ctx context.Context, owner string, repo string, id int64) (*Response, error)
- func (s *RepositoriesService) DeletePreReceiveHook(ctx context.Context, owner, repo string, id int64) (*Response, error)
- func (s *RepositoriesService) DeleteRelease(ctx context.Context, owner, repo string, id int64) (*Response, error)
- func (s *RepositoriesService) DeleteReleaseAsset(ctx context.Context, owner, repo string, id int64) (*Response, error)
- func (s *RepositoriesService) DisableAutomatedSecurityFixes(ctx context.Context, owner, repository string) (*Response, error)
- func (s *RepositoriesService) DisableDismissalRestrictions(ctx context.Context, owner, repo, branch string) (*PullRequestReviewsEnforcement, *Response, error)
- func (s *RepositoriesService) DisablePages(ctx context.Context, owner, repo string) (*Response, error)
- func (s *RepositoriesService) DisableVulnerabilityAlerts(ctx context.Context, owner, repository string) (*Response, error)
- func (s *RepositoriesService) Dispatch(ctx context.Context, owner, repo string, opts DispatchRequestOptions) (*Repository, *Response, error)
- func (s *RepositoriesService) DownloadContents(ctx context.Context, owner, repo, filepath string, ...) (io.ReadCloser, *Response, error)
- func (s *RepositoriesService) DownloadContentsWithMeta(ctx context.Context, owner, repo, filepath string, ...) (io.ReadCloser, *RepositoryContent, *Response, error)
- func (s *RepositoriesService) DownloadReleaseAsset(ctx context.Context, owner, repo string, id int64, ...) (rc io.ReadCloser, redirectURL string, err error)
- func (s *RepositoriesService) Edit(ctx context.Context, owner, repo string, repository *Repository) (*Repository, *Response, error)
- func (s *RepositoriesService) EditHook(ctx context.Context, owner, repo string, id int64, hook *Hook) (*Hook, *Response, error)
- func (s *RepositoriesService) EditRelease(ctx context.Context, owner, repo string, id int64, release *RepositoryRelease) (*RepositoryRelease, *Response, error)
- func (s *RepositoriesService) EditReleaseAsset(ctx context.Context, owner, repo string, id int64, release *ReleaseAsset) (*ReleaseAsset, *Response, error)
- func (s *RepositoriesService) EnableAutomatedSecurityFixes(ctx context.Context, owner, repository string) (*Response, error)
- func (s *RepositoriesService) EnablePages(ctx context.Context, owner, repo string, pages *Pages) (*Pages, *Response, error)
- func (s *RepositoriesService) EnableVulnerabilityAlerts(ctx context.Context, owner, repository string) (*Response, error)
- func (s *RepositoriesService) GenerateReleaseNotes(ctx context.Context, owner, repo string, opts *GenerateNotesOptions) (*RepositoryReleaseNotes, *Response, error)
- func (s *RepositoriesService) Get(ctx context.Context, owner, repo string) (*Repository, *Response, error)
- func (s *RepositoriesService) GetAdminEnforcement(ctx context.Context, owner, repo, branch string) (*AdminEnforcement, *Response, error)
- func (s *RepositoriesService) GetArchiveLink(ctx context.Context, owner, repo string, archiveformat ArchiveFormat, ...) (*url.URL, *Response, error)
- func (s *RepositoriesService) GetAutolink(ctx context.Context, owner, repo string, id int64) (*Autolink, *Response, error)
- func (s *RepositoriesService) GetBranch(ctx context.Context, owner, repo, branch string, followRedirects bool) (*Branch, *Response, error)
- func (s *RepositoriesService) GetBranchProtection(ctx context.Context, owner, repo, branch string) (*Protection, *Response, error)
- func (s *RepositoriesService) GetByID(ctx context.Context, id int64) (*Repository, *Response, error)
- func (s *RepositoriesService) GetCodeOfConduct(ctx context.Context, owner, repo string) (*CodeOfConduct, *Response, error)
- func (s *RepositoriesService) GetCombinedStatus(ctx context.Context, owner, repo, ref string, opts *ListOptions) (*CombinedStatus, *Response, error)
- func (s *RepositoriesService) GetComment(ctx context.Context, owner, repo string, id int64) (*RepositoryComment, *Response, error)
- func (s *RepositoriesService) GetCommit(ctx context.Context, owner, repo, sha string, opts *ListOptions) (*RepositoryCommit, *Response, error)
- func (s *RepositoriesService) GetCommitRaw(ctx context.Context, owner string, repo string, sha string, opts RawOptions) (string, *Response, error)
- func (s *RepositoriesService) GetCommitSHA1(ctx context.Context, owner, repo, ref, lastSHA string) (string, *Response, error)
- func (s *RepositoriesService) GetCommunityHealthMetrics(ctx context.Context, owner, repo string) (*CommunityHealthMetrics, *Response, error)
- func (s *RepositoriesService) GetContents(ctx context.Context, owner, repo, path string, ...) (fileContent *RepositoryContent, directoryContent []*RepositoryContent, ...)
- func (s *RepositoriesService) GetDeployment(ctx context.Context, owner, repo string, deploymentID int64) (*Deployment, *Response, error)
- func (s *RepositoriesService) GetDeploymentStatus(ctx context.Context, owner, repo string, ...) (*DeploymentStatus, *Response, error)
- func (s *RepositoriesService) GetEnvironment(ctx context.Context, owner, repo, name string) (*Environment, *Response, error)
- func (s *RepositoriesService) GetHook(ctx context.Context, owner, repo string, id int64) (*Hook, *Response, error)
- func (s *RepositoriesService) GetHookDelivery(ctx context.Context, owner, repo string, hookID, deliveryID int64) (*HookDelivery, *Response, error)
- func (s *RepositoriesService) GetKey(ctx context.Context, owner string, repo string, id int64) (*Key, *Response, error)
- func (s *RepositoriesService) GetLatestPagesBuild(ctx context.Context, owner, repo string) (*PagesBuild, *Response, error)
- func (s *RepositoriesService) GetLatestRelease(ctx context.Context, owner, repo string) (*RepositoryRelease, *Response, error)
- func (s *RepositoriesService) GetPageBuild(ctx context.Context, owner, repo string, id int64) (*PagesBuild, *Response, error)
- func (s *RepositoriesService) GetPagesInfo(ctx context.Context, owner, repo string) (*Pages, *Response, error)
- func (s *RepositoriesService) GetPermissionLevel(ctx context.Context, owner, repo, user string) (*RepositoryPermissionLevel, *Response, error)
- func (s *RepositoriesService) GetPreReceiveHook(ctx context.Context, owner, repo string, id int64) (*PreReceiveHook, *Response, error)
- func (s *RepositoriesService) GetPullRequestReviewEnforcement(ctx context.Context, owner, repo, branch string) (*PullRequestReviewsEnforcement, *Response, error)
- func (s *RepositoriesService) GetReadme(ctx context.Context, owner, repo string, opts *RepositoryContentGetOptions) (*RepositoryContent, *Response, error)
- func (s *RepositoriesService) GetRelease(ctx context.Context, owner, repo string, id int64) (*RepositoryRelease, *Response, error)
- func (s *RepositoriesService) GetReleaseAsset(ctx context.Context, owner, repo string, id int64) (*ReleaseAsset, *Response, error)
- func (s *RepositoriesService) GetReleaseByTag(ctx context.Context, owner, repo, tag string) (*RepositoryRelease, *Response, error)
- func (s *RepositoriesService) GetRequiredStatusChecks(ctx context.Context, owner, repo, branch string) (*RequiredStatusChecks, *Response, error)
- func (s *RepositoriesService) GetSignaturesProtectedBranch(ctx context.Context, owner, repo, branch string) (*SignaturesProtectedBranch, *Response, error)
- func (s *RepositoriesService) GetVulnerabilityAlerts(ctx context.Context, owner, repository string) (bool, *Response, error)
- func (s *RepositoriesService) IsCollaborator(ctx context.Context, owner, repo, user string) (bool, *Response, error)
- func (s *RepositoriesService) License(ctx context.Context, owner, repo string) (*RepositoryLicense, *Response, error)
- func (s *RepositoriesService) List(ctx context.Context, user string, opts *RepositoryListOptions) ([]*Repository, *Response, error)
- func (s *RepositoriesService) ListAll(ctx context.Context, opts *RepositoryListAllOptions) ([]*Repository, *Response, error)
- func (s *RepositoriesService) ListAllTopics(ctx context.Context, owner, repo string) ([]string, *Response, error)
- func (s *RepositoriesService) ListApps(ctx context.Context, owner, repo, branch string) ([]*App, *Response, error)
- func (s *RepositoriesService) ListAutolinks(ctx context.Context, owner, repo string, opts *ListOptions) ([]*Autolink, *Response, error)
- func (s *RepositoriesService) ListBranches(ctx context.Context, owner string, repo string, opts *BranchListOptions) ([]*Branch, *Response, error)
- func (s *RepositoriesService) ListBranchesHeadCommit(ctx context.Context, owner, repo, sha string) ([]*BranchCommit, *Response, error)
- func (s *RepositoriesService) ListByOrg(ctx context.Context, org string, opts *RepositoryListByOrgOptions) ([]*Repository, *Response, error)
- func (s *RepositoriesService) ListCodeFrequency(ctx context.Context, owner, repo string) ([]*WeeklyStats, *Response, error)
- func (s *RepositoriesService) ListCollaborators(ctx context.Context, owner, repo string, opts *ListCollaboratorsOptions) ([]*User, *Response, error)
- func (s *RepositoriesService) ListComments(ctx context.Context, owner, repo string, opts *ListOptions) ([]*RepositoryComment, *Response, error)
- func (s *RepositoriesService) ListCommitActivity(ctx context.Context, owner, repo string) ([]*WeeklyCommitActivity, *Response, error)
- func (s *RepositoriesService) ListCommitComments(ctx context.Context, owner, repo, sha string, opts *ListOptions) ([]*RepositoryComment, *Response, error)
- func (s *RepositoriesService) ListCommits(ctx context.Context, owner, repo string, opts *CommitsListOptions) ([]*RepositoryCommit, *Response, error)
- func (s *RepositoriesService) ListContributors(ctx context.Context, owner string, repository string, ...) ([]*Contributor, *Response, error)
- func (s *RepositoriesService) ListContributorsStats(ctx context.Context, owner, repo string) ([]*ContributorStats, *Response, error)
- func (s *RepositoriesService) ListDeploymentStatuses(ctx context.Context, owner, repo string, deployment int64, opts *ListOptions) ([]*DeploymentStatus, *Response, error)
- func (s *RepositoriesService) ListDeployments(ctx context.Context, owner, repo string, opts *DeploymentsListOptions) ([]*Deployment, *Response, error)
- func (s *RepositoriesService) ListEnvironments(ctx context.Context, owner, repo string, opts *EnvironmentListOptions) (*EnvResponse, *Response, error)
- func (s *RepositoriesService) ListForks(ctx context.Context, owner, repo string, opts *RepositoryListForksOptions) ([]*Repository, *Response, error)
- func (s *RepositoriesService) ListHookDeliveries(ctx context.Context, owner, repo string, id int64, opts *ListCursorOptions) ([]*HookDelivery, *Response, error)
- func (s *RepositoriesService) ListHooks(ctx context.Context, owner, repo string, opts *ListOptions) ([]*Hook, *Response, error)
- func (s *RepositoriesService) ListInvitations(ctx context.Context, owner, repo string, opts *ListOptions) ([]*RepositoryInvitation, *Response, error)
- func (s *RepositoriesService) ListKeys(ctx context.Context, owner string, repo string, opts *ListOptions) ([]*Key, *Response, error)
- func (s *RepositoriesService) ListLanguages(ctx context.Context, owner string, repo string) (map[string]int, *Response, error)
- func (s *RepositoriesService) ListPagesBuilds(ctx context.Context, owner, repo string, opts *ListOptions) ([]*PagesBuild, *Response, error)
- func (s *RepositoriesService) ListParticipation(ctx context.Context, owner, repo string) (*RepositoryParticipation, *Response, error)
- func (s *RepositoriesService) ListPreReceiveHooks(ctx context.Context, owner, repo string, opts *ListOptions) ([]*PreReceiveHook, *Response, error)
- func (s *RepositoriesService) ListProjects(ctx context.Context, owner, repo string, opts *ProjectListOptions) ([]*Project, *Response, error)
- func (s *RepositoriesService) ListPunchCard(ctx context.Context, owner, repo string) ([]*PunchCard, *Response, error)
- func (s *RepositoriesService) ListReleaseAssets(ctx context.Context, owner, repo string, id int64, opts *ListOptions) ([]*ReleaseAsset, *Response, error)
- func (s *RepositoriesService) ListReleases(ctx context.Context, owner, repo string, opts *ListOptions) ([]*RepositoryRelease, *Response, error)
- func (s *RepositoriesService) ListRequiredStatusChecksContexts(ctx context.Context, owner, repo, branch string) (contexts []string, resp *Response, err error)
- func (s *RepositoriesService) ListStatuses(ctx context.Context, owner, repo, ref string, opts *ListOptions) ([]*RepoStatus, *Response, error)
- func (s *RepositoriesService) ListTags(ctx context.Context, owner string, repo string, opts *ListOptions) ([]*RepositoryTag, *Response, error)
- func (s *RepositoriesService) ListTeams(ctx context.Context, owner string, repo string, opts *ListOptions) ([]*Team, *Response, error)
- func (s *RepositoriesService) ListTrafficClones(ctx context.Context, owner, repo string, opts *TrafficBreakdownOptions) (*TrafficClones, *Response, error)
- func (s *RepositoriesService) ListTrafficPaths(ctx context.Context, owner, repo string) ([]*TrafficPath, *Response, error)
- func (s *RepositoriesService) ListTrafficReferrers(ctx context.Context, owner, repo string) ([]*TrafficReferrer, *Response, error)
- func (s *RepositoriesService) ListTrafficViews(ctx context.Context, owner, repo string, opts *TrafficBreakdownOptions) (*TrafficViews, *Response, error)
- func (s *RepositoriesService) Merge(ctx context.Context, owner, repo string, request *RepositoryMergeRequest) (*RepositoryCommit, *Response, error)
- func (s *RepositoriesService) OptionalSignaturesOnProtectedBranch(ctx context.Context, owner, repo, branch string) (*Response, error)
- func (s *RepositoriesService) PingHook(ctx context.Context, owner, repo string, id int64) (*Response, error)
- func (s *RepositoriesService) RemoveAdminEnforcement(ctx context.Context, owner, repo, branch string) (*Response, error)
- func (s *RepositoriesService) RemoveAppRestrictions(ctx context.Context, owner, repo, branch string, slug []string) ([]*App, *Response, error)
- func (s *RepositoriesService) RemoveBranchProtection(ctx context.Context, owner, repo, branch string) (*Response, error)
- func (s *RepositoriesService) RemoveCollaborator(ctx context.Context, owner, repo, user string) (*Response, error)
- func (s *RepositoriesService) RemovePullRequestReviewEnforcement(ctx context.Context, owner, repo, branch string) (*Response, error)
- func (s *RepositoriesService) RemoveRequiredStatusChecks(ctx context.Context, owner, repo, branch string) (*Response, error)
- func (s *RepositoriesService) RenameBranch(ctx context.Context, owner, repo, branch, newName string) (*Branch, *Response, error)
- func (s *RepositoriesService) ReplaceAllTopics(ctx context.Context, owner, repo string, topics []string) ([]string, *Response, error)
- func (s *RepositoriesService) ReplaceAppRestrictions(ctx context.Context, owner, repo, branch string, slug []string) ([]*App, *Response, error)
- func (s *RepositoriesService) RequestPageBuild(ctx context.Context, owner, repo string) (*PagesBuild, *Response, error)
- func (s *RepositoriesService) RequireSignaturesOnProtectedBranch(ctx context.Context, owner, repo, branch string) (*SignaturesProtectedBranch, *Response, error)
- func (s *RepositoriesService) TestHook(ctx context.Context, owner, repo string, id int64) (*Response, error)
- func (s *RepositoriesService) Transfer(ctx context.Context, owner, repo string, transfer TransferRequest) (*Repository, *Response, error)
- func (s *RepositoriesService) UpdateBranchProtection(ctx context.Context, owner, repo, branch string, preq *ProtectionRequest) (*Protection, *Response, error)
- func (s *RepositoriesService) UpdateComment(ctx context.Context, owner, repo string, id int64, comment *RepositoryComment) (*RepositoryComment, *Response, error)
- func (s *RepositoriesService) UpdateFile(ctx context.Context, owner, repo, path string, ...) (*RepositoryContentResponse, *Response, error)
- func (s *RepositoriesService) UpdateInvitation(ctx context.Context, owner, repo string, invitationID int64, ...) (*RepositoryInvitation, *Response, error)
- func (s *RepositoriesService) UpdatePages(ctx context.Context, owner, repo string, opts *PagesUpdate) (*Response, error)
- func (s *RepositoriesService) UpdatePreReceiveHook(ctx context.Context, owner, repo string, id int64, hook *PreReceiveHook) (*PreReceiveHook, *Response, error)
- func (s *RepositoriesService) UpdatePullRequestReviewEnforcement(ctx context.Context, owner, repo, branch string, ...) (*PullRequestReviewsEnforcement, *Response, error)
- func (s *RepositoriesService) UpdateRequiredStatusChecks(ctx context.Context, owner, repo, branch string, ...) (*RequiredStatusChecks, *Response, error)
- func (s *RepositoriesService) UploadReleaseAsset(ctx context.Context, owner, repo string, id int64, opts *UploadOptions, ...) (*ReleaseAsset, *Response, error)
- type Repository
- func (r *Repository) GetAllowAutoMerge() bool
- func (r *Repository) GetAllowForking() bool
- func (r *Repository) GetAllowMergeCommit() bool
- func (r *Repository) GetAllowRebaseMerge() bool
- func (r *Repository) GetAllowSquashMerge() bool
- func (r *Repository) GetArchiveURL() string
- func (r *Repository) GetArchived() bool
- func (r *Repository) GetAssigneesURL() string
- func (r *Repository) GetAutoInit() bool
- func (r *Repository) GetBlobsURL() string
- func (r *Repository) GetBranchesURL() string
- func (r *Repository) GetCloneURL() string
- func (r *Repository) GetCodeOfConduct() *CodeOfConduct
- func (r *Repository) GetCollaboratorsURL() string
- func (r *Repository) GetCommentsURL() string
- func (r *Repository) GetCommitsURL() string
- func (r *Repository) GetCompareURL() string
- func (r *Repository) GetContentsURL() string
- func (r *Repository) GetContributorsURL() string
- func (r *Repository) GetCreatedAt() Timestamp
- func (r *Repository) GetDefaultBranch() string
- func (r *Repository) GetDeleteBranchOnMerge() bool
- func (r *Repository) GetDeploymentsURL() string
- func (r *Repository) GetDescription() string
- func (r *Repository) GetDisabled() bool
- func (r *Repository) GetDownloadsURL() string
- func (r *Repository) GetEventsURL() string
- func (r *Repository) GetFork() bool
- func (r *Repository) GetForksCount() int
- func (r *Repository) GetForksURL() string
- func (r *Repository) GetFullName() string
- func (r *Repository) GetGitCommitsURL() string
- func (r *Repository) GetGitRefsURL() string
- func (r *Repository) GetGitTagsURL() string
- func (r *Repository) GetGitURL() string
- func (r *Repository) GetGitignoreTemplate() string
- func (r *Repository) GetHTMLURL() string
- func (r *Repository) GetHasDownloads() bool
- func (r *Repository) GetHasIssues() bool
- func (r *Repository) GetHasPages() bool
- func (r *Repository) GetHasProjects() bool
- func (r *Repository) GetHasWiki() bool
- func (r *Repository) GetHomepage() string
- func (r *Repository) GetHooksURL() string
- func (r *Repository) GetID() int64
- func (r *Repository) GetIsTemplate() bool
- func (r *Repository) GetIssueCommentURL() string
- func (r *Repository) GetIssueEventsURL() string
- func (r *Repository) GetIssuesURL() string
- func (r *Repository) GetKeysURL() string
- func (r *Repository) GetLabelsURL() string
- func (r *Repository) GetLanguage() string
- func (r *Repository) GetLanguagesURL() string
- func (r *Repository) GetLicense() *License
- func (r *Repository) GetLicenseTemplate() string
- func (r *Repository) GetMasterBranch() string
- func (r *Repository) GetMergesURL() string
- func (r *Repository) GetMilestonesURL() string
- func (r *Repository) GetMirrorURL() string
- func (r *Repository) GetName() string
- func (r *Repository) GetNetworkCount() int
- func (r *Repository) GetNodeID() string
- func (r *Repository) GetNotificationsURL() string
- func (r *Repository) GetOpenIssues() int
- func (r *Repository) GetOpenIssuesCount() int
- func (r *Repository) GetOrganization() *Organization
- func (r *Repository) GetOwner() *User
- func (r *Repository) GetParent() *Repository
- func (r *Repository) GetPermissions() map[string]bool
- func (r *Repository) GetPrivate() bool
- func (r *Repository) GetPullsURL() string
- func (r *Repository) GetPushedAt() Timestamp
- func (r *Repository) GetReleasesURL() string
- func (r *Repository) GetSSHURL() string
- func (r *Repository) GetSVNURL() string
- func (r *Repository) GetSecurityAndAnalysis() *SecurityAndAnalysis
- func (r *Repository) GetSize() int
- func (r *Repository) GetSource() *Repository
- func (r *Repository) GetStargazersCount() int
- func (r *Repository) GetStargazersURL() string
- func (r *Repository) GetStatusesURL() string
- func (r *Repository) GetSubscribersCount() int
- func (r *Repository) GetSubscribersURL() string
- func (r *Repository) GetSubscriptionURL() string
- func (r *Repository) GetTagsURL() string
- func (r *Repository) GetTeamID() int64
- func (r *Repository) GetTeamsURL() string
- func (r *Repository) GetTemplateRepository() *Repository
- func (r *Repository) GetTreesURL() string
- func (r *Repository) GetURL() string
- func (r *Repository) GetUpdatedAt() Timestamp
- func (r *Repository) GetVisibility() string
- func (r *Repository) GetWatchers() int
- func (r *Repository) GetWatchersCount() int
- func (r Repository) String() string
- type RepositoryActiveCommitters
- type RepositoryAddCollaboratorOptions
- type RepositoryComment
- func (r *RepositoryComment) GetBody() string
- func (r *RepositoryComment) GetCommitID() string
- func (r *RepositoryComment) GetCreatedAt() time.Time
- func (r *RepositoryComment) GetHTMLURL() string
- func (r *RepositoryComment) GetID() int64
- func (r *RepositoryComment) GetNodeID() string
- func (r *RepositoryComment) GetPath() string
- func (r *RepositoryComment) GetPosition() int
- func (r *RepositoryComment) GetReactions() *Reactions
- func (r *RepositoryComment) GetURL() string
- func (r *RepositoryComment) GetUpdatedAt() time.Time
- func (r *RepositoryComment) GetUser() *User
- func (r RepositoryComment) String() string
- type RepositoryCommit
- func (r *RepositoryCommit) GetAuthor() *User
- func (r *RepositoryCommit) GetCommentsURL() string
- func (r *RepositoryCommit) GetCommit() *Commit
- func (r *RepositoryCommit) GetCommitter() *User
- func (r *RepositoryCommit) GetHTMLURL() string
- func (r *RepositoryCommit) GetNodeID() string
- func (r *RepositoryCommit) GetSHA() string
- func (r *RepositoryCommit) GetStats() *CommitStats
- func (r *RepositoryCommit) GetURL() string
- func (r RepositoryCommit) String() string
- type RepositoryContent
- func (r *RepositoryContent) GetContent() (string, error)
- func (r *RepositoryContent) GetDownloadURL() string
- func (r *RepositoryContent) GetEncoding() string
- func (r *RepositoryContent) GetGitURL() string
- func (r *RepositoryContent) GetHTMLURL() string
- func (r *RepositoryContent) GetName() string
- func (r *RepositoryContent) GetPath() string
- func (r *RepositoryContent) GetSHA() string
- func (r *RepositoryContent) GetSize() int
- func (r *RepositoryContent) GetTarget() string
- func (r *RepositoryContent) GetType() string
- func (r *RepositoryContent) GetURL() string
- func (r RepositoryContent) String() string
- type RepositoryContentFileOptions
- func (r *RepositoryContentFileOptions) GetAuthor() *CommitAuthor
- func (r *RepositoryContentFileOptions) GetBranch() string
- func (r *RepositoryContentFileOptions) GetCommitter() *CommitAuthor
- func (r *RepositoryContentFileOptions) GetMessage() string
- func (r *RepositoryContentFileOptions) GetSHA() string
- type RepositoryContentGetOptions
- type RepositoryContentResponse
- type RepositoryCreateForkOptions
- type RepositoryDispatchEvent
- func (r *RepositoryDispatchEvent) GetAction() string
- func (r *RepositoryDispatchEvent) GetBranch() string
- func (r *RepositoryDispatchEvent) GetInstallation() *Installation
- func (r *RepositoryDispatchEvent) GetOrg() *Organization
- func (r *RepositoryDispatchEvent) GetRepo() *Repository
- func (r *RepositoryDispatchEvent) GetSender() *User
- type RepositoryEvent
- type RepositoryInvitation
- func (r *RepositoryInvitation) GetCreatedAt() Timestamp
- func (r *RepositoryInvitation) GetHTMLURL() string
- func (r *RepositoryInvitation) GetID() int64
- func (r *RepositoryInvitation) GetInvitee() *User
- func (r *RepositoryInvitation) GetInviter() *User
- func (r *RepositoryInvitation) GetPermissions() string
- func (r *RepositoryInvitation) GetRepo() *Repository
- func (r *RepositoryInvitation) GetURL() string
- type RepositoryLicense
- func (r *RepositoryLicense) GetContent() string
- func (r *RepositoryLicense) GetDownloadURL() string
- func (r *RepositoryLicense) GetEncoding() string
- func (r *RepositoryLicense) GetGitURL() string
- func (r *RepositoryLicense) GetHTMLURL() string
- func (r *RepositoryLicense) GetLicense() *License
- func (r *RepositoryLicense) GetName() string
- func (r *RepositoryLicense) GetPath() string
- func (r *RepositoryLicense) GetSHA() string
- func (r *RepositoryLicense) GetSize() int
- func (r *RepositoryLicense) GetType() string
- func (r *RepositoryLicense) GetURL() string
- func (l RepositoryLicense) String() string
- type RepositoryListAllOptions
- type RepositoryListByOrgOptions
- type RepositoryListForksOptions
- type RepositoryListOptions
- type RepositoryMergeRequest
- type RepositoryParticipation
- type RepositoryPermissionLevel
- type RepositoryRelease
- func (r *RepositoryRelease) GetAssetsURL() string
- func (r *RepositoryRelease) GetAuthor() *User
- func (r *RepositoryRelease) GetBody() string
- func (r *RepositoryRelease) GetCreatedAt() Timestamp
- func (r *RepositoryRelease) GetDiscussionCategoryName() string
- func (r *RepositoryRelease) GetDraft() bool
- func (r *RepositoryRelease) GetGenerateReleaseNotes() bool
- func (r *RepositoryRelease) GetHTMLURL() string
- func (r *RepositoryRelease) GetID() int64
- func (r *RepositoryRelease) GetName() string
- func (r *RepositoryRelease) GetNodeID() string
- func (r *RepositoryRelease) GetPrerelease() bool
- func (r *RepositoryRelease) GetPublishedAt() Timestamp
- func (r *RepositoryRelease) GetTagName() string
- func (r *RepositoryRelease) GetTarballURL() string
- func (r *RepositoryRelease) GetTargetCommitish() string
- func (r *RepositoryRelease) GetURL() string
- func (r *RepositoryRelease) GetUploadURL() string
- func (r *RepositoryRelease) GetZipballURL() string
- func (r RepositoryRelease) String() string
- type RepositoryReleaseNotes
- type RepositoryTag
- type RepositoryVulnerabilityAlert
- func (r *RepositoryVulnerabilityAlert) GetAffectedPackageName() string
- func (r *RepositoryVulnerabilityAlert) GetAffectedRange() string
- func (r *RepositoryVulnerabilityAlert) GetCreatedAt() Timestamp
- func (r *RepositoryVulnerabilityAlert) GetDismissReason() string
- func (r *RepositoryVulnerabilityAlert) GetDismissedAt() Timestamp
- func (r *RepositoryVulnerabilityAlert) GetDismisser() *User
- func (r *RepositoryVulnerabilityAlert) GetExternalIdentifier() string
- func (r *RepositoryVulnerabilityAlert) GetExternalReference() string
- func (r *RepositoryVulnerabilityAlert) GetFixedIn() string
- func (r *RepositoryVulnerabilityAlert) GetGitHubSecurityAdvisoryID() string
- func (r *RepositoryVulnerabilityAlert) GetID() int64
- func (r *RepositoryVulnerabilityAlert) GetSeverity() string
- type RepositoryVulnerabilityAlertEvent
- type RequestedAction
- type RequireLinearHistory
- type RequiredConversationResolution
- type RequiredReviewer
- type RequiredStatusCheck
- type RequiredStatusChecks
- type RequiredStatusChecksRequest
- type Response
- type Reviewers
- type ReviewersRequest
- type Rule
- type Runner
- type RunnerApplicationDownload
- func (r *RunnerApplicationDownload) GetArchitecture() string
- func (r *RunnerApplicationDownload) GetDownloadURL() string
- func (r *RunnerApplicationDownload) GetFilename() string
- func (r *RunnerApplicationDownload) GetOS() string
- func (r *RunnerApplicationDownload) GetSHA256Checksum() string
- func (r *RunnerApplicationDownload) GetTempDownloadToken() string
- type RunnerGroup
- func (r *RunnerGroup) GetAllowsPublicRepositories() bool
- func (r *RunnerGroup) GetDefault() bool
- func (r *RunnerGroup) GetID() int64
- func (r *RunnerGroup) GetInherited() bool
- func (r *RunnerGroup) GetName() string
- func (r *RunnerGroup) GetRunnersURL() string
- func (r *RunnerGroup) GetSelectedRepositoriesURL() string
- func (r *RunnerGroup) GetVisibility() string
- type RunnerGroups
- type RunnerLabels
- type Runners
- type SCIMService
- func (s *SCIMService) DeleteSCIMUserFromOrg(ctx context.Context, org, scimUserID string) (*Response, error)
- func (s *SCIMService) GetSCIMProvisioningInfoForUser(ctx context.Context, org, scimUserID string) (*Response, error)
- func (s *SCIMService) ListSCIMProvisionedIdentities(ctx context.Context, org string, opts *ListSCIMProvisionedIdentitiesOptions) (*Response, error)
- func (s *SCIMService) ProvisionAndInviteSCIMUser(ctx context.Context, org string, opts *SCIMUserAttributes) (*Response, error)
- func (s *SCIMService) UpdateAttributeForSCIMUser(ctx context.Context, org, scimUserID string, ...) (*Response, error)
- func (s *SCIMService) UpdateProvisionedOrgMembership(ctx context.Context, org, scimUserID string, opts *SCIMUserAttributes) (*Response, error)
- type SCIMUserAttributes
- type SCIMUserEmail
- type SCIMUserName
- type SarifAnalysis
- type SarifID
- type ScanningAnalysis
- func (s *ScanningAnalysis) GetAnalysisKey() string
- func (s *ScanningAnalysis) GetCategory() string
- func (s *ScanningAnalysis) GetCommitSHA() string
- func (s *ScanningAnalysis) GetCreatedAt() Timestamp
- func (s *ScanningAnalysis) GetDeletable() bool
- func (s *ScanningAnalysis) GetEnvironment() string
- func (s *ScanningAnalysis) GetError() string
- func (s *ScanningAnalysis) GetID() int64
- func (s *ScanningAnalysis) GetRef() string
- func (s *ScanningAnalysis) GetResultsCount() int
- func (s *ScanningAnalysis) GetRulesCount() int
- func (s *ScanningAnalysis) GetSarifID() string
- func (s *ScanningAnalysis) GetTool() *Tool
- func (s *ScanningAnalysis) GetURL() string
- func (s *ScanningAnalysis) GetWarning() string
- type Scope
- type SearchOptions
- type SearchService
- func (s *SearchService) Code(ctx context.Context, query string, opts *SearchOptions) (*CodeSearchResult, *Response, error)
- func (s *SearchService) Commits(ctx context.Context, query string, opts *SearchOptions) (*CommitsSearchResult, *Response, error)
- func (s *SearchService) Issues(ctx context.Context, query string, opts *SearchOptions) (*IssuesSearchResult, *Response, error)
- func (s *SearchService) Labels(ctx context.Context, repoID int64, query string, opts *SearchOptions) (*LabelsSearchResult, *Response, error)
- func (s *SearchService) Repositories(ctx context.Context, query string, opts *SearchOptions) (*RepositoriesSearchResult, *Response, error)
- func (s *SearchService) Topics(ctx context.Context, query string, opts *SearchOptions) (*TopicsSearchResult, *Response, error)
- func (s *SearchService) Users(ctx context.Context, query string, opts *SearchOptions) (*UsersSearchResult, *Response, error)
- type Secret
- type SecretScanning
- type SecretScanningAlert
- func (s *SecretScanningAlert) GetCreatedAt() Timestamp
- func (s *SecretScanningAlert) GetHTMLURL() string
- func (s *SecretScanningAlert) GetLocationsURL() string
- func (s *SecretScanningAlert) GetNumber() int
- func (s *SecretScanningAlert) GetResolution() string
- func (s *SecretScanningAlert) GetResolvedAt() Timestamp
- func (s *SecretScanningAlert) GetResolvedBy() *User
- func (s *SecretScanningAlert) GetSecret() string
- func (s *SecretScanningAlert) GetSecretType() string
- func (s *SecretScanningAlert) GetState() string
- func (s *SecretScanningAlert) GetURL() string
- type SecretScanningAlertEvent
- func (s *SecretScanningAlertEvent) GetAction() string
- func (s *SecretScanningAlertEvent) GetAlert() *SecretScanningAlert
- func (s *SecretScanningAlertEvent) GetEnterprise() *Enterprise
- func (s *SecretScanningAlertEvent) GetInstallation() *Installation
- func (s *SecretScanningAlertEvent) GetOrganization() *Organization
- func (s *SecretScanningAlertEvent) GetRepo() *Repository
- func (s *SecretScanningAlertEvent) GetSender() *User
- type SecretScanningAlertListOptions
- type SecretScanningAlertLocation
- type SecretScanningAlertLocationDetails
- func (s *SecretScanningAlertLocationDetails) GetBlobSHA() string
- func (s *SecretScanningAlertLocationDetails) GetBlobURL() string
- func (s *SecretScanningAlertLocationDetails) GetCommitSHA() string
- func (s *SecretScanningAlertLocationDetails) GetCommitURL() string
- func (s *SecretScanningAlertLocationDetails) GetEndColumn() int
- func (s *SecretScanningAlertLocationDetails) GetEndLine() int
- func (s *SecretScanningAlertLocationDetails) GetPath() string
- func (s *SecretScanningAlertLocationDetails) GetStartColumn() int
- func (s *SecretScanningAlertLocationDetails) GetStartline() int
- type SecretScanningAlertUpdateOptions
- type SecretScanningService
- func (s *SecretScanningService) GetAlert(ctx context.Context, owner, repo string, number int64) (*SecretScanningAlert, *Response, error)
- func (s *SecretScanningService) ListAlertsForEnterprise(ctx context.Context, enterprise string, opts *SecretScanningAlertListOptions) ([]*SecretScanningAlert, *Response, error)
- func (s *SecretScanningService) ListAlertsForOrg(ctx context.Context, org string, opts *SecretScanningAlertListOptions) ([]*SecretScanningAlert, *Response, error)
- func (s *SecretScanningService) ListAlertsForRepo(ctx context.Context, owner, repo string, opts *SecretScanningAlertListOptions) ([]*SecretScanningAlert, *Response, error)
- func (s *SecretScanningService) ListLocationsForAlert(ctx context.Context, owner, repo string, number int64, opts *ListOptions) ([]*SecretScanningAlertLocation, *Response, error)
- func (s *SecretScanningService) UpdateAlert(ctx context.Context, owner, repo string, number int64, ...) (*SecretScanningAlert, *Response, error)
- type Secrets
- type SecurityAndAnalysis
- type SelectedRepoIDs
- type SelectedReposList
- type ServiceHook
- type SetRepoAccessRunnerGroupRequest
- type SetRunnerGroupRunnersRequest
- type SignatureVerification
- type SignaturesProtectedBranch
- type Source
- type SourceImportAuthor
- func (s *SourceImportAuthor) GetEmail() string
- func (s *SourceImportAuthor) GetID() int64
- func (s *SourceImportAuthor) GetImportURL() string
- func (s *SourceImportAuthor) GetName() string
- func (s *SourceImportAuthor) GetRemoteID() string
- func (s *SourceImportAuthor) GetRemoteName() string
- func (s *SourceImportAuthor) GetURL() string
- func (a SourceImportAuthor) String() string
- type StarEvent
- type Stargazer
- type StarredRepository
- type StatusEvent
- func (s *StatusEvent) GetCommit() *RepositoryCommit
- func (s *StatusEvent) GetContext() string
- func (s *StatusEvent) GetCreatedAt() Timestamp
- func (s *StatusEvent) GetDescription() string
- func (s *StatusEvent) GetID() int64
- func (s *StatusEvent) GetInstallation() *Installation
- func (s *StatusEvent) GetName() string
- func (s *StatusEvent) GetRepo() *Repository
- func (s *StatusEvent) GetSHA() string
- func (s *StatusEvent) GetSender() *User
- func (s *StatusEvent) GetState() string
- func (s *StatusEvent) GetTargetURL() string
- func (s *StatusEvent) GetUpdatedAt() Timestamp
- type StorageBilling
- type Subscription
- func (s *Subscription) GetCreatedAt() Timestamp
- func (s *Subscription) GetIgnored() bool
- func (s *Subscription) GetReason() string
- func (s *Subscription) GetRepositoryURL() string
- func (s *Subscription) GetSubscribed() bool
- func (s *Subscription) GetThreadURL() string
- func (s *Subscription) GetURL() string
- type Tag
- type TaskStep
- type Team
- func (t *Team) GetDescription() string
- func (t *Team) GetHTMLURL() string
- func (t *Team) GetID() int64
- func (t *Team) GetLDAPDN() string
- func (t *Team) GetMembersCount() int
- func (t *Team) GetMembersURL() string
- func (t *Team) GetName() string
- func (t *Team) GetNodeID() string
- func (t *Team) GetOrganization() *Organization
- func (t *Team) GetParent() *Team
- func (t *Team) GetPermission() string
- func (t *Team) GetPermissions() map[string]bool
- func (t *Team) GetPrivacy() string
- func (t *Team) GetReposCount() int
- func (t *Team) GetRepositoriesURL() string
- func (t *Team) GetSlug() string
- func (t *Team) GetURL() string
- func (t Team) String() string
- type TeamAddEvent
- type TeamAddTeamMembershipOptions
- type TeamAddTeamRepoOptions
- type TeamChange
- type TeamDescription
- type TeamDiscussion
- func (t *TeamDiscussion) GetAuthor() *User
- func (t *TeamDiscussion) GetBody() string
- func (t *TeamDiscussion) GetBodyHTML() string
- func (t *TeamDiscussion) GetBodyVersion() string
- func (t *TeamDiscussion) GetCommentsCount() int
- func (t *TeamDiscussion) GetCommentsURL() string
- func (t *TeamDiscussion) GetCreatedAt() Timestamp
- func (t *TeamDiscussion) GetHTMLURL() string
- func (t *TeamDiscussion) GetLastEditedAt() Timestamp
- func (t *TeamDiscussion) GetNodeID() string
- func (t *TeamDiscussion) GetNumber() int
- func (t *TeamDiscussion) GetPinned() bool
- func (t *TeamDiscussion) GetPrivate() bool
- func (t *TeamDiscussion) GetReactions() *Reactions
- func (t *TeamDiscussion) GetTeamURL() string
- func (t *TeamDiscussion) GetTitle() string
- func (t *TeamDiscussion) GetURL() string
- func (t *TeamDiscussion) GetUpdatedAt() Timestamp
- func (d TeamDiscussion) String() string
- type TeamEvent
- type TeamLDAPMapping
- func (t *TeamLDAPMapping) GetDescription() string
- func (t *TeamLDAPMapping) GetID() int64
- func (t *TeamLDAPMapping) GetLDAPDN() string
- func (t *TeamLDAPMapping) GetMembersURL() string
- func (t *TeamLDAPMapping) GetName() string
- func (t *TeamLDAPMapping) GetPermission() string
- func (t *TeamLDAPMapping) GetPrivacy() string
- func (t *TeamLDAPMapping) GetRepositoriesURL() string
- func (t *TeamLDAPMapping) GetSlug() string
- func (t *TeamLDAPMapping) GetURL() string
- func (m TeamLDAPMapping) String() string
- type TeamListTeamMembersOptions
- type TeamName
- type TeamPermissions
- type TeamPermissionsFrom
- type TeamPrivacy
- type TeamProjectOptions
- type TeamRepository
- type TeamsService
- func (s *TeamsService) AddTeamMembershipByID(ctx context.Context, orgID, teamID int64, user string, ...) (*Membership, *Response, error)
- func (s *TeamsService) AddTeamMembershipBySlug(ctx context.Context, org, slug, user string, ...) (*Membership, *Response, error)
- func (s *TeamsService) AddTeamProjectByID(ctx context.Context, orgID, teamID, projectID int64, opts *TeamProjectOptions) (*Response, error)
- func (s *TeamsService) AddTeamProjectBySlug(ctx context.Context, org, slug string, projectID int64, ...) (*Response, error)
- func (s *TeamsService) AddTeamRepoByID(ctx context.Context, orgID, teamID int64, owner, repo string, ...) (*Response, error)
- func (s *TeamsService) AddTeamRepoBySlug(ctx context.Context, org, slug, owner, repo string, ...) (*Response, error)
- func (s *TeamsService) CreateCommentByID(ctx context.Context, orgID, teamID int64, discsusionNumber int, ...) (*DiscussionComment, *Response, error)
- func (s *TeamsService) CreateCommentBySlug(ctx context.Context, org, slug string, discsusionNumber int, ...) (*DiscussionComment, *Response, error)
- func (s *TeamsService) CreateDiscussionByID(ctx context.Context, orgID, teamID int64, discussion TeamDiscussion) (*TeamDiscussion, *Response, error)
- func (s *TeamsService) CreateDiscussionBySlug(ctx context.Context, org, slug string, discussion TeamDiscussion) (*TeamDiscussion, *Response, error)
- func (s *TeamsService) CreateOrUpdateIDPGroupConnectionsByID(ctx context.Context, orgID, teamID int64, opts IDPGroupList) (*IDPGroupList, *Response, error)
- func (s *TeamsService) CreateOrUpdateIDPGroupConnectionsBySlug(ctx context.Context, org, slug string, opts IDPGroupList) (*IDPGroupList, *Response, error)
- func (s *TeamsService) CreateTeam(ctx context.Context, org string, team NewTeam) (*Team, *Response, error)
- func (s *TeamsService) DeleteCommentByID(ctx context.Context, orgID, teamID int64, discussionNumber, commentNumber int) (*Response, error)
- func (s *TeamsService) DeleteCommentBySlug(ctx context.Context, org, slug string, discussionNumber, commentNumber int) (*Response, error)
- func (s *TeamsService) DeleteDiscussionByID(ctx context.Context, orgID, teamID int64, discussionNumber int) (*Response, error)
- func (s *TeamsService) DeleteDiscussionBySlug(ctx context.Context, org, slug string, discussionNumber int) (*Response, error)
- func (s *TeamsService) DeleteTeamByID(ctx context.Context, orgID, teamID int64) (*Response, error)
- func (s *TeamsService) DeleteTeamBySlug(ctx context.Context, org, slug string) (*Response, error)
- func (s *TeamsService) EditCommentByID(ctx context.Context, orgID, teamID int64, discussionNumber, commentNumber int, ...) (*DiscussionComment, *Response, error)
- func (s *TeamsService) EditCommentBySlug(ctx context.Context, org, slug string, discussionNumber, commentNumber int, ...) (*DiscussionComment, *Response, error)
- func (s *TeamsService) EditDiscussionByID(ctx context.Context, orgID, teamID int64, discussionNumber int, ...) (*TeamDiscussion, *Response, error)
- func (s *TeamsService) EditDiscussionBySlug(ctx context.Context, org, slug string, discussionNumber int, ...) (*TeamDiscussion, *Response, error)
- func (s *TeamsService) EditTeamByID(ctx context.Context, orgID, teamID int64, team NewTeam, removeParent bool) (*Team, *Response, error)
- func (s *TeamsService) EditTeamBySlug(ctx context.Context, org, slug string, team NewTeam, removeParent bool) (*Team, *Response, error)
- func (s *TeamsService) GetCommentByID(ctx context.Context, orgID, teamID int64, discussionNumber, commentNumber int) (*DiscussionComment, *Response, error)
- func (s *TeamsService) GetCommentBySlug(ctx context.Context, org, slug string, discussionNumber, commentNumber int) (*DiscussionComment, *Response, error)
- func (s *TeamsService) GetDiscussionByID(ctx context.Context, orgID, teamID int64, discussionNumber int) (*TeamDiscussion, *Response, error)
- func (s *TeamsService) GetDiscussionBySlug(ctx context.Context, org, slug string, discussionNumber int) (*TeamDiscussion, *Response, error)
- func (s *TeamsService) GetExternalGroup(ctx context.Context, org string, groupID int64) (*ExternalGroup, *Response, error)
- func (s *TeamsService) GetTeamByID(ctx context.Context, orgID, teamID int64) (*Team, *Response, error)
- func (s *TeamsService) GetTeamBySlug(ctx context.Context, org, slug string) (*Team, *Response, error)
- func (s *TeamsService) GetTeamMembershipByID(ctx context.Context, orgID, teamID int64, user string) (*Membership, *Response, error)
- func (s *TeamsService) GetTeamMembershipBySlug(ctx context.Context, org, slug, user string) (*Membership, *Response, error)
- func (s *TeamsService) IsTeamRepoByID(ctx context.Context, orgID, teamID int64, owner, repo string) (*Repository, *Response, error)
- func (s *TeamsService) IsTeamRepoBySlug(ctx context.Context, org, slug, owner, repo string) (*Repository, *Response, error)
- func (s *TeamsService) ListChildTeamsByParentID(ctx context.Context, orgID, teamID int64, opts *ListOptions) ([]*Team, *Response, error)
- func (s *TeamsService) ListChildTeamsByParentSlug(ctx context.Context, org, slug string, opts *ListOptions) ([]*Team, *Response, error)
- func (s *TeamsService) ListCommentsByID(ctx context.Context, orgID, teamID int64, discussionNumber int, ...) ([]*DiscussionComment, *Response, error)
- func (s *TeamsService) ListCommentsBySlug(ctx context.Context, org, slug string, discussionNumber int, ...) ([]*DiscussionComment, *Response, error)
- func (s *TeamsService) ListDiscussionsByID(ctx context.Context, orgID, teamID int64, opts *DiscussionListOptions) ([]*TeamDiscussion, *Response, error)
- func (s *TeamsService) ListDiscussionsBySlug(ctx context.Context, org, slug string, opts *DiscussionListOptions) ([]*TeamDiscussion, *Response, error)
- func (s *TeamsService) ListExternalGroups(ctx context.Context, org string, opts *ListExternalGroupsOptions) (*ExternalGroupList, *Response, error)
- func (s *TeamsService) ListIDPGroupsForTeamByID(ctx context.Context, orgID, teamID int64) (*IDPGroupList, *Response, error)
- func (s *TeamsService) ListIDPGroupsForTeamBySlug(ctx context.Context, org, slug string) (*IDPGroupList, *Response, error)
- func (s *TeamsService) ListIDPGroupsInOrganization(ctx context.Context, org string, opts *ListCursorOptions) (*IDPGroupList, *Response, error)
- func (s *TeamsService) ListPendingTeamInvitationsByID(ctx context.Context, orgID, teamID int64, opts *ListOptions) ([]*Invitation, *Response, error)
- func (s *TeamsService) ListPendingTeamInvitationsBySlug(ctx context.Context, org, slug string, opts *ListOptions) ([]*Invitation, *Response, error)
- func (s *TeamsService) ListTeamMembersByID(ctx context.Context, orgID, teamID int64, opts *TeamListTeamMembersOptions) ([]*User, *Response, error)
- func (s *TeamsService) ListTeamMembersBySlug(ctx context.Context, org, slug string, opts *TeamListTeamMembersOptions) ([]*User, *Response, error)
- func (s *TeamsService) ListTeamProjectsByID(ctx context.Context, orgID, teamID int64) ([]*Project, *Response, error)
- func (s *TeamsService) ListTeamProjectsBySlug(ctx context.Context, org, slug string) ([]*Project, *Response, error)
- func (s *TeamsService) ListTeamReposByID(ctx context.Context, orgID, teamID int64, opts *ListOptions) ([]*Repository, *Response, error)
- func (s *TeamsService) ListTeamReposBySlug(ctx context.Context, org, slug string, opts *ListOptions) ([]*Repository, *Response, error)
- func (s *TeamsService) ListTeams(ctx context.Context, org string, opts *ListOptions) ([]*Team, *Response, error)
- func (s *TeamsService) ListUserTeams(ctx context.Context, opts *ListOptions) ([]*Team, *Response, error)
- func (s *TeamsService) RemoveConnectedExternalGroup(ctx context.Context, org, slug string) (*Response, error)
- func (s *TeamsService) RemoveTeamMembershipByID(ctx context.Context, orgID, teamID int64, user string) (*Response, error)
- func (s *TeamsService) RemoveTeamMembershipBySlug(ctx context.Context, org, slug, user string) (*Response, error)
- func (s *TeamsService) RemoveTeamProjectByID(ctx context.Context, orgID, teamID, projectID int64) (*Response, error)
- func (s *TeamsService) RemoveTeamProjectBySlug(ctx context.Context, org, slug string, projectID int64) (*Response, error)
- func (s *TeamsService) RemoveTeamRepoByID(ctx context.Context, orgID, teamID int64, owner, repo string) (*Response, error)
- func (s *TeamsService) RemoveTeamRepoBySlug(ctx context.Context, org, slug, owner, repo string) (*Response, error)
- func (s *TeamsService) ReviewTeamProjectsByID(ctx context.Context, orgID, teamID, projectID int64) (*Project, *Response, error)
- func (s *TeamsService) ReviewTeamProjectsBySlug(ctx context.Context, org, slug string, projectID int64) (*Project, *Response, error)
- func (s *TeamsService) UpdateConnectedExternalGroup(ctx context.Context, org, slug string, eg *ExternalGroup) (*ExternalGroup, *Response, error)
- type TemplateRepoRequest
- type TextMatch
- type Timeline
- func (t *Timeline) GetActor() *User
- func (t *Timeline) GetAssignee() *User
- func (t *Timeline) GetAssigner() *User
- func (t *Timeline) GetAuthor() *CommitAuthor
- func (t *Timeline) GetBody() string
- func (t *Timeline) GetCommitID() string
- func (t *Timeline) GetCommitURL() string
- func (t *Timeline) GetCommitter() *CommitAuthor
- func (t *Timeline) GetCreatedAt() time.Time
- func (t *Timeline) GetEvent() string
- func (t *Timeline) GetID() int64
- func (t *Timeline) GetLabel() *Label
- func (t *Timeline) GetMessage() string
- func (t *Timeline) GetMilestone() *Milestone
- func (t *Timeline) GetProjectCard() *ProjectCard
- func (t *Timeline) GetRename() *Rename
- func (t *Timeline) GetRequester() *User
- func (t *Timeline) GetReviewer() *User
- func (t *Timeline) GetSHA() string
- func (t *Timeline) GetSource() *Source
- func (t *Timeline) GetState() string
- func (t *Timeline) GetSubmittedAt() time.Time
- func (t *Timeline) GetURL() string
- func (t *Timeline) GetUser() *User
- type Timestamp
- type Tool
- type TopicResult
- func (t *TopicResult) GetCreatedAt() Timestamp
- func (t *TopicResult) GetCreatedBy() string
- func (t *TopicResult) GetCurated() bool
- func (t *TopicResult) GetDescription() string
- func (t *TopicResult) GetDisplayName() string
- func (t *TopicResult) GetFeatured() bool
- func (t *TopicResult) GetName() string
- func (t *TopicResult) GetScore() *float64
- func (t *TopicResult) GetShortDescription() string
- func (t *TopicResult) GetUpdatedAt() string
- type TopicsSearchResult
- type TrafficBreakdownOptions
- type TrafficClones
- type TrafficData
- type TrafficPath
- type TrafficReferrer
- type TrafficViews
- type TransferRequest
- type Tree
- type TreeEntry
- func (t *TreeEntry) GetContent() string
- func (t *TreeEntry) GetMode() string
- func (t *TreeEntry) GetPath() string
- func (t *TreeEntry) GetSHA() string
- func (t *TreeEntry) GetSize() int
- func (t *TreeEntry) GetType() string
- func (t *TreeEntry) GetURL() string
- func (t *TreeEntry) MarshalJSON() ([]byte, error)
- func (t TreeEntry) String() string
- type TwoFactorAuthError
- type UnauthenticatedRateLimitedTransport
- type UpdateAttributeForSCIMUserOperations
- type UpdateAttributeForSCIMUserOptions
- type UpdateCheckRunOptions
- func (u *UpdateCheckRunOptions) GetCompletedAt() Timestamp
- func (u *UpdateCheckRunOptions) GetConclusion() string
- func (u *UpdateCheckRunOptions) GetDetailsURL() string
- func (u *UpdateCheckRunOptions) GetExternalID() string
- func (u *UpdateCheckRunOptions) GetOutput() *CheckRunOutput
- func (u *UpdateCheckRunOptions) GetStatus() string
- type UpdateRunnerGroupRequest
- type UploadOptions
- type User
- func (u *User) GetAvatarURL() string
- func (u *User) GetBio() string
- func (u *User) GetBlog() string
- func (u *User) GetCollaborators() int
- func (u *User) GetCompany() string
- func (u *User) GetCreatedAt() Timestamp
- func (u *User) GetDiskUsage() int
- func (u *User) GetEmail() string
- func (u *User) GetEventsURL() string
- func (u *User) GetFollowers() int
- func (u *User) GetFollowersURL() string
- func (u *User) GetFollowing() int
- func (u *User) GetFollowingURL() string
- func (u *User) GetGistsURL() string
- func (u *User) GetGravatarID() string
- func (u *User) GetHTMLURL() string
- func (u *User) GetHireable() bool
- func (u *User) GetID() int64
- func (u *User) GetLdapDn() string
- func (u *User) GetLocation() string
- func (u *User) GetLogin() string
- func (u *User) GetName() string
- func (u *User) GetNodeID() string
- func (u *User) GetOrganizationsURL() string
- func (u *User) GetOwnedPrivateRepos() int
- func (u *User) GetPermissions() map[string]bool
- func (u *User) GetPlan() *Plan
- func (u *User) GetPrivateGists() int
- func (u *User) GetPublicGists() int
- func (u *User) GetPublicRepos() int
- func (u *User) GetReceivedEventsURL() string
- func (u *User) GetReposURL() string
- func (u *User) GetSiteAdmin() bool
- func (u *User) GetStarredURL() string
- func (u *User) GetSubscriptionsURL() string
- func (u *User) GetSuspendedAt() Timestamp
- func (u *User) GetTotalPrivateRepos() int
- func (u *User) GetTwitterUsername() string
- func (u *User) GetTwoFactorAuthentication() bool
- func (u *User) GetType() string
- func (u *User) GetURL() string
- func (u *User) GetUpdatedAt() Timestamp
- func (u User) String() string
- type UserAuthorization
- func (u *UserAuthorization) GetApp() *OAuthAPP
- func (u *UserAuthorization) GetCreatedAt() Timestamp
- func (u *UserAuthorization) GetFingerprint() string
- func (u *UserAuthorization) GetHashedToken() string
- func (u *UserAuthorization) GetID() int64
- func (u *UserAuthorization) GetNote() string
- func (u *UserAuthorization) GetNoteURL() string
- func (u *UserAuthorization) GetToken() string
- func (u *UserAuthorization) GetTokenLastEight() string
- func (u *UserAuthorization) GetURL() string
- func (u *UserAuthorization) GetUpdatedAt() Timestamp
- type UserContext
- type UserEmail
- type UserEvent
- type UserLDAPMapping
- func (u *UserLDAPMapping) GetAvatarURL() string
- func (u *UserLDAPMapping) GetEventsURL() string
- func (u *UserLDAPMapping) GetFollowersURL() string
- func (u *UserLDAPMapping) GetFollowingURL() string
- func (u *UserLDAPMapping) GetGistsURL() string
- func (u *UserLDAPMapping) GetGravatarID() string
- func (u *UserLDAPMapping) GetID() int64
- func (u *UserLDAPMapping) GetLDAPDN() string
- func (u *UserLDAPMapping) GetLogin() string
- func (u *UserLDAPMapping) GetOrganizationsURL() string
- func (u *UserLDAPMapping) GetReceivedEventsURL() string
- func (u *UserLDAPMapping) GetReposURL() string
- func (u *UserLDAPMapping) GetSiteAdmin() bool
- func (u *UserLDAPMapping) GetStarredURL() string
- func (u *UserLDAPMapping) GetSubscriptionsURL() string
- func (u *UserLDAPMapping) GetType() string
- func (u *UserLDAPMapping) GetURL() string
- func (m UserLDAPMapping) String() string
- type UserListOptions
- type UserMigration
- func (u *UserMigration) GetCreatedAt() string
- func (u *UserMigration) GetExcludeAttachments() bool
- func (u *UserMigration) GetGUID() string
- func (u *UserMigration) GetID() int64
- func (u *UserMigration) GetLockRepositories() bool
- func (u *UserMigration) GetState() string
- func (u *UserMigration) GetURL() string
- func (u *UserMigration) GetUpdatedAt() string
- func (m UserMigration) String() string
- type UserMigrationOptions
- type UserStats
- type UserSuspendOptions
- type UsersSearchResult
- type UsersService
- func (s *UsersService) AcceptInvitation(ctx context.Context, invitationID int64) (*Response, error)
- func (s *UsersService) AddEmails(ctx context.Context, emails []string) ([]*UserEmail, *Response, error)
- func (s *UsersService) BlockUser(ctx context.Context, user string) (*Response, error)
- func (s *UsersService) CreateGPGKey(ctx context.Context, armoredPublicKey string) (*GPGKey, *Response, error)
- func (s *UsersService) CreateKey(ctx context.Context, key *Key) (*Key, *Response, error)
- func (s *UsersService) CreateProject(ctx context.Context, opts *CreateUserProjectOptions) (*Project, *Response, error)
- func (s *UsersService) DeclineInvitation(ctx context.Context, invitationID int64) (*Response, error)
- func (s *UsersService) DeleteEmails(ctx context.Context, emails []string) (*Response, error)
- func (s *UsersService) DeleteGPGKey(ctx context.Context, id int64) (*Response, error)
- func (s *UsersService) DeleteKey(ctx context.Context, id int64) (*Response, error)
- func (s *UsersService) DeletePackage(ctx context.Context, user, packageType, packageName string) (*Response, error)
- func (s *UsersService) DemoteSiteAdmin(ctx context.Context, user string) (*Response, error)
- func (s *UsersService) Edit(ctx context.Context, user *User) (*User, *Response, error)
- func (s *UsersService) Follow(ctx context.Context, user string) (*Response, error)
- func (s *UsersService) Get(ctx context.Context, user string) (*User, *Response, error)
- func (s *UsersService) GetByID(ctx context.Context, id int64) (*User, *Response, error)
- func (s *UsersService) GetGPGKey(ctx context.Context, id int64) (*GPGKey, *Response, error)
- func (s *UsersService) GetHovercard(ctx context.Context, user string, opts *HovercardOptions) (*Hovercard, *Response, error)
- func (s *UsersService) GetKey(ctx context.Context, id int64) (*Key, *Response, error)
- func (s *UsersService) GetPackage(ctx context.Context, user, packageType, packageName string) (*Package, *Response, error)
- func (s *UsersService) IsBlocked(ctx context.Context, user string) (bool, *Response, error)
- func (s *UsersService) IsFollowing(ctx context.Context, user, target string) (bool, *Response, error)
- func (s *UsersService) ListAll(ctx context.Context, opts *UserListOptions) ([]*User, *Response, error)
- func (s *UsersService) ListBlockedUsers(ctx context.Context, opts *ListOptions) ([]*User, *Response, error)
- func (s *UsersService) ListEmails(ctx context.Context, opts *ListOptions) ([]*UserEmail, *Response, error)
- func (s *UsersService) ListFollowers(ctx context.Context, user string, opts *ListOptions) ([]*User, *Response, error)
- func (s *UsersService) ListFollowing(ctx context.Context, user string, opts *ListOptions) ([]*User, *Response, error)
- func (s *UsersService) ListGPGKeys(ctx context.Context, user string, opts *ListOptions) ([]*GPGKey, *Response, error)
- func (s *UsersService) ListInvitations(ctx context.Context, opts *ListOptions) ([]*RepositoryInvitation, *Response, error)
- func (s *UsersService) ListKeys(ctx context.Context, user string, opts *ListOptions) ([]*Key, *Response, error)
- func (s *UsersService) ListPackages(ctx context.Context, user string, opts *PackageListOptions) ([]*Package, *Response, error)
- func (s *UsersService) ListProjects(ctx context.Context, user string, opts *ProjectListOptions) ([]*Project, *Response, error)
- func (s *UsersService) PackageDeleteVersion(ctx context.Context, user, packageType, packageName string, ...) (*Response, error)
- func (s *UsersService) PackageGetAllVersions(ctx context.Context, user, packageType, packageName string, ...) ([]*PackageVersion, *Response, error)
- func (s *UsersService) PackageGetVersion(ctx context.Context, user, packageType, packageName string, ...) (*PackageVersion, *Response, error)
- func (s *UsersService) PackageRestoreVersion(ctx context.Context, user, packageType, packageName string, ...) (*Response, error)
- func (s *UsersService) PromoteSiteAdmin(ctx context.Context, user string) (*Response, error)
- func (s *UsersService) RestorePackage(ctx context.Context, user, packageType, packageName string) (*Response, error)
- func (s *UsersService) Suspend(ctx context.Context, user string, opts *UserSuspendOptions) (*Response, error)
- func (s *UsersService) UnblockUser(ctx context.Context, user string) (*Response, error)
- func (s *UsersService) Unfollow(ctx context.Context, user string) (*Response, error)
- func (s *UsersService) Unsuspend(ctx context.Context, user string) (*Response, error)
- type WatchEvent
- type WebHookAuthor
- type WebHookCommit
- func (w *WebHookCommit) GetAuthor() *WebHookAuthor
- func (w *WebHookCommit) GetCommitter() *WebHookAuthor
- func (w *WebHookCommit) GetDistinct() bool
- func (w *WebHookCommit) GetID() string
- func (w *WebHookCommit) GetMessage() string
- func (w *WebHookCommit) GetTimestamp() time.Time
- func (w WebHookCommit) String() string
- type WebHookPayload
- func (w *WebHookPayload) GetAction() string
- func (w *WebHookPayload) GetAfter() string
- func (w *WebHookPayload) GetBefore() string
- func (w *WebHookPayload) GetCompare() string
- func (w *WebHookPayload) GetCreated() bool
- func (w *WebHookPayload) GetDeleted() bool
- func (w *WebHookPayload) GetForced() bool
- func (w *WebHookPayload) GetHeadCommit() *WebHookCommit
- func (w *WebHookPayload) GetInstallation() *Installation
- func (w *WebHookPayload) GetOrganization() *Organization
- func (w *WebHookPayload) GetPusher() *User
- func (w *WebHookPayload) GetRef() string
- func (w *WebHookPayload) GetRepo() *Repository
- func (w *WebHookPayload) GetSender() *User
- func (w WebHookPayload) String() string
- type WeeklyCommitActivity
- type WeeklyStats
- type Workflow
- func (w *Workflow) GetBadgeURL() string
- func (w *Workflow) GetCreatedAt() Timestamp
- func (w *Workflow) GetHTMLURL() string
- func (w *Workflow) GetID() int64
- func (w *Workflow) GetName() string
- func (w *Workflow) GetNodeID() string
- func (w *Workflow) GetPath() string
- func (w *Workflow) GetState() string
- func (w *Workflow) GetURL() string
- func (w *Workflow) GetUpdatedAt() Timestamp
- type WorkflowBill
- type WorkflowDispatchEvent
- func (w *WorkflowDispatchEvent) GetInstallation() *Installation
- func (w *WorkflowDispatchEvent) GetOrg() *Organization
- func (w *WorkflowDispatchEvent) GetRef() string
- func (w *WorkflowDispatchEvent) GetRepo() *Repository
- func (w *WorkflowDispatchEvent) GetSender() *User
- func (w *WorkflowDispatchEvent) GetWorkflow() string
- type WorkflowEnvironment
- type WorkflowJob
- func (w *WorkflowJob) GetCheckRunURL() string
- func (w *WorkflowJob) GetCompletedAt() Timestamp
- func (w *WorkflowJob) GetConclusion() string
- func (w *WorkflowJob) GetHTMLURL() string
- func (w *WorkflowJob) GetHeadSHA() string
- func (w *WorkflowJob) GetID() int64
- func (w *WorkflowJob) GetName() string
- func (w *WorkflowJob) GetNodeID() string
- func (w *WorkflowJob) GetRunID() int64
- func (w *WorkflowJob) GetRunURL() string
- func (w *WorkflowJob) GetRunnerGroupID() int64
- func (w *WorkflowJob) GetRunnerGroupName() string
- func (w *WorkflowJob) GetRunnerID() int64
- func (w *WorkflowJob) GetRunnerName() string
- func (w *WorkflowJob) GetStartedAt() Timestamp
- func (w *WorkflowJob) GetStatus() string
- func (w *WorkflowJob) GetURL() string
- type WorkflowJobEvent
- func (w *WorkflowJobEvent) GetAction() string
- func (w *WorkflowJobEvent) GetInstallation() *Installation
- func (w *WorkflowJobEvent) GetOrg() *Organization
- func (w *WorkflowJobEvent) GetRepo() *Repository
- func (w *WorkflowJobEvent) GetSender() *User
- func (w *WorkflowJobEvent) GetWorkflowJob() *WorkflowJob
- type WorkflowRun
- func (w *WorkflowRun) GetArtifactsURL() string
- func (w *WorkflowRun) GetCancelURL() string
- func (w *WorkflowRun) GetCheckSuiteID() int64
- func (w *WorkflowRun) GetCheckSuiteNodeID() string
- func (w *WorkflowRun) GetCheckSuiteURL() string
- func (w *WorkflowRun) GetConclusion() string
- func (w *WorkflowRun) GetCreatedAt() Timestamp
- func (w *WorkflowRun) GetEvent() string
- func (w *WorkflowRun) GetHTMLURL() string
- func (w *WorkflowRun) GetHeadBranch() string
- func (w *WorkflowRun) GetHeadCommit() *HeadCommit
- func (w *WorkflowRun) GetHeadRepository() *Repository
- func (w *WorkflowRun) GetHeadSHA() string
- func (w *WorkflowRun) GetID() int64
- func (w *WorkflowRun) GetJobsURL() string
- func (w *WorkflowRun) GetLogsURL() string
- func (w *WorkflowRun) GetName() string
- func (w *WorkflowRun) GetNodeID() string
- func (w *WorkflowRun) GetPreviousAttemptURL() string
- func (w *WorkflowRun) GetRepository() *Repository
- func (w *WorkflowRun) GetRerunURL() string
- func (w *WorkflowRun) GetRunAttempt() int
- func (w *WorkflowRun) GetRunNumber() int
- func (w *WorkflowRun) GetRunStartedAt() Timestamp
- func (w *WorkflowRun) GetStatus() string
- func (w *WorkflowRun) GetURL() string
- func (w *WorkflowRun) GetUpdatedAt() Timestamp
- func (w *WorkflowRun) GetWorkflowID() int64
- func (w *WorkflowRun) GetWorkflowURL() string
- type WorkflowRunAttemptOptions
- type WorkflowRunBill
- type WorkflowRunEnvironment
- type WorkflowRunEvent
- func (w *WorkflowRunEvent) GetAction() string
- func (w *WorkflowRunEvent) GetInstallation() *Installation
- func (w *WorkflowRunEvent) GetOrg() *Organization
- func (w *WorkflowRunEvent) GetRepo() *Repository
- func (w *WorkflowRunEvent) GetSender() *User
- func (w *WorkflowRunEvent) GetWorkflow() *Workflow
- func (w *WorkflowRunEvent) GetWorkflowRun() *WorkflowRun
- type WorkflowRunJobRun
- type WorkflowRunUsage
- type WorkflowRuns
- type WorkflowUsage
- type Workflows
Examples¶
Constants¶
const (// SHA1SignatureHeader is the GitHub header key used to pass the HMAC-SHA1 hexdigest.SHA1SignatureHeader = "X-Hub-Signature"// SHA256SignatureHeader is the GitHub header key used to pass the HMAC-SHA256 hexdigest.SHA256SignatureHeader = "X-Hub-Signature-256"// EventTypeHeader is the GitHub header key used to pass the event type.EventTypeHeader = "X-Github-Event"// DeliveryIDHeader is the GitHub header key used to pass the unique ID for the webhook event.DeliveryIDHeader = "X-Github-Delivery")
Variables¶
var ErrBranchNotProtected =errors.New("branch is not protected")
var ErrMixedCommentStyles =errors.New("cannot use both position and side/line form comments")
Functions¶
funcBool¶
Bool is a helper routine that allocates a new bool valueto store v and returns a pointer to it.
funcCheckResponse¶
CheckResponse checks the API response for errors, and returns them ifpresent. A response is considered an error if it has a status code outsidethe 200 range or equal to 202 Accepted.API error responses are expected to have responsebody, and a JSON response body that maps to ErrorResponse.
The error type will be *RateLimitError for rate limit exceeded errors,*AcceptedError for 202 Accepted status codes,and *TwoFactorAuthError for two-factor authentication errors.
funcDeliveryID¶
DeliveryID returns the unique delivery ID of webhook request r.
GitHub API docs:https://docs.github.com/en/developers/webhooks-and-events/events/github-event-types
funcInt¶
Int is a helper routine that allocates a new int valueto store v and returns a pointer to it.
funcInt64¶
Int64 is a helper routine that allocates a new int64 valueto store v and returns a pointer to it.
funcParseWebHook¶
ParseWebHook parses the event payload. For recognized event types, avalue of the corresponding struct type will be returned (as returnedby Event.ParsePayload()). An error will be returned for unrecognized eventtypes.
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) ... }}
funcString¶
String is a helper routine that allocates a new string valueto store v and returns a pointer to it.
funcStringify¶
func Stringify(message interface{})string
Stringify attempts to create a reasonable string representation of types inthe GitHub library. It does things like resolve pointers to their valuesand omits struct fields with nil values.
funcValidatePayload¶
ValidatePayload validates an incoming GitHub Webhook event requestand 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.secretToken is the GitHub Webhook secret token.If your webhook does not contain a secret token, you can pass nil or an empty slice.This is intended for local development purposes only and all webhooks should ideally set up a secret token.
Example usage:
func (s *GitHubEventMonitor) ServeHTTP(w http.ResponseWriter, r *http.Request) { payload, err := github.ValidatePayload(r, s.webhookSecretKey) if err != nil { ... } // Process payload...}
funcValidatePayloadFromBody¶
func ValidatePayloadFromBody(contentTypestring, readableio.Reader, signaturestring, secretToken []byte) (payload []byte, errerror)
ValidatePayload validates an incoming GitHub Webhook event request bodyand 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.secretToken is the GitHub Webhook secret token.If your webhook does not contain a secret token, you can pass nil or an empty slice.This is intended for local development purposes only and all webhooks should ideally set up a secret token.
Example usage:
func (s *GitHubEventMonitor) ServeHTTP(w http.ResponseWriter, r *http.Request) { // read signature from request signature := "" payload, err := github.ValidatePayloadFromBody(r.Header.Get("Content-Type"), r.Body, signature, s.webhookSecretKey) if err != nil { ... } // Process payload...}
funcValidateSignature¶
ValidateSignature validates the signature for the given payload.signature is the GitHub hash signature delivered in the X-Hub-Signature header.payload is the JSON payload sent by GitHub Webhooks.secretToken is the GitHub Webhook secret token.
GitHub API docs:https://developer.github.com/webhooks/securing/#validating-payloads-from-github
funcWebHookType¶
WebHookType returns the event type of webhook request r.
GitHub API docs:https://docs.github.com/en/developers/webhooks-and-events/events/github-event-types
Types¶
typeAPIMeta¶
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"`// An array of IP addresses in CIDR format specifying the IP addresses// GitHub Actions will originate from.Actions []string `json:"actions,omitempty"`// An array of IP addresses in CIDR format specifying the IP addresses// Dependabot will originate from.Dependabot []string `json:"dependabot,omitempty"`// A map of algorithms to SSH key fingerprints.SSHKeyFingerprints map[string]string `json:"ssh_key_fingerprints,omitempty"`// An array of SSH keys.SSHKeys []string `json:"ssh_keys,omitempty"`}
APIMeta represents metadata about the GitHub API.
func (*APIMeta)GetSSHKeyFingerprints¶
GetSSHKeyFingerprints returns the SSHKeyFingerprints map if it's non-nil, an empty map otherwise.
func (*APIMeta)GetVerifiablePasswordAuthentication¶
GetVerifiablePasswordAuthentication returns the VerifiablePasswordAuthentication field if it's non-nil, zero value otherwise.
typeAbuseRateLimitError¶
type AbuseRateLimitError struct {Response *http.Response// HTTP response that caused this errorMessagestring `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://docs.github.com/en/free-pro-team@latest/rest/overview/resources-in-the-rest-api#secondary-rate-limits".
func (*AbuseRateLimitError)Error¶
func (r *AbuseRateLimitError) Error()string
func (*AbuseRateLimitError)GetRetryAfter¶
func (a *AbuseRateLimitError) GetRetryAfter()time.Duration
GetRetryAfter returns the RetryAfter field if it's non-nil, zero value otherwise.
func (*AbuseRateLimitError)Is¶
func (r *AbuseRateLimitError) Is(targeterror)bool
Is returns whether the provided error equals this error.
typeAcceptedError¶
type AcceptedError struct {// Raw contains the response body.Raw []byte}
AcceptedError occurs when GitHub returns 202 Accepted response with anempty body, which means a job was scheduled on the GitHub side to processthe information needed and cache it.Technically, 202 Accepted is not a real error, it's just used toindicate that results are not ready yet, but should be available soon.The request can be repeated after some time.
func (*AcceptedError)Error¶
func (*AcceptedError) Error()string
func (*AcceptedError)Is¶
func (ae *AcceptedError) Is(targeterror)bool
Is returns whether the provided error equals this error.
typeActionBilling¶
type ActionBilling struct {TotalMinutesUsedint `json:"total_minutes_used"`TotalPaidMinutesUsedfloat64 `json:"total_paid_minutes_used"`IncludedMinutesint `json:"included_minutes"`MinutesUsedBreakdownMinutesUsedBreakdown `json:"minutes_used_breakdown"`}
ActionBilling represents a GitHub Action billing.
typeActionsAllowed¶
type ActionsAllowed struct {GithubOwnedAllowed *bool `json:"github_owned_allowed,omitempty"`VerifiedAllowed *bool `json:"verified_allowed,omitempty"`PatternsAllowed []string `json:"patterns_allowed,omitempty"`}
ActionsAllowed represents selected actions that are allowed in an organization.
GitHub API docs:https://docs.github.com/en/rest/reference/actions#get-allowed-actions-for-an-organization
func (*ActionsAllowed)GetGithubOwnedAllowed¶
func (a *ActionsAllowed) GetGithubOwnedAllowed()bool
GetGithubOwnedAllowed returns the GithubOwnedAllowed field if it's non-nil, zero value otherwise.
func (*ActionsAllowed)GetVerifiedAllowed¶
func (a *ActionsAllowed) GetVerifiedAllowed()bool
GetVerifiedAllowed returns the VerifiedAllowed field if it's non-nil, zero value otherwise.
func (ActionsAllowed)String¶
func (aActionsAllowed) String()string
typeActionsEnabledOnOrgRepos¶
type ActionsEnabledOnOrgRepos struct {TotalCountint `json:"total_count"`Repositories []*Repository `json:"repositories"`}
ActionsEnabledOnOrgRepos represents all the repositories in an organization for which Actions is enabled.
typeActionsPermissions¶
type ActionsPermissions struct {EnabledRepositories *string `json:"enabled_repositories,omitempty"`AllowedActions *string `json:"allowed_actions,omitempty"`SelectedActionsURL *string `json:"selected_actions_url,omitempty"`}
ActionsPermissions represents a policy for repositories and allowed actions in an organization.
GitHub API docs:https://docs.github.com/en/rest/reference/actions#permissions
func (*ActionsPermissions)GetAllowedActions¶
func (a *ActionsPermissions) GetAllowedActions()string
GetAllowedActions returns the AllowedActions field if it's non-nil, zero value otherwise.
func (*ActionsPermissions)GetEnabledRepositories¶
func (a *ActionsPermissions) GetEnabledRepositories()string
GetEnabledRepositories returns the EnabledRepositories field if it's non-nil, zero value otherwise.
func (*ActionsPermissions)GetSelectedActionsURL¶
func (a *ActionsPermissions) GetSelectedActionsURL()string
GetSelectedActionsURL returns the SelectedActionsURL field if it's non-nil, zero value otherwise.
func (ActionsPermissions)String¶
func (aActionsPermissions) String()string
typeActionsService¶
type ActionsService service
ActionsService handles communication with the actions relatedmethods of the GitHub API.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/
func (*ActionsService)AddEnabledReposInOrg¶
func (s *ActionsService) AddEnabledReposInOrg(ctxcontext.Context, ownerstring, repositoryIDint64) (*Response,error)
AddEnabledReposInOrg adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization.
GitHub API docs:https://docs.github.com/en/rest/reference/actions#enable-a-selected-repository-for-github-actions-in-an-organization
func (*ActionsService)AddRepositoryAccessRunnerGroup¶
func (s *ActionsService) AddRepositoryAccessRunnerGroup(ctxcontext.Context, orgstring, groupID, repoIDint64) (*Response,error)
AddRepositoryAccessRunnerGroup adds a repository to the list of selected repositories that can access a self-hosted runner group.The runner group must have visibility set to 'selected'.
GitHub API docs:https://docs.github.com/en/rest/reference/actions#add-repository-access-to-a-self-hosted-runner-group-in-an-organization
func (*ActionsService)AddRunnerGroupRunners¶
func (s *ActionsService) AddRunnerGroupRunners(ctxcontext.Context, orgstring, groupID, runnerIDint64) (*Response,error)
AddRunnerGroupRunners adds a self-hosted runner to a runner group configured in an organization.
GitHub API docs:https://docs.github.com/en/rest/reference/actions#add-a-self-hosted-runner-to-a-group-for-an-organization
func (*ActionsService)AddSelectedRepoToOrgSecret¶
func (s *ActionsService) AddSelectedRepoToOrgSecret(ctxcontext.Context, org, namestring, repo *Repository) (*Response,error)
AddSelectedRepoToOrgSecret adds a repository to an organization secret.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#add-selected-repository-to-an-organization-secret
func (*ActionsService)CancelWorkflowRunByID¶
func (s *ActionsService) CancelWorkflowRunByID(ctxcontext.Context, owner, repostring, runIDint64) (*Response,error)
CancelWorkflowRunByID cancels a workflow run by ID.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#cancel-a-workflow-run
func (*ActionsService)CreateOrUpdateEnvSecret¶
func (s *ActionsService) CreateOrUpdateEnvSecret(ctxcontext.Context, repoIDint, envstring, eSecret *EncryptedSecret) (*Response,error)
CreateOrUpdateEnvSecret creates or updates a single environment secret with an encrypted value.
GitHub API docs:https://docs.github.com/en/rest/reference/actions#create-or-update-an-environment-secret
func (*ActionsService)CreateOrUpdateOrgSecret¶
func (s *ActionsService) CreateOrUpdateOrgSecret(ctxcontext.Context, orgstring, eSecret *EncryptedSecret) (*Response,error)
CreateOrUpdateOrgSecret creates or updates an organization secret with an encrypted value.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#create-or-update-an-organization-secret
func (*ActionsService)CreateOrUpdateRepoSecret¶
func (s *ActionsService) CreateOrUpdateRepoSecret(ctxcontext.Context, owner, repostring, eSecret *EncryptedSecret) (*Response,error)
CreateOrUpdateRepoSecret creates or updates a repository secret with an encrypted value.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#create-or-update-a-repository-secret
func (*ActionsService)CreateOrganizationRegistrationToken¶
func (s *ActionsService) CreateOrganizationRegistrationToken(ctxcontext.Context, ownerstring) (*RegistrationToken, *Response,error)
CreateOrganizationRegistrationToken creates a token that can be used to add a self-hosted runner to an organization.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#create-a-registration-token-for-an-organization
func (*ActionsService)CreateOrganizationRemoveToken¶
func (s *ActionsService) CreateOrganizationRemoveToken(ctxcontext.Context, ownerstring) (*RemoveToken, *Response,error)
CreateOrganizationRemoveToken creates a token that can be used to remove a self-hosted runner from an organization.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#create-a-remove-token-for-an-organization
func (*ActionsService)CreateOrganizationRunnerGroup¶
func (s *ActionsService) CreateOrganizationRunnerGroup(ctxcontext.Context, orgstring, createReqCreateRunnerGroupRequest) (*RunnerGroup, *Response,error)
CreateOrganizationRunnerGroup creates a new self-hosted runner group for an organization.
GitHub API docs:https://docs.github.com/en/rest/reference/actions#create-a-self-hosted-runner-group-for-an-organization
func (*ActionsService)CreateRegistrationToken¶
func (s *ActionsService) CreateRegistrationToken(ctxcontext.Context, owner, repostring) (*RegistrationToken, *Response,error)
CreateRegistrationToken creates a token that can be used to add a self-hosted runner.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#create-a-registration-token-for-a-repository
func (*ActionsService)CreateRemoveToken¶
func (s *ActionsService) CreateRemoveToken(ctxcontext.Context, owner, repostring) (*RemoveToken, *Response,error)
CreateRemoveToken creates a token that can be used to remove a self-hosted runner from a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#create-a-remove-token-for-a-repository
func (*ActionsService)CreateWorkflowDispatchEventByFileName¶
func (s *ActionsService) CreateWorkflowDispatchEventByFileName(ctxcontext.Context, owner, repo, workflowFileNamestring, eventCreateWorkflowDispatchEventRequest) (*Response,error)
CreateWorkflowDispatchEventByFileName manually triggers a GitHub Actions workflow run.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#create-a-workflow-dispatch-event
func (*ActionsService)CreateWorkflowDispatchEventByID¶
func (s *ActionsService) CreateWorkflowDispatchEventByID(ctxcontext.Context, owner, repostring, workflowIDint64, eventCreateWorkflowDispatchEventRequest) (*Response,error)
CreateWorkflowDispatchEventByID manually triggers a GitHub Actions workflow run.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#create-a-workflow-dispatch-event
func (*ActionsService)DeleteArtifact¶
func (s *ActionsService) DeleteArtifact(ctxcontext.Context, owner, repostring, artifactIDint64) (*Response,error)
DeleteArtifact deletes a workflow run artifact.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#delete-an-artifact
func (*ActionsService)DeleteEnvSecret¶
func (s *ActionsService) DeleteEnvSecret(ctxcontext.Context, repoIDint, env, secretNamestring) (*Response,error)
DeleteEnvSecret deletes a secret in an environment using the secret name.
GitHub API docs:https://docs.github.com/en/rest/reference/actions#delete-an-environment-secret
func (*ActionsService)DeleteOrgSecret¶
DeleteOrgSecret deletes a secret in an organization using the secret name.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#delete-an-organization-secret
func (*ActionsService)DeleteOrganizationRunnerGroup¶
func (s *ActionsService) DeleteOrganizationRunnerGroup(ctxcontext.Context, orgstring, groupIDint64) (*Response,error)
DeleteOrganizationRunnerGroup deletes a self-hosted runner group from an organization.
GitHub API docs:https://docs.github.com/en/rest/reference/actions#delete-a-self-hosted-runner-group-from-an-organization
func (*ActionsService)DeleteRepoSecret¶
func (s *ActionsService) DeleteRepoSecret(ctxcontext.Context, owner, repo, namestring) (*Response,error)
DeleteRepoSecret deletes a secret in a repository using the secret name.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#delete-a-repository-secret
func (*ActionsService)DeleteWorkflowRun¶
func (s *ActionsService) DeleteWorkflowRun(ctxcontext.Context, owner, repostring, runIDint64) (*Response,error)
DeleteWorkflowRun deletes a workflow run by ID.
GitHub API docs:https://docs.github.com/en/rest/reference/actions#delete-a-workflow-run
func (*ActionsService)DeleteWorkflowRunLogs¶
func (s *ActionsService) DeleteWorkflowRunLogs(ctxcontext.Context, owner, repostring, runIDint64) (*Response,error)
DeleteWorkflowRunLogs deletes all logs for a workflow run.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#delete-workflow-run-logs
func (*ActionsService)DisableWorkflowByFileName¶
func (s *ActionsService) DisableWorkflowByFileName(ctxcontext.Context, owner, repo, workflowFileNamestring) (*Response,error)
DisableWorkflowByFileName disables a workflow and sets the state of the workflow to "disabled_manually".
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#disable-a-workflow
func (*ActionsService)DisableWorkflowByID¶
func (s *ActionsService) DisableWorkflowByID(ctxcontext.Context, owner, repostring, workflowIDint64) (*Response,error)
DisableWorkflowByID disables a workflow and sets the state of the workflow to "disabled_manually".
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#disable-a-workflow
func (*ActionsService)DownloadArtifact¶
func (s *ActionsService) DownloadArtifact(ctxcontext.Context, owner, repostring, artifactIDint64, followRedirectsbool) (*url.URL, *Response,error)
DownloadArtifact gets a redirect URL to download an archive for a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#download-an-artifact
func (*ActionsService)EnableWorkflowByFileName¶
func (s *ActionsService) EnableWorkflowByFileName(ctxcontext.Context, owner, repo, workflowFileNamestring) (*Response,error)
EnableWorkflowByFileName enables a workflow and sets the state of the workflow to "active".
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#enable-a-workflow
func (*ActionsService)EnableWorkflowByID¶
func (s *ActionsService) EnableWorkflowByID(ctxcontext.Context, owner, repostring, workflowIDint64) (*Response,error)
EnableWorkflowByID enables a workflow and sets the state of the workflow to "active".
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#enable-a-workflow
func (*ActionsService)GetArtifact¶
func (s *ActionsService) GetArtifact(ctxcontext.Context, owner, repostring, artifactIDint64) (*Artifact, *Response,error)
GetArtifact gets a specific artifact for a workflow run.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#get-an-artifact
func (*ActionsService)GetEnvPublicKey¶
func (s *ActionsService) GetEnvPublicKey(ctxcontext.Context, repoIDint, envstring) (*PublicKey, *Response,error)
GetEnvPublicKey gets a public key that should be used for secret encryption.
GitHub API docs:https://docs.github.com/en/rest/reference/actions#get-an-environment-public-key
func (*ActionsService)GetEnvSecret¶
func (s *ActionsService) GetEnvSecret(ctxcontext.Context, repoIDint, env, secretNamestring) (*Secret, *Response,error)
GetEnvSecret gets a single environment secret without revealing its encrypted value.
GitHub API docs:https://docs.github.com/en/rest/reference/actions#list-environment-secrets
func (*ActionsService)GetOrgPublicKey¶
func (s *ActionsService) GetOrgPublicKey(ctxcontext.Context, orgstring) (*PublicKey, *Response,error)
GetOrgPublicKey gets a public key that should be used for secret encryption.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#get-an-organization-public-key
func (*ActionsService)GetOrgSecret¶
func (s *ActionsService) GetOrgSecret(ctxcontext.Context, org, namestring) (*Secret, *Response,error)
GetOrgSecret gets a single organization secret without revealing its encrypted value.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#get-an-organization-secret
func (*ActionsService)GetOrganizationRunner¶
func (s *ActionsService) GetOrganizationRunner(ctxcontext.Context, ownerstring, runnerIDint64) (*Runner, *Response,error)
GetOrganizationRunner gets a specific self-hosted runner for an organization using its runner ID.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#get-a-self-hosted-runner-for-an-organization
func (*ActionsService)GetOrganizationRunnerGroup¶
func (s *ActionsService) GetOrganizationRunnerGroup(ctxcontext.Context, orgstring, groupIDint64) (*RunnerGroup, *Response,error)
GetOrganizationRunnerGroup gets a specific self-hosted runner group for an organization using its RunnerGroup ID.
GitHub API docs:https://docs.github.com/en/rest/reference/actions#get-a-self-hosted-runner-group-for-an-organization
func (*ActionsService)GetRepoPublicKey¶
func (s *ActionsService) GetRepoPublicKey(ctxcontext.Context, owner, repostring) (*PublicKey, *Response,error)
GetRepoPublicKey gets a public key that should be used for secret encryption.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#get-a-repository-public-key
func (*ActionsService)GetRepoSecret¶
func (s *ActionsService) GetRepoSecret(ctxcontext.Context, owner, repo, namestring) (*Secret, *Response,error)
GetRepoSecret gets a single repository secret without revealing its encrypted value.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#get-a-repository-secret
func (*ActionsService)GetRunner¶
func (s *ActionsService) GetRunner(ctxcontext.Context, owner, repostring, runnerIDint64) (*Runner, *Response,error)
GetRunner gets a specific self-hosted runner for a repository using its runner ID.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#get-a-self-hosted-runner-for-a-repository
func (*ActionsService)GetWorkflowByFileName¶
func (s *ActionsService) GetWorkflowByFileName(ctxcontext.Context, owner, repo, workflowFileNamestring) (*Workflow, *Response,error)
GetWorkflowByFileName gets a specific workflow by file name.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#get-a-workflow
func (*ActionsService)GetWorkflowByID¶
func (s *ActionsService) GetWorkflowByID(ctxcontext.Context, owner, repostring, workflowIDint64) (*Workflow, *Response,error)
GetWorkflowByID gets a specific workflow by ID.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#get-a-workflow
func (*ActionsService)GetWorkflowJobByID¶
func (s *ActionsService) GetWorkflowJobByID(ctxcontext.Context, owner, repostring, jobIDint64) (*WorkflowJob, *Response,error)
GetWorkflowJobByID gets a specific job in a workflow run by ID.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#get-a-job-for-a-workflow-run
func (*ActionsService)GetWorkflowJobLogs¶
func (s *ActionsService) GetWorkflowJobLogs(ctxcontext.Context, owner, repostring, jobIDint64, followRedirectsbool) (*url.URL, *Response,error)
GetWorkflowJobLogs gets a redirect URL to download a plain text file of logs for a workflow job.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#download-job-logs-for-a-workflow-run
func (*ActionsService)GetWorkflowRunAttempt¶
func (s *ActionsService) GetWorkflowRunAttempt(ctxcontext.Context, owner, repostring, runIDint64, attemptNumberint, opts *WorkflowRunAttemptOptions) (*WorkflowRun, *Response,error)
GetWorkflowRunAttempt gets a specific workflow run attempt.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#get-a-workflow-run-attempt
func (*ActionsService)GetWorkflowRunByID¶
func (s *ActionsService) GetWorkflowRunByID(ctxcontext.Context, owner, repostring, runIDint64) (*WorkflowRun, *Response,error)
GetWorkflowRunByID gets a specific workflow run by ID.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#get-a-workflow-run
func (*ActionsService)GetWorkflowRunLogs¶
func (s *ActionsService) GetWorkflowRunLogs(ctxcontext.Context, owner, repostring, runIDint64, followRedirectsbool) (*url.URL, *Response,error)
GetWorkflowRunLogs gets a redirect URL to download a plain text file of logs for a workflow run.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#download-workflow-run-logs
func (*ActionsService)GetWorkflowRunUsageByID¶
func (s *ActionsService) GetWorkflowRunUsageByID(ctxcontext.Context, owner, repostring, runIDint64) (*WorkflowRunUsage, *Response,error)
GetWorkflowRunUsageByID gets a specific workflow usage run by run ID in the unit of billable milliseconds.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#get-workflow-run-usage
func (*ActionsService)GetWorkflowUsageByFileName¶
func (s *ActionsService) GetWorkflowUsageByFileName(ctxcontext.Context, owner, repo, workflowFileNamestring) (*WorkflowUsage, *Response,error)
GetWorkflowUsageByFileName gets a specific workflow usage by file name in the unit of billable milliseconds.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#get-workflow-usage
func (*ActionsService)GetWorkflowUsageByID¶
func (s *ActionsService) GetWorkflowUsageByID(ctxcontext.Context, owner, repostring, workflowIDint64) (*WorkflowUsage, *Response,error)
GetWorkflowUsageByID gets a specific workflow usage by ID in the unit of billable milliseconds.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#get-workflow-usage
func (*ActionsService)ListArtifacts¶
func (s *ActionsService) ListArtifacts(ctxcontext.Context, owner, repostring, opts *ListOptions) (*ArtifactList, *Response,error)
ListArtifacts lists all artifacts that belong to a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#list-artifacts-for-a-repository
func (*ActionsService)ListEnabledReposInOrg¶
func (s *ActionsService) ListEnabledReposInOrg(ctxcontext.Context, ownerstring, opts *ListOptions) (*ActionsEnabledOnOrgRepos, *Response,error)
ListEnabledReposInOrg lists the selected repositories that are enabled for GitHub Actions in an organization.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#list-selected-repositories-enabled-for-github-actions-in-an-organization
func (*ActionsService)ListEnvSecrets¶
func (s *ActionsService) ListEnvSecrets(ctxcontext.Context, repoIDint, envstring, opts *ListOptions) (*Secrets, *Response,error)
ListEnvSecrets lists all secrets available in an environment.
GitHub API docs:https://docs.github.com/en/rest/reference/actions#list-environment-secrets
func (*ActionsService)ListOrgSecrets¶
func (s *ActionsService) ListOrgSecrets(ctxcontext.Context, orgstring, opts *ListOptions) (*Secrets, *Response,error)
ListOrgSecrets lists all secrets available in an organizationwithout revealing their encrypted values.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#list-organization-secrets
func (*ActionsService)ListOrganizationRunnerApplicationDownloads¶
func (s *ActionsService) ListOrganizationRunnerApplicationDownloads(ctxcontext.Context, ownerstring) ([]*RunnerApplicationDownload, *Response,error)
ListOrganizationRunnerApplicationDownloads lists self-hosted runner application binaries that can be downloaded and run.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#list-runner-applications-for-an-organization
func (*ActionsService)ListOrganizationRunnerGroups¶
func (s *ActionsService) ListOrganizationRunnerGroups(ctxcontext.Context, orgstring, opts *ListOptions) (*RunnerGroups, *Response,error)
ListOrganizationRunnerGroups lists all self-hosted runner groups configured in an organization.
GitHub API docs:https://docs.github.com/en/rest/reference/actions#list-self-hosted-runner-groups-for-an-organization
func (*ActionsService)ListOrganizationRunners¶
func (s *ActionsService) ListOrganizationRunners(ctxcontext.Context, ownerstring, opts *ListOptions) (*Runners, *Response,error)
ListOrganizationRunners lists all the self-hosted runners for an organization.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#list-self-hosted-runners-for-an-organization
func (*ActionsService)ListRepoSecrets¶
func (s *ActionsService) ListRepoSecrets(ctxcontext.Context, owner, repostring, opts *ListOptions) (*Secrets, *Response,error)
ListRepoSecrets lists all secrets available in a repositorywithout revealing their encrypted values.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#list-repository-secrets
func (*ActionsService)ListRepositoryAccessRunnerGroup¶
func (s *ActionsService) ListRepositoryAccessRunnerGroup(ctxcontext.Context, orgstring, groupIDint64, opts *ListOptions) (*ListRepositories, *Response,error)
ListRepositoryAccessRunnerGroup lists the repositories with access to a self-hosted runner group configured in an organization.
GitHub API docs:https://docs.github.com/en/rest/reference/actions#list-repository-access-to-a-self-hosted-runner-group-in-an-organization
func (*ActionsService)ListRepositoryWorkflowRuns¶
func (s *ActionsService) ListRepositoryWorkflowRuns(ctxcontext.Context, owner, repostring, opts *ListWorkflowRunsOptions) (*WorkflowRuns, *Response,error)
ListRepositoryWorkflowRuns lists all workflow runs for a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#list-workflow-runs-for-a-repository
func (*ActionsService)ListRunnerApplicationDownloads¶
func (s *ActionsService) ListRunnerApplicationDownloads(ctxcontext.Context, owner, repostring) ([]*RunnerApplicationDownload, *Response,error)
ListRunnerApplicationDownloads lists self-hosted runner application binaries that can be downloaded and run.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#list-runner-applications-for-a-repository
func (*ActionsService)ListRunnerGroupRunners¶
func (s *ActionsService) ListRunnerGroupRunners(ctxcontext.Context, orgstring, groupIDint64, opts *ListOptions) (*Runners, *Response,error)
ListRunnerGroupRunners lists self-hosted runners that are in a specific organization group.
GitHub API docs:https://docs.github.com/en/rest/reference/actions#list-self-hosted-runners-in-a-group-for-an-organization
func (*ActionsService)ListRunners¶
func (s *ActionsService) ListRunners(ctxcontext.Context, owner, repostring, opts *ListOptions) (*Runners, *Response,error)
ListRunners lists all the self-hosted runners for a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#list-self-hosted-runners-for-a-repository
func (*ActionsService)ListSelectedReposForOrgSecret¶
func (s *ActionsService) ListSelectedReposForOrgSecret(ctxcontext.Context, org, namestring, opts *ListOptions) (*SelectedReposList, *Response,error)
ListSelectedReposForOrgSecret lists all repositories that have access to a secret.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#list-selected-repositories-for-an-organization-secret
func (*ActionsService)ListWorkflowJobs¶
func (s *ActionsService) ListWorkflowJobs(ctxcontext.Context, owner, repostring, runIDint64, opts *ListWorkflowJobsOptions) (*Jobs, *Response,error)
ListWorkflowJobs lists all jobs for a workflow run.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#list-jobs-for-a-workflow-run
func (*ActionsService)ListWorkflowRunArtifacts¶
func (s *ActionsService) ListWorkflowRunArtifacts(ctxcontext.Context, owner, repostring, runIDint64, opts *ListOptions) (*ArtifactList, *Response,error)
ListWorkflowRunArtifacts lists all artifacts that belong to a workflow run.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#list-workflow-run-artifacts
func (*ActionsService)ListWorkflowRunsByFileName¶
func (s *ActionsService) ListWorkflowRunsByFileName(ctxcontext.Context, owner, repo, workflowFileNamestring, opts *ListWorkflowRunsOptions) (*WorkflowRuns, *Response,error)
ListWorkflowRunsByFileName lists all workflow runs by workflow file name.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#list-workflow-runs
func (*ActionsService)ListWorkflowRunsByID¶
func (s *ActionsService) ListWorkflowRunsByID(ctxcontext.Context, owner, repostring, workflowIDint64, opts *ListWorkflowRunsOptions) (*WorkflowRuns, *Response,error)
ListWorkflowRunsByID lists all workflow runs by workflow ID.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#list-workflow-runs
func (*ActionsService)ListWorkflows¶
func (s *ActionsService) ListWorkflows(ctxcontext.Context, owner, repostring, opts *ListOptions) (*Workflows, *Response,error)
ListWorkflows lists all workflows in a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#list-repository-workflows
func (*ActionsService)RemoveEnabledRepoInOrg¶
func (s *ActionsService) RemoveEnabledRepoInOrg(ctxcontext.Context, ownerstring, repositoryIDint64) (*Response,error)
RemoveEnabledRepoInOrg removes a single repository from the list of enabled repos for GitHub Actions in an organization.
GitHub API docs:https://docs.github.com/en/rest/reference/actions#disable-a-selected-repository-for-github-actions-in-an-organization
func (*ActionsService)RemoveOrganizationRunner¶
func (s *ActionsService) RemoveOrganizationRunner(ctxcontext.Context, ownerstring, runnerIDint64) (*Response,error)
RemoveOrganizationRunner forces the removal of a self-hosted runner from an organization using the runner id.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#delete-a-self-hosted-runner-from-an-organization
func (*ActionsService)RemoveRepositoryAccessRunnerGroup¶
func (s *ActionsService) RemoveRepositoryAccessRunnerGroup(ctxcontext.Context, orgstring, groupID, repoIDint64) (*Response,error)
RemoveRepositoryAccessRunnerGroup removes a repository from the list of selected repositories that can access a self-hosted runner group.The runner group must have visibility set to 'selected'.
GitHub API docs:https://docs.github.com/en/rest/reference/actions#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization
func (*ActionsService)RemoveRunner¶
func (s *ActionsService) RemoveRunner(ctxcontext.Context, owner, repostring, runnerIDint64) (*Response,error)
RemoveRunner forces the removal of a self-hosted runner in a repository using the runner id.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#delete-a-self-hosted-runner-from-a-repository
func (*ActionsService)RemoveRunnerGroupRunners¶
func (s *ActionsService) RemoveRunnerGroupRunners(ctxcontext.Context, orgstring, groupID, runnerIDint64) (*Response,error)
RemoveRunnerGroupRunners removes a self-hosted runner from a group configured in an organization.The runner is then returned to the default group.
GitHub API docs:https://docs.github.com/en/rest/reference/actions#remove-a-self-hosted-runner-from-a-group-for-an-organization
func (*ActionsService)RemoveSelectedRepoFromOrgSecret¶
func (s *ActionsService) RemoveSelectedRepoFromOrgSecret(ctxcontext.Context, org, namestring, repo *Repository) (*Response,error)
RemoveSelectedRepoFromOrgSecret removes a repository from an organization secret.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#remove-selected-repository-from-an-organization-secret
func (*ActionsService)RerunWorkflowByID¶
func (s *ActionsService) RerunWorkflowByID(ctxcontext.Context, owner, repostring, runIDint64) (*Response,error)
RerunWorkflowByID re-runs a workflow by ID.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#re-run-a-workflow
func (*ActionsService)SetEnabledReposInOrg¶
func (s *ActionsService) SetEnabledReposInOrg(ctxcontext.Context, ownerstring, repositoryIDs []int64) (*Response,error)
SetEnabledReposInOrg replaces the list of selected repositories that are enabled for GitHub Actions in an organization..
GitHub API docs:https://docs.github.com/en/rest/reference/actions#set-selected-repositories-enabled-for-github-actions-in-an-organization
func (*ActionsService)SetRepositoryAccessRunnerGroup¶
func (s *ActionsService) SetRepositoryAccessRunnerGroup(ctxcontext.Context, orgstring, groupIDint64, idsSetRepoAccessRunnerGroupRequest) (*Response,error)
SetRepositoryAccessRunnerGroup replaces the list of repositories that have access to a self-hosted runner group configured in an organizationwith a new List of repositories.
GitHub API docs:https://docs.github.com/en/rest/reference/actions#set-repository-access-for-a-self-hosted-runner-group-in-an-organization
func (*ActionsService)SetRunnerGroupRunners¶
func (s *ActionsService) SetRunnerGroupRunners(ctxcontext.Context, orgstring, groupIDint64, idsSetRunnerGroupRunnersRequest) (*Response,error)
SetRunnerGroupRunners replaces the list of self-hosted runners that are part of an organization runner groupwith a new list of runners.
GitHub API docs:https://docs.github.com/en/rest/reference/actions#set-self-hosted-runners-in-a-group-for-an-organization
func (*ActionsService)SetSelectedReposForOrgSecret¶
func (s *ActionsService) SetSelectedReposForOrgSecret(ctxcontext.Context, org, namestring, idsSelectedRepoIDs) (*Response,error)
SetSelectedReposForOrgSecret sets the repositories that have access to a secret.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#set-selected-repositories-for-an-organization-secret
func (*ActionsService)UpdateOrganizationRunnerGroup¶
func (s *ActionsService) UpdateOrganizationRunnerGroup(ctxcontext.Context, orgstring, groupIDint64, updateReqUpdateRunnerGroupRequest) (*RunnerGroup, *Response,error)
UpdateOrganizationRunnerGroup updates a self-hosted runner group for an organization.
GitHub API docs:https://docs.github.com/en/rest/reference/actions#update-a-self-hosted-runner-group-for-an-organization
typeActiveCommitters¶
type ActiveCommitters struct {TotalAdvancedSecurityCommittersint `json:"total_advanced_security_committers"`Repositories []*RepositoryActiveCommitters `json:"repositories,omitempty"`}
ActiveCommitters represents the total active committers across all repositories in an Organization.
typeActivityListStarredOptions¶
type ActivityListStarredOptions struct {// How to sort the repository list. Possible values are: created, updated,// pushed, full_name. Default is "full_name".Sortstring `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".Directionstring `url:"direction,omitempty"`ListOptions}
ActivityListStarredOptions specifies the optional parameters to theActivityService.ListStarred method.
typeActivityService¶
type ActivityService service
ActivityService handles communication with the activity relatedmethods of the GitHub API.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/activity/
func (*ActivityService)DeleteRepositorySubscription¶
func (s *ActivityService) DeleteRepositorySubscription(ctxcontext.Context, owner, repostring) (*Response,error)
DeleteRepositorySubscription deletes the subscription for the specifiedrepository for the authenticated user.
This is used to stop watching a repository. To control whether or not toreceive notifications from a repository, use SetRepositorySubscription.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/activity/#delete-a-repository-subscription
func (*ActivityService)DeleteThreadSubscription¶
DeleteThreadSubscription deletes the subscription for the specified threadfor the authenticated user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/activity/#delete-a-thread-subscription
func (*ActivityService)GetRepositorySubscription¶
func (s *ActivityService) GetRepositorySubscription(ctxcontext.Context, owner, repostring) (*Subscription, *Response,error)
GetRepositorySubscription returns the subscription for the specifiedrepository for the authenticated user. If the authenticated user is notwatching the repository, a nil Subscription is returned.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/activity/#get-a-repository-subscription
func (*ActivityService)GetThread¶
func (s *ActivityService) GetThread(ctxcontext.Context, idstring) (*Notification, *Response,error)
GetThread gets the specified notification thread.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/activity/#get-a-thread
func (*ActivityService)GetThreadSubscription¶
func (s *ActivityService) GetThreadSubscription(ctxcontext.Context, idstring) (*Subscription, *Response,error)
GetThreadSubscription checks to see if the authenticated user is subscribedto a thread.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/activity/#get-a-thread-subscription-for-the-authenticated-user
func (*ActivityService)IsStarred¶
IsStarred checks if a repository is starred by authenticated user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/activity/#check-if-a-repository-is-starred-by-the-authenticated-user
func (*ActivityService)ListEvents¶
func (s *ActivityService) ListEvents(ctxcontext.Context, opts *ListOptions) ([]*Event, *Response,error)
ListEvents drinks from the firehose of all public events across GitHub.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/activity/#list-public-events
func (*ActivityService)ListEventsForOrganization¶
func (s *ActivityService) ListEventsForOrganization(ctxcontext.Context, orgstring, opts *ListOptions) ([]*Event, *Response,error)
ListEventsForOrganization lists public events for an organization.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/activity/#list-public-organization-events
func (*ActivityService)ListEventsForRepoNetwork¶
func (s *ActivityService) ListEventsForRepoNetwork(ctxcontext.Context, owner, repostring, opts *ListOptions) ([]*Event, *Response,error)
ListEventsForRepoNetwork lists public events for a network of repositories.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/activity/#list-public-events-for-a-network-of-repositories
func (*ActivityService)ListEventsPerformedByUser¶
func (s *ActivityService) ListEventsPerformedByUser(ctxcontext.Context, userstring, publicOnlybool, opts *ListOptions) ([]*Event, *Response,error)
ListEventsPerformedByUser lists the events performed by a user. If publicOnly istrue, only public events will be returned.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/activity/#list-events-for-the-authenticated-userGitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/activity/#list-public-events-for-a-user
func (*ActivityService)ListEventsReceivedByUser¶
func (s *ActivityService) ListEventsReceivedByUser(ctxcontext.Context, userstring, publicOnlybool, opts *ListOptions) ([]*Event, *Response,error)
ListEventsReceivedByUser lists the events received by a user. If publicOnly istrue, only public events will be returned.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/activity/#list-events-received-by-the-authenticated-userGitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/activity/#list-public-events-received-by-a-user
func (*ActivityService)ListFeeds¶
ListFeeds lists all the feeds available to the authenticated user.
GitHub provides several timeline resources in Atom format:
Timeline: The GitHub global public timelineUser: The public timeline for any user, using URI templateCurrent user public: The public timeline for the authenticated userCurrent user: The private timeline for the authenticated userCurrent user actor: The private timeline for activity created by the authenticated userCurrent 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 Authsince current feed URIs use the older, non revocable auth tokens.
func (*ActivityService)ListIssueEventsForRepository¶
func (s *ActivityService) ListIssueEventsForRepository(ctxcontext.Context, owner, repostring, opts *ListOptions) ([]*IssueEvent, *Response,error)
ListIssueEventsForRepository lists issue events for a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/issues/#list-issue-events-for-a-repository
func (*ActivityService)ListNotifications¶
func (s *ActivityService) ListNotifications(ctxcontext.Context, opts *NotificationListOptions) ([]*Notification, *Response,error)
ListNotifications lists all notifications for the authenticated user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/activity/#list-notifications-for-the-authenticated-user
func (*ActivityService)ListRepositoryEvents¶
func (s *ActivityService) ListRepositoryEvents(ctxcontext.Context, owner, repostring, opts *ListOptions) ([]*Event, *Response,error)
ListRepositoryEvents lists events for a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/activity/#list-repository-events
func (*ActivityService)ListRepositoryNotifications¶
func (s *ActivityService) ListRepositoryNotifications(ctxcontext.Context, owner, repostring, opts *NotificationListOptions) ([]*Notification, *Response,error)
ListRepositoryNotifications lists all notifications in a given repositoryfor the authenticated user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/activity/#list-repository-notifications-for-the-authenticated-user
func (*ActivityService)ListStargazers¶
func (s *ActivityService) ListStargazers(ctxcontext.Context, owner, repostring, opts *ListOptions) ([]*Stargazer, *Response,error)
ListStargazers lists people who have starred the specified repo.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/activity/#list-stargazers
func (*ActivityService)ListStarred¶
func (s *ActivityService) ListStarred(ctxcontext.Context, userstring, opts *ActivityListStarredOptions) ([]*StarredRepository, *Response,error)
ListStarred lists all the repos starred by a user. Passing the empty stringwill list the starred repositories for the authenticated user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/activity/#list-repositories-starred-by-the-authenticated-userGitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/activity/#list-repositories-starred-by-a-user
func (*ActivityService)ListUserEventsForOrganization¶
func (s *ActivityService) ListUserEventsForOrganization(ctxcontext.Context, org, userstring, opts *ListOptions) ([]*Event, *Response,error)
ListUserEventsForOrganization provides the user’s organization dashboard. Youmust be authenticated as the user to view this.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/activity/#list-organization-events-for-the-authenticated-user
func (*ActivityService)ListWatched¶
func (s *ActivityService) ListWatched(ctxcontext.Context, userstring, opts *ListOptions) ([]*Repository, *Response,error)
ListWatched lists the repositories the specified user is watching. Passingthe empty string will fetch watched repos for the authenticated user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/activity/#list-repositories-watched-by-the-authenticated-userGitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/activity/#list-repositories-watched-by-a-user
func (*ActivityService)ListWatchers¶
func (s *ActivityService) ListWatchers(ctxcontext.Context, owner, repostring, opts *ListOptions) ([]*User, *Response,error)
ListWatchers lists watchers of a particular repo.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/activity/#list-watchers
func (*ActivityService)MarkNotificationsRead¶
func (s *ActivityService) MarkNotificationsRead(ctxcontext.Context, lastReadtime.Time) (*Response,error)
MarkNotificationsRead marks all notifications up to lastRead as read.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/activity#mark-as-read
func (*ActivityService)MarkRepositoryNotificationsRead¶
func (s *ActivityService) MarkRepositoryNotificationsRead(ctxcontext.Context, owner, repostring, lastReadtime.Time) (*Response,error)
MarkRepositoryNotificationsRead marks all notifications up to lastRead inthe specified repository as read.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/activity/#mark-repository-notifications-as-read
func (*ActivityService)MarkThreadRead¶
MarkThreadRead marks the specified thread as read.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/activity/#mark-a-thread-as-read
func (*ActivityService)SetRepositorySubscription¶
func (s *ActivityService) SetRepositorySubscription(ctxcontext.Context, owner, repostring, subscription *Subscription) (*Subscription, *Response,error)
SetRepositorySubscription sets the subscription for the specified repositoryfor 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://docs.github.com/en/free-pro-team@latest/rest/reference/activity/#set-a-repository-subscription
func (*ActivityService)SetThreadSubscription¶
func (s *ActivityService) SetThreadSubscription(ctxcontext.Context, idstring, subscription *Subscription) (*Subscription, *Response,error)
SetThreadSubscription sets the subscription for the specified thread for theauthenticated user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/activity/#set-a-thread-subscription
func (*ActivityService)Star¶
Star a repository as the authenticated user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/activity/#star-a-repository-for-the-authenticated-user
func (*ActivityService)Unstar¶
Unstar a repository as the authenticated user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/activity/#unstar-a-repository-for-the-authenticated-user
typeAdminEnforcement¶
AdminEnforcement represents the configuration to enforce required status checks for repository administrators.
func (*AdminEnforcement)GetURL¶
func (a *AdminEnforcement) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
typeAdminService¶
type AdminService service
AdminService handles communication with the admin related methods of theGitHub API. These API routes are normally only accessible for GitHubEnterprise installations.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/enterprise/
func (*AdminService)CreateOrg¶
func (s *AdminService) CreateOrg(ctxcontext.Context, org *Organization, adminstring) (*Organization, *Response,error)
CreateOrg creates a new organization in GitHub Enterprise.
Note that only a subset of the org fields are used and org mustnot be nil.
GitHub Enterprise API docs:https://developer.github.com/enterprise/v3/enterprise-admin/orgs/#create-an-organization
func (*AdminService)CreateUser¶
CreateUser creates a new user in GitHub Enterprise.
GitHub Enterprise API docs:https://developer.github.com/enterprise/v3/enterprise-admin/users/#create-a-new-user
func (*AdminService)CreateUserImpersonation¶
func (s *AdminService) CreateUserImpersonation(ctxcontext.Context, usernamestring, opts *ImpersonateUserOptions) (*UserAuthorization, *Response,error)
CreateUserImpersonation creates an impersonation OAuth token.
GitHub Enterprise API docs:https://developer.github.com/enterprise/v3/enterprise-admin/users/#create-an-impersonation-oauth-token
func (*AdminService)DeleteUser¶
DeleteUser deletes a user in GitHub Enterprise.
GitHub Enterprise API docs:https://developer.github.com/enterprise/v3/enterprise-admin/users/#delete-a-user
func (*AdminService)DeleteUserImpersonation¶
func (s *AdminService) DeleteUserImpersonation(ctxcontext.Context, usernamestring) (*Response,error)
DeleteUserImpersonation deletes an impersonation OAuth token.
GitHub Enterprise API docs:https://developer.github.com/enterprise/v3/enterprise-admin/users/#delete-an-impersonation-oauth-token
func (*AdminService)GetAdminStats¶
func (s *AdminService) GetAdminStats(ctxcontext.Context) (*AdminStats, *Response,error)
GetAdminStats returns a variety of metrics about a GitHub Enterpriseinstallation.
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://docs.github.com/en/free-pro-team@latest/rest/reference/enterprise-admin/admin_stats/
func (*AdminService)RenameOrg¶
func (s *AdminService) RenameOrg(ctxcontext.Context, org *Organization, newNamestring) (*RenameOrgResponse, *Response,error)
RenameOrg renames an organization in GitHub Enterprise.
GitHub Enterprise API docs:https://developer.github.com/enterprise/v3/enterprise-admin/orgs/#rename-an-organization
func (*AdminService)RenameOrgByName¶
func (s *AdminService) RenameOrgByName(ctxcontext.Context, org, newNamestring) (*RenameOrgResponse, *Response,error)
RenameOrgByName renames an organization in GitHub Enterprise using its current name.
GitHub Enterprise API docs:https://developer.github.com/enterprise/v3/enterprise-admin/orgs/#rename-an-organization
func (*AdminService)UpdateTeamLDAPMapping¶
func (s *AdminService) UpdateTeamLDAPMapping(ctxcontext.Context, teamint64, mapping *TeamLDAPMapping) (*TeamLDAPMapping, *Response,error)
UpdateTeamLDAPMapping updates the mapping between a GitHub team and an LDAP group.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/enterprise/ldap/#update-ldap-mapping-for-a-team
func (*AdminService)UpdateUserLDAPMapping¶
func (s *AdminService) UpdateUserLDAPMapping(ctxcontext.Context, userstring, mapping *UserLDAPMapping) (*UserLDAPMapping, *Response,error)
UpdateUserLDAPMapping updates the mapping between a GitHub user and an LDAP user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/enterprise/ldap/#update-ldap-mapping-for-a-user
typeAdminStats¶
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 Enterpriseinstallation.
func (*AdminStats)GetComments¶
func (a *AdminStats) GetComments() *CommentStats
GetComments returns the Comments field.
func (*AdminStats)GetGists¶
func (a *AdminStats) GetGists() *GistStats
GetGists returns the Gists field.
func (*AdminStats)GetHooks¶
func (a *AdminStats) GetHooks() *HookStats
GetHooks returns the Hooks field.
func (*AdminStats)GetIssues¶
func (a *AdminStats) GetIssues() *IssueStats
GetIssues returns the Issues field.
func (*AdminStats)GetMilestones¶
func (a *AdminStats) GetMilestones() *MilestoneStats
GetMilestones returns the Milestones field.
func (*AdminStats)GetPages¶
func (a *AdminStats) GetPages() *PageStats
GetPages returns the Pages field.
func (*AdminStats)GetPulls¶
func (a *AdminStats) GetPulls() *PullStats
GetPulls returns the Pulls field.
func (*AdminStats)GetRepos¶
func (a *AdminStats) GetRepos() *RepoStats
GetRepos returns the Repos field.
func (*AdminStats)GetUsers¶
func (a *AdminStats) GetUsers() *UserStats
GetUsers returns the Users field.
func (AdminStats)String¶
func (sAdminStats) String()string
typeAdvancedSecurity¶
type AdvancedSecurity struct {Status *string `json:"status,omitempty"`}
AdvancedSecurity specifies the state of advanced security on a repository.
GitHub API docs:https://docs.github.com/en/github/getting-started-with-github/learning-about-github/about-github-advanced-security
func (*AdvancedSecurity)GetStatus¶
func (a *AdvancedSecurity) GetStatus()string
GetStatus returns the Status field if it's non-nil, zero value otherwise.
func (AdvancedSecurity)String¶
func (aAdvancedSecurity) String()string
typeAdvancedSecurityCommittersBreakdown¶
type AdvancedSecurityCommittersBreakdown struct {UserLogin *string `json:"user_login,omitempty"`LastPushedDate *string `json:"last_pushed_date,omitempty"`}
AdvancedSecurityCommittersBreakdown represents the user activity breakdown for ActiveCommitters.
func (*AdvancedSecurityCommittersBreakdown)GetLastPushedDate¶
func (a *AdvancedSecurityCommittersBreakdown) GetLastPushedDate()string
GetLastPushedDate returns the LastPushedDate field if it's non-nil, zero value otherwise.
func (*AdvancedSecurityCommittersBreakdown)GetUserLogin¶
func (a *AdvancedSecurityCommittersBreakdown) GetUserLogin()string
GetUserLogin returns the UserLogin field if it's non-nil, zero value otherwise.
typeAlert¶
type Alert struct {RuleID *string `json:"rule_id,omitempty"`RuleSeverity *string `json:"rule_severity,omitempty"`RuleDescription *string `json:"rule_description,omitempty"`Rule *Rule `json:"rule,omitempty"`Tool *Tool `json:"tool,omitempty"`CreatedAt *Timestamp `json:"created_at,omitempty"`State *string `json:"state,omitempty"`ClosedBy *User `json:"closed_by,omitempty"`ClosedAt *Timestamp `json:"closed_at,omitempty"`URL *string `json:"url,omitempty"`HTMLURL *string `json:"html_url,omitempty"`MostRecentInstance *MostRecentInstance `json:"most_recent_instance,omitempty"`DismissedBy *User `json:"dismissed_by,omitempty"`DismissedAt *Timestamp `json:"dismissed_at,omitempty"`DismissedReason *string `json:"dismissed_reason,omitempty"`InstancesURL *string `json:"instances_url,omitempty"`}
Alert represents an individual GitHub Code Scanning Alert on a single repository.
GitHub API docs:https://docs.github.com/en/rest/reference/code-scanning#list-code-scanning-alerts-for-a-repository
func (*Alert)GetClosedAt¶
GetClosedAt returns the ClosedAt field if it's non-nil, zero value otherwise.
func (*Alert)GetCreatedAt¶
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*Alert)GetDismissedAt¶
GetDismissedAt returns the DismissedAt field if it's non-nil, zero value otherwise.
func (*Alert)GetDismissedBy¶
GetDismissedBy returns the DismissedBy field.
func (*Alert)GetDismissedReason¶
GetDismissedReason returns the DismissedReason field if it's non-nil, zero value otherwise.
func (*Alert)GetHTMLURL¶
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*Alert)GetInstancesURL¶
GetInstancesURL returns the InstancesURL field if it's non-nil, zero value otherwise.
func (*Alert)GetMostRecentInstance¶
func (a *Alert) GetMostRecentInstance() *MostRecentInstance
GetMostRecentInstance returns the MostRecentInstance field.
func (*Alert)GetRuleDescription¶
GetRuleDescription returns the RuleDescription field if it's non-nil, zero value otherwise.
func (*Alert)GetRuleSeverity¶
GetRuleSeverity returns the RuleSeverity field if it's non-nil, zero value otherwise.
typeAlertListOptions¶
type AlertListOptions struct {// State of the code scanning alerts to list. Set to closed to list only closed code scanning alerts. Default: openStatestring `url:"state,omitempty"`// Return code scanning alerts for a specific branch reference. The ref must be formatted as heads/<branch name>.Refstring `url:"ref,omitempty"`ListOptions}
AlertListOptions specifies optional parameters to the CodeScanningService.ListAlertsmethod.
typeAllowDeletions¶
type AllowDeletions struct {Enabledbool `json:"enabled"`}
AllowDeletions represents the configuration to accept deletion of protected branches.
typeAllowForcePushes¶
type AllowForcePushes struct {Enabledbool `json:"enabled"`}
AllowForcePushes represents the configuration to accept forced pushes on protected branches.
typeAnalysesListOptions¶
type AnalysesListOptions struct {// Return code scanning analyses belonging to the same SARIF upload.SarifID *string `url:"sarif_id,omitempty"`// Return code scanning analyses for a specific branch reference. The ref can be formatted as refs/heads/<branch name> or simply <branch name>.Ref *string `url:"ref,omitempty"`ListOptions}
AnalysesListOptions specifies optional parameters to the CodeScanningService.ListAnalysesForRepo method.
func (*AnalysesListOptions)GetRef¶
func (a *AnalysesListOptions) GetRef()string
GetRef returns the Ref field if it's non-nil, zero value otherwise.
func (*AnalysesListOptions)GetSarifID¶
func (a *AnalysesListOptions) GetSarifID()string
GetSarifID returns the SarifID field if it's non-nil, zero value otherwise.
typeApp¶
type App struct {ID *int64 `json:"id,omitempty"`Slug *string `json:"slug,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 *Timestamp `json:"created_at,omitempty"`UpdatedAt *Timestamp `json:"updated_at,omitempty"`Permissions *InstallationPermissions `json:"permissions,omitempty"`Events []string `json:"events,omitempty"`}
App represents a GitHub App.
func (*App)GetCreatedAt¶
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*App)GetDescription¶
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (*App)GetExternalURL¶
GetExternalURL returns the ExternalURL field if it's non-nil, zero value otherwise.
func (*App)GetHTMLURL¶
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*App)GetPermissions¶
func (a *App) GetPermissions() *InstallationPermissions
GetPermissions returns the Permissions field.
func (*App)GetUpdatedAt¶
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
typeAppConfig¶
type AppConfig struct {ID *int64 `json:"id,omitempty"`Slug *string `json:"slug,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 *Timestamp `json:"created_at,omitempty"`UpdatedAt *Timestamp `json:"updated_at,omitempty"`ClientID *string `json:"client_id,omitempty"`ClientSecret *string `json:"client_secret,omitempty"`WebhookSecret *string `json:"webhook_secret,omitempty"`PEM *string `json:"pem,omitempty"`}
AppConfig describes the configuration of a GitHub App.
func (*AppConfig)GetClientID¶
GetClientID returns the ClientID field if it's non-nil, zero value otherwise.
func (*AppConfig)GetClientSecret¶
GetClientSecret returns the ClientSecret field if it's non-nil, zero value otherwise.
func (*AppConfig)GetCreatedAt¶
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*AppConfig)GetDescription¶
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (*AppConfig)GetExternalURL¶
GetExternalURL returns the ExternalURL field if it's non-nil, zero value otherwise.
func (*AppConfig)GetHTMLURL¶
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*AppConfig)GetNodeID¶
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (*AppConfig)GetUpdatedAt¶
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (*AppConfig)GetWebhookSecret¶
GetWebhookSecret returns the WebhookSecret field if it's non-nil, zero value otherwise.
typeAppsService¶
type AppsService service
AppsService provides access to the installation related functionsin the GitHub API.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/apps/
func (*AppsService)AddRepository¶
func (s *AppsService) AddRepository(ctxcontext.Context, instID, repoIDint64) (*Repository, *Response,error)
AddRepository adds a single repository to an installation.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/apps/#add-a-repository-to-an-app-installation
func (*AppsService)CompleteAppManifest¶
func (s *AppsService) CompleteAppManifest(ctxcontext.Context, codestring) (*AppConfig, *Response,error)
CompleteAppManifest completes the App manifest handshake flow for the givencode.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/apps/#create-a-github-app-from-a-manifest
func (*AppsService)CreateAttachment¶
func (s *AppsService) CreateAttachment(ctxcontext.Context, contentReferenceIDint64, title, bodystring) (*Attachment, *Response,error)
CreateAttachment creates a new attachment on user comment containing a url.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/apps/#create-a-content-attachment
func (*AppsService)CreateInstallationToken¶
func (s *AppsService) CreateInstallationToken(ctxcontext.Context, idint64, opts *InstallationTokenOptions) (*InstallationToken, *Response,error)
CreateInstallationToken creates a new installation token.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/apps/#create-an-installation-access-token-for-an-app
func (*AppsService)DeleteInstallation¶
DeleteInstallation deletes the specified installation.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/apps/#delete-an-installation-for-the-authenticated-app
func (*AppsService)FindOrganizationInstallation¶
func (s *AppsService) FindOrganizationInstallation(ctxcontext.Context, orgstring) (*Installation, *Response,error)
FindOrganizationInstallation finds the organization's installation information.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/apps/#get-an-organization-installation-for-the-authenticated-app
func (*AppsService)FindRepositoryInstallation¶
func (s *AppsService) FindRepositoryInstallation(ctxcontext.Context, owner, repostring) (*Installation, *Response,error)
FindRepositoryInstallation finds the repository's installation information.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/apps/#get-a-repository-installation-for-the-authenticated-app
func (*AppsService)FindRepositoryInstallationByID¶
func (s *AppsService) FindRepositoryInstallationByID(ctxcontext.Context, idint64) (*Installation, *Response,error)
FindRepositoryInstallationByID finds the repository's installation information.
Note: FindRepositoryInstallationByID uses the undocumented GitHub API endpoint /repositories/:id/installation.
func (*AppsService)FindUserInstallation¶
func (s *AppsService) FindUserInstallation(ctxcontext.Context, userstring) (*Installation, *Response,error)
FindUserInstallation finds the user's installation information.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/apps/#get-a-user-installation-for-the-authenticated-app
func (*AppsService)Get¶
Get a single GitHub App. Passing the empty string will getthe 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://docs.github.com/en/free-pro-team@latest/rest/reference/apps/#get-the-authenticated-appGitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/apps/#get-an-app
func (*AppsService)GetHookConfig¶
func (s *AppsService) GetHookConfig(ctxcontext.Context) (*HookConfig, *Response,error)
GetHookConfig returns the webhook configuration for a GitHub App.The underlying transport must be authenticated as an app.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/apps#get-a-webhook-configuration-for-an-app
func (*AppsService)GetHookDelivery¶
func (s *AppsService) GetHookDelivery(ctxcontext.Context, deliveryIDint64) (*HookDelivery, *Response,error)
GetHookDelivery returns the App webhook delivery with the specified ID.
GitHub API docs:https://docs.github.com/en/rest/reference/apps#get-a-delivery-for-an-app-webhook
func (*AppsService)GetInstallation¶
func (s *AppsService) GetInstallation(ctxcontext.Context, idint64) (*Installation, *Response,error)
GetInstallation returns the specified installation.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/apps/#get-an-installation-for-the-authenticated-app
func (*AppsService)ListHookDeliveries¶
func (s *AppsService) ListHookDeliveries(ctxcontext.Context, opts *ListCursorOptions) ([]*HookDelivery, *Response,error)
ListHookDeliveries lists deliveries of an App webhook.
GitHub API docs:https://docs.github.com/en/rest/reference/apps#list-deliveries-for-an-app-webhook
func (*AppsService)ListInstallations¶
func (s *AppsService) ListInstallations(ctxcontext.Context, opts *ListOptions) ([]*Installation, *Response,error)
ListInstallations lists the installations that the current GitHub App has.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/apps/#list-installations-for-the-authenticated-app
func (*AppsService)ListRepos¶
func (s *AppsService) ListRepos(ctxcontext.Context, opts *ListOptions) (*ListRepositories, *Response,error)
ListRepos lists the repositories that are accessible to the authenticated installation.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/apps/#list-repositories-accessible-to-the-app-installation
func (*AppsService)ListUserInstallations¶
func (s *AppsService) ListUserInstallations(ctxcontext.Context, opts *ListOptions) ([]*Installation, *Response,error)
ListUserInstallations lists installations that are accessible to the authenticated user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/apps/#list-app-installations-accessible-to-the-user-access-token
func (*AppsService)ListUserRepos¶
func (s *AppsService) ListUserRepos(ctxcontext.Context, idint64, opts *ListOptions) (*ListRepositories, *Response,error)
ListUserRepos lists repositories that are accessibleto the authenticated user for an installation.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/apps/#list-repositories-accessible-to-the-user-access-token
func (*AppsService)RedeliverHookDelivery¶
func (s *AppsService) RedeliverHookDelivery(ctxcontext.Context, deliveryIDint64) (*HookDelivery, *Response,error)
RedeliverHookDelivery redelivers a delivery for an App webhook.
GitHub API docs:https://docs.github.com/en/rest/reference/apps#redeliver-a-delivery-for-an-app-webhook
func (*AppsService)RemoveRepository¶
RemoveRepository removes a single repository from an installation.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/apps/#remove-a-repository-from-an-app-installation
func (*AppsService)RevokeInstallationToken¶
func (s *AppsService) RevokeInstallationToken(ctxcontext.Context) (*Response,error)
RevokeInstallationToken revokes an installation token.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/apps/#revoke-an-installation-access-token
func (*AppsService)SuspendInstallation¶
SuspendInstallation suspends the specified installation.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/apps/#suspend-an-app-installation
func (*AppsService)UnsuspendInstallation¶
UnsuspendInstallation unsuspends the specified installation.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/apps/#unsuspend-an-app-installation
func (*AppsService)UpdateHookConfig¶
func (s *AppsService) UpdateHookConfig(ctxcontext.Context, config *HookConfig) (*HookConfig, *Response,error)
UpdateHookConfig updates the webhook configuration for a GitHub App.The underlying transport must be authenticated as an app.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/apps#update-a-webhook-configuration-for-an-app
typeArchiveFormat¶
type ArchiveFormatstring
ArchiveFormat is used to define the archive type when calling GetArchiveLink.
const (// Tarball specifies an archive in gzipped tar format.TarballArchiveFormat = "tarball"// Zipball specifies an archive in zip format.ZipballArchiveFormat = "zipball")
typeArtifact¶
type Artifact struct {ID *int64 `json:"id,omitempty"`NodeID *string `json:"node_id,omitempty"`Name *string `json:"name,omitempty"`SizeInBytes *int64 `json:"size_in_bytes,omitempty"`ArchiveDownloadURL *string `json:"archive_download_url,omitempty"`Expired *bool `json:"expired,omitempty"`CreatedAt *Timestamp `json:"created_at,omitempty"`ExpiresAt *Timestamp `json:"expires_at,omitempty"`}
Artifact reprents a GitHub artifact. Artifacts allow sharingdata between jobs in a workflow and provide storage for dataonce a workflow is complete.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#artifacts
func (*Artifact)GetArchiveDownloadURL¶
GetArchiveDownloadURL returns the ArchiveDownloadURL field if it's non-nil, zero value otherwise.
func (*Artifact)GetCreatedAt¶
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*Artifact)GetExpired¶
GetExpired returns the Expired field if it's non-nil, zero value otherwise.
func (*Artifact)GetExpiresAt¶
GetExpiresAt returns the ExpiresAt field if it's non-nil, zero value otherwise.
func (*Artifact)GetSizeInBytes¶
GetSizeInBytes returns the SizeInBytes field if it's non-nil, zero value otherwise.
typeArtifactList¶
type ArtifactList struct {TotalCount *int64 `json:"total_count,omitempty"`Artifacts []*Artifact `json:"artifacts,omitempty"`}
ArtifactList represents a list of GitHub artifacts.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/actions/#artifacts
func (*ArtifactList)GetTotalCount¶
func (a *ArtifactList) GetTotalCount()int64
GetTotalCount returns the TotalCount field if it's non-nil, zero value otherwise.
typeAttachment¶
type Attachment struct {ID *int64 `json:"id,omitempty"`Title *string `json:"title,omitempty"`Body *string `json:"body,omitempty"`}
Attachment represents a GitHub Apps attachment.
func (*Attachment)GetBody¶
func (a *Attachment) GetBody()string
GetBody returns the Body field if it's non-nil, zero value otherwise.
func (*Attachment)GetID¶
func (a *Attachment) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*Attachment)GetTitle¶
func (a *Attachment) GetTitle()string
GetTitle returns the Title field if it's non-nil, zero value otherwise.
typeAuditEntry¶
type AuditEntry struct {Action *string `json:"action,omitempty"`// The name of the action that was performed, for example `user.login` or `repo.create`.Active *bool `json:"active,omitempty"`ActiveWas *bool `json:"active_was,omitempty"`Actor *string `json:"actor,omitempty"`// The actor who performed the action.BlockedUser *string `json:"blocked_user,omitempty"`Business *string `json:"business,omitempty"`CancelledAt *Timestamp `json:"cancelled_at,omitempty"`CompletedAt *Timestamp `json:"completed_at,omitempty"`Conclusion *string `json:"conclusion,omitempty"`Config *HookConfig `json:"config,omitempty"`ConfigWas *HookConfig `json:"config_was,omitempty"`ContentType *string `json:"content_type,omitempty"`CreatedAt *Timestamp `json:"created_at,omitempty"`DeployKeyFingerprint *string `json:"deploy_key_fingerprint,omitempty"`DocumentID *string `json:"_document_id,omitempty"`Emoji *string `json:"emoji,omitempty"`EnvironmentName *string `json:"environment_name,omitempty"`Event *string `json:"event,omitempty"`Events []string `json:"events,omitempty"`EventsWere []string `json:"events_were,omitempty"`Explanation *string `json:"explanation,omitempty"`Fingerprint *string `json:"fingerprint,omitempty"`HeadBranch *string `json:"head_branch,omitempty"`HeadSHA *string `json:"head_sha,omitempty"`HookID *int64 `json:"hook_id,omitempty"`IsHostedRunner *bool `json:"is_hosted_runner,omitempty"`JobName *string `json:"job_name,omitempty"`LimitedAvailability *bool `json:"limited_availability,omitempty"`Message *string `json:"message,omitempty"`Name *string `json:"name,omitempty"`OldUser *string `json:"old_user,omitempty"`OpenSSHPublicKey *string `json:"openssh_public_key,omitempty"`Org *string `json:"org,omitempty"`PreviousVisibility *string `json:"previous_visibility,omitempty"`ReadOnly *string `json:"read_only,omitempty"`Repo *string `json:"repo,omitempty"`Repository *string `json:"repository,omitempty"`RepositoryPublic *bool `json:"repository_public,omitempty"`RunnerGroupID *int64 `json:"runner_group_id,omitempty"`RunnerGroupName *string `json:"runner_group_name,omitempty"`RunnerID *int64 `json:"runner_id,omitempty"`RunnerLabels []string `json:"runner_labels,omitempty"`RunnerName *string `json:"runner_name,omitempty"`SecretsPassed []string `json:"secrets_passed,omitempty"`SourceVersion *string `json:"source_version,omitempty"`StartedAt *Timestamp `json:"started_at,omitempty"`TargetLogin *string `json:"target_login,omitempty"`TargetVersion *string `json:"target_version,omitempty"`Team *string `json:"team,omitempty"`Timestamp *Timestamp `json:"@timestamp,omitempty"`// The time the audit log event occurred, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time).TransportProtocolName *string `json:"transport_protocol_name,omitempty"`// A human readable name for the protocol (for example, HTTP or SSH) used to transfer Git data.TransportProtocol *int `json:"transport_protocol,omitempty"`// The type of protocol (for example, HTTP=1 or SSH=2) used to transfer Git data.TriggerID *int64 `json:"trigger_id,omitempty"`User *string `json:"user,omitempty"`// The user that was affected by the action performed (if available).Visibility *string `json:"visibility,omitempty"`// The repository visibility, for example `public` or `private`.WorkflowID *int64 `json:"workflow_id,omitempty"`WorkflowRunID *int64 `json:"workflow_run_id,omitempty"`}
AuditEntry describes the fields that may be represented by various audit-log "action" entries.For a list of actions see -https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#audit-log-actions
func (*AuditEntry)GetAction¶
func (a *AuditEntry) GetAction()string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetActive¶
func (a *AuditEntry) GetActive()bool
GetActive returns the Active field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetActiveWas¶
func (a *AuditEntry) GetActiveWas()bool
GetActiveWas returns the ActiveWas field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetActor¶
func (a *AuditEntry) GetActor()string
GetActor returns the Actor field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetBlockedUser¶
func (a *AuditEntry) GetBlockedUser()string
GetBlockedUser returns the BlockedUser field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetBusiness¶
func (a *AuditEntry) GetBusiness()string
GetBusiness returns the Business field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetCancelledAt¶
func (a *AuditEntry) GetCancelledAt()Timestamp
GetCancelledAt returns the CancelledAt field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetCompletedAt¶
func (a *AuditEntry) GetCompletedAt()Timestamp
GetCompletedAt returns the CompletedAt field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetConclusion¶
func (a *AuditEntry) GetConclusion()string
GetConclusion returns the Conclusion field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetConfig¶
func (a *AuditEntry) GetConfig() *HookConfig
GetConfig returns the Config field.
func (*AuditEntry)GetConfigWas¶
func (a *AuditEntry) GetConfigWas() *HookConfig
GetConfigWas returns the ConfigWas field.
func (*AuditEntry)GetContentType¶
func (a *AuditEntry) GetContentType()string
GetContentType returns the ContentType field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetCreatedAt¶
func (a *AuditEntry) GetCreatedAt()Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetDeployKeyFingerprint¶
func (a *AuditEntry) GetDeployKeyFingerprint()string
GetDeployKeyFingerprint returns the DeployKeyFingerprint field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetDocumentID¶
func (a *AuditEntry) GetDocumentID()string
GetDocumentID returns the DocumentID field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetEmoji¶
func (a *AuditEntry) GetEmoji()string
GetEmoji returns the Emoji field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetEnvironmentName¶
func (a *AuditEntry) GetEnvironmentName()string
GetEnvironmentName returns the EnvironmentName field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetEvent¶
func (a *AuditEntry) GetEvent()string
GetEvent returns the Event field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetExplanation¶
func (a *AuditEntry) GetExplanation()string
GetExplanation returns the Explanation field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetFingerprint¶
func (a *AuditEntry) GetFingerprint()string
GetFingerprint returns the Fingerprint field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetHeadBranch¶
func (a *AuditEntry) GetHeadBranch()string
GetHeadBranch returns the HeadBranch field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetHeadSHA¶
func (a *AuditEntry) GetHeadSHA()string
GetHeadSHA returns the HeadSHA field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetHookID¶
func (a *AuditEntry) GetHookID()int64
GetHookID returns the HookID field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetIsHostedRunner¶
func (a *AuditEntry) GetIsHostedRunner()bool
GetIsHostedRunner returns the IsHostedRunner field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetJobName¶
func (a *AuditEntry) GetJobName()string
GetJobName returns the JobName field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetLimitedAvailability¶
func (a *AuditEntry) GetLimitedAvailability()bool
GetLimitedAvailability returns the LimitedAvailability field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetMessage¶
func (a *AuditEntry) GetMessage()string
GetMessage returns the Message field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetName¶
func (a *AuditEntry) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetOldUser¶
func (a *AuditEntry) GetOldUser()string
GetOldUser returns the OldUser field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetOpenSSHPublicKey¶
func (a *AuditEntry) GetOpenSSHPublicKey()string
GetOpenSSHPublicKey returns the OpenSSHPublicKey field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetOrg¶
func (a *AuditEntry) GetOrg()string
GetOrg returns the Org field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetPreviousVisibility¶
func (a *AuditEntry) GetPreviousVisibility()string
GetPreviousVisibility returns the PreviousVisibility field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetReadOnly¶
func (a *AuditEntry) GetReadOnly()string
GetReadOnly returns the ReadOnly field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetRepo¶
func (a *AuditEntry) GetRepo()string
GetRepo returns the Repo field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetRepository¶
func (a *AuditEntry) GetRepository()string
GetRepository returns the Repository field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetRepositoryPublic¶
func (a *AuditEntry) GetRepositoryPublic()bool
GetRepositoryPublic returns the RepositoryPublic field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetRunnerGroupID¶
func (a *AuditEntry) GetRunnerGroupID()int64
GetRunnerGroupID returns the RunnerGroupID field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetRunnerGroupName¶
func (a *AuditEntry) GetRunnerGroupName()string
GetRunnerGroupName returns the RunnerGroupName field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetRunnerID¶
func (a *AuditEntry) GetRunnerID()int64
GetRunnerID returns the RunnerID field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetRunnerName¶
func (a *AuditEntry) GetRunnerName()string
GetRunnerName returns the RunnerName field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetSourceVersion¶
func (a *AuditEntry) GetSourceVersion()string
GetSourceVersion returns the SourceVersion field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetStartedAt¶
func (a *AuditEntry) GetStartedAt()Timestamp
GetStartedAt returns the StartedAt field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetTargetLogin¶
func (a *AuditEntry) GetTargetLogin()string
GetTargetLogin returns the TargetLogin field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetTargetVersion¶
func (a *AuditEntry) GetTargetVersion()string
GetTargetVersion returns the TargetVersion field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetTeam¶
func (a *AuditEntry) GetTeam()string
GetTeam returns the Team field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetTimestamp¶
func (a *AuditEntry) GetTimestamp()Timestamp
GetTimestamp returns the Timestamp field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetTransportProtocol¶
func (a *AuditEntry) GetTransportProtocol()int
GetTransportProtocol returns the TransportProtocol field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetTransportProtocolName¶
func (a *AuditEntry) GetTransportProtocolName()string
GetTransportProtocolName returns the TransportProtocolName field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetTriggerID¶
func (a *AuditEntry) GetTriggerID()int64
GetTriggerID returns the TriggerID field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetUser¶
func (a *AuditEntry) GetUser()string
GetUser returns the User field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetVisibility¶
func (a *AuditEntry) GetVisibility()string
GetVisibility returns the Visibility field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetWorkflowID¶
func (a *AuditEntry) GetWorkflowID()int64
GetWorkflowID returns the WorkflowID field if it's non-nil, zero value otherwise.
func (*AuditEntry)GetWorkflowRunID¶
func (a *AuditEntry) GetWorkflowRunID()int64
GetWorkflowRunID returns the WorkflowRunID field if it's non-nil, zero value otherwise.
typeAuthorization¶
type Authorization struct {ID *int64 `json:"id,omitempty"`URL *string `json:"url,omitempty"`Scopes []Scope `json:"scopes,omitempty"`Token *string `json:"token,omitempty"`TokenLastEight *string `json:"token_last_eight,omitempty"`HashedToken *string `json:"hashed_token,omitempty"`App *AuthorizationApp `json:"app,omitempty"`Note *string `json:"note,omitempty"`NoteURL *string `json:"note_url,omitempty"`UpdatedAt *Timestamp `json:"updated_at,omitempty"`CreatedAt *Timestamp `json:"created_at,omitempty"`Fingerprint *string `json:"fingerprint,omitempty"`// User is only populated by the Check and Reset methods.User *User `json:"user,omitempty"`}
Authorization represents an individual GitHub authorization.
func (*Authorization)GetApp¶
func (a *Authorization) GetApp() *AuthorizationApp
GetApp returns the App field.
func (*Authorization)GetCreatedAt¶
func (a *Authorization) GetCreatedAt()Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*Authorization)GetFingerprint¶
func (a *Authorization) GetFingerprint()string
GetFingerprint returns the Fingerprint field if it's non-nil, zero value otherwise.
func (*Authorization)GetHashedToken¶
func (a *Authorization) GetHashedToken()string
GetHashedToken returns the HashedToken field if it's non-nil, zero value otherwise.
func (*Authorization)GetID¶
func (a *Authorization) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*Authorization)GetNote¶
func (a *Authorization) GetNote()string
GetNote returns the Note field if it's non-nil, zero value otherwise.
func (*Authorization)GetNoteURL¶
func (a *Authorization) GetNoteURL()string
GetNoteURL returns the NoteURL field if it's non-nil, zero value otherwise.
func (*Authorization)GetToken¶
func (a *Authorization) GetToken()string
GetToken returns the Token field if it's non-nil, zero value otherwise.
func (*Authorization)GetTokenLastEight¶
func (a *Authorization) GetTokenLastEight()string
GetTokenLastEight returns the TokenLastEight field if it's non-nil, zero value otherwise.
func (*Authorization)GetURL¶
func (a *Authorization) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (*Authorization)GetUpdatedAt¶
func (a *Authorization) GetUpdatedAt()Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (Authorization)String¶
func (aAuthorization) String()string
typeAuthorizationApp¶
type AuthorizationApp struct {URL *string `json:"url,omitempty"`Name *string `json:"name,omitempty"`ClientID *string `json:"client_id,omitempty"`}
AuthorizationApp represents an individual GitHub app (in the context of authorization).
func (*AuthorizationApp)GetClientID¶
func (a *AuthorizationApp) GetClientID()string
GetClientID returns the ClientID field if it's non-nil, zero value otherwise.
func (*AuthorizationApp)GetName¶
func (a *AuthorizationApp) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*AuthorizationApp)GetURL¶
func (a *AuthorizationApp) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (AuthorizationApp)String¶
func (aAuthorizationApp) String()string
typeAuthorizationRequest¶
type AuthorizationRequest struct {Scopes []Scope `json:"scopes,omitempty"`Note *string `json:"note,omitempty"`NoteURL *string `json:"note_url,omitempty"`ClientID *string `json:"client_id,omitempty"`ClientSecret *string `json:"client_secret,omitempty"`Fingerprint *string `json:"fingerprint,omitempty"`}
AuthorizationRequest represents a request to create an authorization.
func (*AuthorizationRequest)GetClientID¶
func (a *AuthorizationRequest) GetClientID()string
GetClientID returns the ClientID field if it's non-nil, zero value otherwise.
func (*AuthorizationRequest)GetClientSecret¶
func (a *AuthorizationRequest) GetClientSecret()string
GetClientSecret returns the ClientSecret field if it's non-nil, zero value otherwise.
func (*AuthorizationRequest)GetFingerprint¶
func (a *AuthorizationRequest) GetFingerprint()string
GetFingerprint returns the Fingerprint field if it's non-nil, zero value otherwise.
func (*AuthorizationRequest)GetNote¶
func (a *AuthorizationRequest) GetNote()string
GetNote returns the Note field if it's non-nil, zero value otherwise.
func (*AuthorizationRequest)GetNoteURL¶
func (a *AuthorizationRequest) GetNoteURL()string
GetNoteURL returns the NoteURL field if it's non-nil, zero value otherwise.
func (AuthorizationRequest)String¶
func (aAuthorizationRequest) String()string
typeAuthorizationUpdateRequest¶
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://docs.github.com/en/free-pro-team@latest/rest/reference/oauth_authorizations/#update-an-existing-authorization
func (*AuthorizationUpdateRequest)GetFingerprint¶
func (a *AuthorizationUpdateRequest) GetFingerprint()string
GetFingerprint returns the Fingerprint field if it's non-nil, zero value otherwise.
func (*AuthorizationUpdateRequest)GetNote¶
func (a *AuthorizationUpdateRequest) GetNote()string
GetNote returns the Note field if it's non-nil, zero value otherwise.
func (*AuthorizationUpdateRequest)GetNoteURL¶
func (a *AuthorizationUpdateRequest) GetNoteURL()string
GetNoteURL returns the NoteURL field if it's non-nil, zero value otherwise.
func (AuthorizationUpdateRequest)String¶
func (aAuthorizationUpdateRequest) String()string
typeAuthorizationsService¶
type AuthorizationsService service
AuthorizationsService handles communication with the authorization relatedmethods of the GitHub API.
This service requires HTTP Basic Authentication; it cannot be accessed usingan OAuth token.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/oauth_authorizations/
func (*AuthorizationsService)Check¶
func (s *AuthorizationsService) Check(ctxcontext.Context, clientID, accessTokenstring) (*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 theusername is the OAuth application clientID, and the password is itsclientSecret. Invalid tokens will return a 404 Not Found.
The returned Authorization.User field will be populated.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/apps/#check-a-token
func (*AuthorizationsService)CreateImpersonation¶
func (s *AuthorizationsService) CreateImpersonation(ctxcontext.Context, usernamestring, authReq *AuthorizationRequest) (*Authorization, *Response,error)
CreateImpersonation creates an impersonation OAuth token.
This requires admin permissions. With the returned Authorization.Tokenyou can e.g. create or delete a user's public SSH key. NOTE: creating anew token automatically revokes an existing one.
GitHub API docs:https://developer.github.com/enterprise/v3/enterprise-admin/users/#create-an-impersonation-oauth-token
func (*AuthorizationsService)DeleteGrant¶
func (s *AuthorizationsService) DeleteGrant(ctxcontext.Context, clientID, accessTokenstring) (*Response,error)
DeleteGrant deletes an OAuth application grant. Deleting an application'sgrant will also delete all OAuth tokens associated with the application forthe user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/apps/#delete-an-app-authorization
func (*AuthorizationsService)DeleteImpersonation¶
func (s *AuthorizationsService) DeleteImpersonation(ctxcontext.Context, usernamestring) (*Response,error)
DeleteImpersonation deletes an impersonation OAuth token.
NOTE: there can be only one at a time.
GitHub API docs:https://developer.github.com/enterprise/v3/enterprise-admin/users/#delete-an-impersonation-oauth-token
func (*AuthorizationsService)Reset¶
func (s *AuthorizationsService) Reset(ctxcontext.Context, clientID, accessTokenstring) (*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 changestake effect immediately.
Note that this operation requires the use of BasicAuth, but where theusername is the OAuth application clientID, and the password is itsclientSecret. Invalid tokens will return a 404 Not Found.
The returned Authorization.User field will be populated.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/apps/#reset-a-token
func (*AuthorizationsService)Revoke¶
func (s *AuthorizationsService) Revoke(ctxcontext.Context, clientID, accessTokenstring) (*Response,error)
Revoke an authorization for an application.
Note that this operation requires the use of BasicAuth, but where theusername is the OAuth application clientID, and the password is itsclientSecret. Invalid tokens will return a 404 Not Found.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/apps/#delete-an-app-token
typeAuthorizedActorNames¶
type AuthorizedActorNames struct {From []string `json:"from,omitempty"`}
AuthorizedActorNames represents who are authorized to edit the branch protection rules.
typeAuthorizedActorsOnly¶
type AuthorizedActorsOnly struct {From *bool `json:"from,omitempty"`}
AuthorizedActorsOnly represents if the branche rule can be edited by authorized actors only.
func (*AuthorizedActorsOnly)GetFrom¶
func (a *AuthorizedActorsOnly) GetFrom()bool
GetFrom returns the From field if it's non-nil, zero value otherwise.
typeAutoTriggerCheck¶
type AutoTriggerCheck struct {AppID *int64 `json:"app_id,omitempty"`// The id of the GitHub App. (Required.)Setting *bool `json:"setting,omitempty"`// Set to "true" to enable automatic creation of CheckSuite events upon pushes to the repository, or "false" to disable them. Default: "true" (Required.)}
AutoTriggerCheck enables or disables automatic creation of CheckSuite events upon pushes to the repository.
func (*AutoTriggerCheck)GetAppID¶
func (a *AutoTriggerCheck) GetAppID()int64
GetAppID returns the AppID field if it's non-nil, zero value otherwise.
func (*AutoTriggerCheck)GetSetting¶
func (a *AutoTriggerCheck) GetSetting()bool
GetSetting returns the Setting field if it's non-nil, zero value otherwise.
typeAutolink¶
type Autolink struct {ID *int64 `json:"id,omitempty"`KeyPrefix *string `json:"key_prefix,omitempty"`URLTemplate *string `json:"url_template,omitempty"`}
Autolink represents autolinks to external resources like JIRA issues and Zendesk tickets.
func (*Autolink)GetKeyPrefix¶
GetKeyPrefix returns the KeyPrefix field if it's non-nil, zero value otherwise.
func (*Autolink)GetURLTemplate¶
GetURLTemplate returns the URLTemplate field if it's non-nil, zero value otherwise.
typeAutolinkOptions¶
type AutolinkOptions struct {KeyPrefix *string `json:"key_prefix,omitempty"`URLTemplate *string `json:"url_template,omitempty"`}
AutolinkOptions specifies parameters for RepositoriesService.AddAutolink method.
func (*AutolinkOptions)GetKeyPrefix¶
func (a *AutolinkOptions) GetKeyPrefix()string
GetKeyPrefix returns the KeyPrefix field if it's non-nil, zero value otherwise.
func (*AutolinkOptions)GetURLTemplate¶
func (a *AutolinkOptions) GetURLTemplate()string
GetURLTemplate returns the URLTemplate field if it's non-nil, zero value otherwise.
typeBasicAuthTransport¶
type BasicAuthTransport struct {Usernamestring// GitHub usernamePasswordstring// GitHub passwordOTPstring// 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.Transporthttp.RoundTripper}
BasicAuthTransport is an http.RoundTripper that authenticates all requestsusing HTTP Basic Authentication with the provided username and password. Itadditionally supports users who have two-factor authentication enabled ontheir GitHub account.
func (*BasicAuthTransport)Client¶
func (t *BasicAuthTransport) Client() *http.Client
Client returns an *http.Client that makes requests that are authenticatedusing HTTP Basic Authentication.
typeBillingService¶
type BillingService service
BillingService provides access to the billing related functionsin the GitHub API.
GitHub API docs:https://docs.github.com/en/rest/reference/billing
func (*BillingService)GetActionsBillingOrg¶
func (s *BillingService) GetActionsBillingOrg(ctxcontext.Context, orgstring) (*ActionBilling, *Response,error)
GetActionsBillingOrg returns the summary of the free and paid GitHub Actions minutes used for an Org.
GitHub API docs:https://docs.github.com/en/rest/reference/billing#get-github-actions-billing-for-an-organization
func (*BillingService)GetActionsBillingUser¶
func (s *BillingService) GetActionsBillingUser(ctxcontext.Context, userstring) (*ActionBilling, *Response,error)
GetActionsBillingUser returns the summary of the free and paid GitHub Actions minutes used for a user.
GitHub API docs:https://docs.github.com/en/rest/reference/billing#get-github-actions-billing-for-a-user
func (*BillingService)GetAdvancedSecurityActiveCommittersOrg¶
func (s *BillingService) GetAdvancedSecurityActiveCommittersOrg(ctxcontext.Context, orgstring) (*ActiveCommitters, *Response,error)
GetAdvancedSecurityActiveCommittersOrg returns the GitHub Advanced Security active committers for an organization per repository.
GitHub API docs:https://docs.github.com/en/rest/reference/billing#get-github-advanced-security-active-committers-for-an-organization
func (*BillingService)GetPackagesBillingOrg¶
func (s *BillingService) GetPackagesBillingOrg(ctxcontext.Context, orgstring) (*PackageBilling, *Response,error)
GetPackagesBillingOrg returns the free and paid storage used for GitHub Packages in gigabytes for an Org.
GitHub API docs:https://docs.github.com/en/rest/reference/billing#get-github-packages-billing-for-an-organization
func (*BillingService)GetPackagesBillingUser¶
func (s *BillingService) GetPackagesBillingUser(ctxcontext.Context, userstring) (*PackageBilling, *Response,error)
GetPackagesBillingUser returns the free and paid storage used for GitHub Packages in gigabytes for a user.
GitHub API docs:https://docs.github.com/en/rest/reference/billing#get-github-packages-billing-for-an-organization
func (*BillingService)GetStorageBillingOrg¶
func (s *BillingService) GetStorageBillingOrg(ctxcontext.Context, orgstring) (*StorageBilling, *Response,error)
GetStorageBillingOrg returns the estimated paid and estimated total storage used for GitHub Actionsand GitHub Packages in gigabytes for an Org.
GitHub API docs:https://docs.github.com/en/rest/reference/billing#get-shared-storage-billing-for-an-organization
func (*BillingService)GetStorageBillingUser¶
func (s *BillingService) GetStorageBillingUser(ctxcontext.Context, userstring) (*StorageBilling, *Response,error)
GetStorageBillingUser returns the estimated paid and estimated total storage used for GitHub Actionsand GitHub Packages in gigabytes for a user.
GitHub API docs:https://docs.github.com/en/rest/reference/billing#get-shared-storage-billing-for-a-user
typeBlob¶
type Blob struct {Content *string `json:"content,omitempty"`Encoding *string `json:"encoding,omitempty"`SHA *string `json:"sha,omitempty"`Size *int `json:"size,omitempty"`URL *string `json:"url,omitempty"`NodeID *string `json:"node_id,omitempty"`}
Blob represents a blob object.
func (*Blob)GetContent¶
GetContent returns the Content field if it's non-nil, zero value otherwise.
func (*Blob)GetEncoding¶
GetEncoding returns the Encoding field if it's non-nil, zero value otherwise.
typeBranch¶
type Branch struct {Name *string `json:"name,omitempty"`Commit *RepositoryCommit `json:"commit,omitempty"`Protected *bool `json:"protected,omitempty"`}
Branch represents a repository branch
func (*Branch)GetCommit¶
func (b *Branch) GetCommit() *RepositoryCommit
GetCommit returns the Commit field.
func (*Branch)GetProtected¶
GetProtected returns the Protected field if it's non-nil, zero value otherwise.
typeBranchCommit¶
type BranchCommit struct {Name *string `json:"name,omitempty"`Commit *Commit `json:"commit,omitempty"`Protected *bool `json:"protected,omitempty"`}
BranchCommit is the result of listing branches with commit SHA.
func (*BranchCommit)GetCommit¶
func (b *BranchCommit) GetCommit() *Commit
GetCommit returns the Commit field.
func (*BranchCommit)GetName¶
func (b *BranchCommit) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*BranchCommit)GetProtected¶
func (b *BranchCommit) GetProtected()bool
GetProtected returns the Protected field if it's non-nil, zero value otherwise.
typeBranchListOptions¶
type BranchListOptions struct {// Setting to true returns only protected branches.// When set to false, only unprotected branches are returned.// Omitting this parameter returns all branches.// Default: nilProtected *bool `url:"protected,omitempty"`ListOptions}
BranchListOptions specifies the optional parameters to theRepositoriesService.ListBranches method.
func (*BranchListOptions)GetProtected¶
func (b *BranchListOptions) GetProtected()bool
GetProtected returns the Protected field if it's non-nil, zero value otherwise.
typeBranchPolicy¶
type BranchPolicy struct {ProtectedBranches *bool `json:"protected_branches,omitempty"`CustomBranchPolicies *bool `json:"custom_branch_policies,omitempty"`}
BranchPolicy represents the options for whether a branch deployment policy is applied to this environment.
func (*BranchPolicy)GetCustomBranchPolicies¶
func (b *BranchPolicy) GetCustomBranchPolicies()bool
GetCustomBranchPolicies returns the CustomBranchPolicies field if it's non-nil, zero value otherwise.
func (*BranchPolicy)GetProtectedBranches¶
func (b *BranchPolicy) GetProtectedBranches()bool
GetProtectedBranches returns the ProtectedBranches field if it's non-nil, zero value otherwise.
typeBranchProtectionRule¶
type BranchProtectionRule struct {ID *int64 `json:"id,omitempty"`RepositoryID *int64 `json:"repository_id,omitempty"`Name *string `json:"name,omitempty"`CreatedAt *Timestamp `json:"created_at,omitempty"`UpdatedAt *Timestamp `json:"updated_at,omitempty"`PullRequestReviewsEnforcementLevel *string `json:"pull_request_reviews_enforcement_level,omitempty"`RequiredApprovingReviewCount *int `json:"required_approving_review_count,omitempty"`DismissStaleReviewsOnPush *bool `json:"dismiss_stale_reviews_on_push,omitempty"`AuthorizedDismissalActorsOnly *bool `json:"authorized_dismissal_actors_only,omitempty"`IgnoreApprovalsFromContributors *bool `json:"ignore_approvals_from_contributors,omitempty"`RequireCodeOwnerReview *bool `json:"require_code_owner_review,omitempty"`RequiredStatusChecks []string `json:"required_status_checks,omitempty"`RequiredStatusChecksEnforcementLevel *string `json:"required_status_checks_enforcement_level,omitempty"`StrictRequiredStatusChecksPolicy *bool `json:"strict_required_status_checks_policy,omitempty"`SignatureRequirementEnforcementLevel *string `json:"signature_requirement_enforcement_level,omitempty"`LinearHistoryRequirementEnforcementLevel *string `json:"linear_history_requirement_enforcement_level,omitempty"`AdminEnforced *bool `json:"admin_enforced,omitempty"`AllowForcePushesEnforcementLevel *string `json:"allow_force_pushes_enforcement_level,omitempty"`AllowDeletionsEnforcementLevel *string `json:"allow_deletions_enforcement_level,omitempty"`MergeQueueEnforcementLevel *string `json:"merge_queue_enforcement_level,omitempty"`RequiredDeploymentsEnforcementLevel *string `json:"required_deployments_enforcement_level,omitempty"`RequiredConversationResolutionLevel *string `json:"required_conversation_resolution_level,omitempty"`AuthorizedActorsOnly *bool `json:"authorized_actors_only,omitempty"`AuthorizedActorNames []string `json:"authorized_actor_names,omitempty"`}
BranchProtectionRule represents the rule applied to a repositories branch.
func (*BranchProtectionRule)GetAdminEnforced¶
func (b *BranchProtectionRule) GetAdminEnforced()bool
GetAdminEnforced returns the AdminEnforced field if it's non-nil, zero value otherwise.
func (*BranchProtectionRule)GetAllowDeletionsEnforcementLevel¶
func (b *BranchProtectionRule) GetAllowDeletionsEnforcementLevel()string
GetAllowDeletionsEnforcementLevel returns the AllowDeletionsEnforcementLevel field if it's non-nil, zero value otherwise.
func (*BranchProtectionRule)GetAllowForcePushesEnforcementLevel¶
func (b *BranchProtectionRule) GetAllowForcePushesEnforcementLevel()string
GetAllowForcePushesEnforcementLevel returns the AllowForcePushesEnforcementLevel field if it's non-nil, zero value otherwise.
func (*BranchProtectionRule)GetAuthorizedActorsOnly¶
func (b *BranchProtectionRule) GetAuthorizedActorsOnly()bool
GetAuthorizedActorsOnly returns the AuthorizedActorsOnly field if it's non-nil, zero value otherwise.
func (*BranchProtectionRule)GetAuthorizedDismissalActorsOnly¶
func (b *BranchProtectionRule) GetAuthorizedDismissalActorsOnly()bool
GetAuthorizedDismissalActorsOnly returns the AuthorizedDismissalActorsOnly field if it's non-nil, zero value otherwise.
func (*BranchProtectionRule)GetCreatedAt¶
func (b *BranchProtectionRule) GetCreatedAt()Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*BranchProtectionRule)GetDismissStaleReviewsOnPush¶
func (b *BranchProtectionRule) GetDismissStaleReviewsOnPush()bool
GetDismissStaleReviewsOnPush returns the DismissStaleReviewsOnPush field if it's non-nil, zero value otherwise.
func (*BranchProtectionRule)GetID¶
func (b *BranchProtectionRule) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*BranchProtectionRule)GetIgnoreApprovalsFromContributors¶
func (b *BranchProtectionRule) GetIgnoreApprovalsFromContributors()bool
GetIgnoreApprovalsFromContributors returns the IgnoreApprovalsFromContributors field if it's non-nil, zero value otherwise.
func (*BranchProtectionRule)GetLinearHistoryRequirementEnforcementLevel¶
func (b *BranchProtectionRule) GetLinearHistoryRequirementEnforcementLevel()string
GetLinearHistoryRequirementEnforcementLevel returns the LinearHistoryRequirementEnforcementLevel field if it's non-nil, zero value otherwise.
func (*BranchProtectionRule)GetMergeQueueEnforcementLevel¶
func (b *BranchProtectionRule) GetMergeQueueEnforcementLevel()string
GetMergeQueueEnforcementLevel returns the MergeQueueEnforcementLevel field if it's non-nil, zero value otherwise.
func (*BranchProtectionRule)GetName¶
func (b *BranchProtectionRule) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*BranchProtectionRule)GetPullRequestReviewsEnforcementLevel¶
func (b *BranchProtectionRule) GetPullRequestReviewsEnforcementLevel()string
GetPullRequestReviewsEnforcementLevel returns the PullRequestReviewsEnforcementLevel field if it's non-nil, zero value otherwise.
func (*BranchProtectionRule)GetRepositoryID¶
func (b *BranchProtectionRule) GetRepositoryID()int64
GetRepositoryID returns the RepositoryID field if it's non-nil, zero value otherwise.
func (*BranchProtectionRule)GetRequireCodeOwnerReview¶
func (b *BranchProtectionRule) GetRequireCodeOwnerReview()bool
GetRequireCodeOwnerReview returns the RequireCodeOwnerReview field if it's non-nil, zero value otherwise.
func (*BranchProtectionRule)GetRequiredApprovingReviewCount¶
func (b *BranchProtectionRule) GetRequiredApprovingReviewCount()int
GetRequiredApprovingReviewCount returns the RequiredApprovingReviewCount field if it's non-nil, zero value otherwise.
func (*BranchProtectionRule)GetRequiredConversationResolutionLevel¶
func (b *BranchProtectionRule) GetRequiredConversationResolutionLevel()string
GetRequiredConversationResolutionLevel returns the RequiredConversationResolutionLevel field if it's non-nil, zero value otherwise.
func (*BranchProtectionRule)GetRequiredDeploymentsEnforcementLevel¶
func (b *BranchProtectionRule) GetRequiredDeploymentsEnforcementLevel()string
GetRequiredDeploymentsEnforcementLevel returns the RequiredDeploymentsEnforcementLevel field if it's non-nil, zero value otherwise.
func (*BranchProtectionRule)GetRequiredStatusChecksEnforcementLevel¶
func (b *BranchProtectionRule) GetRequiredStatusChecksEnforcementLevel()string
GetRequiredStatusChecksEnforcementLevel returns the RequiredStatusChecksEnforcementLevel field if it's non-nil, zero value otherwise.
func (*BranchProtectionRule)GetSignatureRequirementEnforcementLevel¶
func (b *BranchProtectionRule) GetSignatureRequirementEnforcementLevel()string
GetSignatureRequirementEnforcementLevel returns the SignatureRequirementEnforcementLevel field if it's non-nil, zero value otherwise.
func (*BranchProtectionRule)GetStrictRequiredStatusChecksPolicy¶
func (b *BranchProtectionRule) GetStrictRequiredStatusChecksPolicy()bool
GetStrictRequiredStatusChecksPolicy returns the StrictRequiredStatusChecksPolicy field if it's non-nil, zero value otherwise.
func (*BranchProtectionRule)GetUpdatedAt¶
func (b *BranchProtectionRule) GetUpdatedAt()Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
typeBranchProtectionRuleEvent¶
type BranchProtectionRuleEvent struct {Action *string `json:"action,omitempty"`Rule *BranchProtectionRule `json:"rule,omitempty"`Changes *ProtectionChanges `json:"changes,omitempty"`Repo *Repository `json:"repository,omitempty"`Org *Organization `json:"organization,omitempty"`Sender *User `json:"sender,omitempty"`Installation *Installation `json:"installation,omitempty"`}
BranchProtectionRuleEvent triggered when a check suite is "created", "edited", or "deleted".The Webhook event name is "branch_protection_rule".
GitHub API docs:https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#branch_protection_rule
func (*BranchProtectionRuleEvent)GetAction¶
func (b *BranchProtectionRuleEvent) GetAction()string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*BranchProtectionRuleEvent)GetChanges¶
func (b *BranchProtectionRuleEvent) GetChanges() *ProtectionChanges
GetChanges returns the Changes field.
func (*BranchProtectionRuleEvent)GetInstallation¶
func (b *BranchProtectionRuleEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*BranchProtectionRuleEvent)GetOrg¶
func (b *BranchProtectionRuleEvent) GetOrg() *Organization
GetOrg returns the Org field.
func (*BranchProtectionRuleEvent)GetRepo¶
func (b *BranchProtectionRuleEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (*BranchProtectionRuleEvent)GetRule¶
func (b *BranchProtectionRuleEvent) GetRule() *BranchProtectionRule
GetRule returns the Rule field.
func (*BranchProtectionRuleEvent)GetSender¶
func (b *BranchProtectionRuleEvent) GetSender() *User
GetSender returns the Sender field.
typeBranchRestrictions¶
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"`// The list of app slugs with push access.Apps []*App `json:"apps"`}
BranchRestrictions represents the restriction that only certain users orteams may push to a branch.
typeBranchRestrictionsRequest¶
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"`// The list of app slugs with push access.Apps []string `json:"apps,omitempty"`}
BranchRestrictionsRequest represents the request to create/edit therestriction that only certain users or teams may push to a branch. It isseparate from BranchRestrictions above because the request structure isdifferent from the response structure.
typeCheckRun¶
type CheckRun struct {ID *int64 `json:"id,omitempty"`NodeID *string `json:"node_id,omitempty"`HeadSHA *string `json:"head_sha,omitempty"`ExternalID *string `json:"external_id,omitempty"`URL *string `json:"url,omitempty"`HTMLURL *string `json:"html_url,omitempty"`DetailsURL *string `json:"details_url,omitempty"`Status *string `json:"status,omitempty"`Conclusion *string `json:"conclusion,omitempty"`StartedAt *Timestamp `json:"started_at,omitempty"`CompletedAt *Timestamp `json:"completed_at,omitempty"`Output *CheckRunOutput `json:"output,omitempty"`Name *string `json:"name,omitempty"`CheckSuite *CheckSuite `json:"check_suite,omitempty"`App *App `json:"app,omitempty"`PullRequests []*PullRequest `json:"pull_requests,omitempty"`}
CheckRun represents a GitHub check run on a repository associated with a GitHub app.
func (*CheckRun)GetCheckSuite¶
func (c *CheckRun) GetCheckSuite() *CheckSuite
GetCheckSuite returns the CheckSuite field.
func (*CheckRun)GetCompletedAt¶
GetCompletedAt returns the CompletedAt field if it's non-nil, zero value otherwise.
func (*CheckRun)GetConclusion¶
GetConclusion returns the Conclusion field if it's non-nil, zero value otherwise.
func (*CheckRun)GetDetailsURL¶
GetDetailsURL returns the DetailsURL field if it's non-nil, zero value otherwise.
func (*CheckRun)GetExternalID¶
GetExternalID returns the ExternalID field if it's non-nil, zero value otherwise.
func (*CheckRun)GetHTMLURL¶
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*CheckRun)GetHeadSHA¶
GetHeadSHA returns the HeadSHA field if it's non-nil, zero value otherwise.
func (*CheckRun)GetOutput¶
func (c *CheckRun) GetOutput() *CheckRunOutput
GetOutput returns the Output field.
func (*CheckRun)GetStartedAt¶
GetStartedAt returns the StartedAt field if it's non-nil, zero value otherwise.
typeCheckRunAction¶
type CheckRunAction struct {Labelstring `json:"label"`// The text to be displayed on a button in the web UI. The maximum size is 20 characters. (Required.)Descriptionstring `json:"description"`// A short explanation of what this action would do. The maximum size is 40 characters. (Required.)Identifierstring `json:"identifier"`// A reference for the action on the integrator's system. The maximum size is 20 characters. (Required.)}
CheckRunAction exposes further actions the integrator can perform, which a user may trigger.
typeCheckRunAnnotation¶
type CheckRunAnnotation struct {Path *string `json:"path,omitempty"`StartLine *int `json:"start_line,omitempty"`EndLine *int `json:"end_line,omitempty"`StartColumn *int `json:"start_column,omitempty"`EndColumn *int `json:"end_column,omitempty"`AnnotationLevel *string `json:"annotation_level,omitempty"`Message *string `json:"message,omitempty"`Title *string `json:"title,omitempty"`RawDetails *string `json:"raw_details,omitempty"`}
CheckRunAnnotation represents an annotation object for a CheckRun output.
func (*CheckRunAnnotation)GetAnnotationLevel¶
func (c *CheckRunAnnotation) GetAnnotationLevel()string
GetAnnotationLevel returns the AnnotationLevel field if it's non-nil, zero value otherwise.
func (*CheckRunAnnotation)GetEndColumn¶
func (c *CheckRunAnnotation) GetEndColumn()int
GetEndColumn returns the EndColumn field if it's non-nil, zero value otherwise.
func (*CheckRunAnnotation)GetEndLine¶
func (c *CheckRunAnnotation) GetEndLine()int
GetEndLine returns the EndLine field if it's non-nil, zero value otherwise.
func (*CheckRunAnnotation)GetMessage¶
func (c *CheckRunAnnotation) GetMessage()string
GetMessage returns the Message field if it's non-nil, zero value otherwise.
func (*CheckRunAnnotation)GetPath¶
func (c *CheckRunAnnotation) GetPath()string
GetPath returns the Path field if it's non-nil, zero value otherwise.
func (*CheckRunAnnotation)GetRawDetails¶
func (c *CheckRunAnnotation) GetRawDetails()string
GetRawDetails returns the RawDetails field if it's non-nil, zero value otherwise.
func (*CheckRunAnnotation)GetStartColumn¶
func (c *CheckRunAnnotation) GetStartColumn()int
GetStartColumn returns the StartColumn field if it's non-nil, zero value otherwise.
func (*CheckRunAnnotation)GetStartLine¶
func (c *CheckRunAnnotation) GetStartLine()int
GetStartLine returns the StartLine field if it's non-nil, zero value otherwise.
func (*CheckRunAnnotation)GetTitle¶
func (c *CheckRunAnnotation) GetTitle()string
GetTitle returns the Title field if it's non-nil, zero value otherwise.
typeCheckRunEvent¶
type CheckRunEvent struct {CheckRun *CheckRun `json:"check_run,omitempty"`// The action performed. Possible values are: "created", "completed", "rerequested" or "requested_action".Action *string `json:"action,omitempty"`// The following fields are only populated by Webhook events.Repo *Repository `json:"repository,omitempty"`Org *Organization `json:"organization,omitempty"`Sender *User `json:"sender,omitempty"`Installation *Installation `json:"installation,omitempty"`// The action requested by the user. Populated when the Action is "requested_action".RequestedAction *RequestedAction `json:"requested_action,omitempty"`//}
CheckRunEvent is triggered when a check run is "created", "completed", or "rerequested".The Webhook event name is "check_run".
GitHub API docs:https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#check_run
func (*CheckRunEvent)GetAction¶
func (c *CheckRunEvent) GetAction()string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*CheckRunEvent)GetCheckRun¶
func (c *CheckRunEvent) GetCheckRun() *CheckRun
GetCheckRun returns the CheckRun field.
func (*CheckRunEvent)GetInstallation¶
func (c *CheckRunEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*CheckRunEvent)GetOrg¶
func (c *CheckRunEvent) GetOrg() *Organization
GetOrg returns the Org field.
func (*CheckRunEvent)GetRepo¶
func (c *CheckRunEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (*CheckRunEvent)GetRequestedAction¶
func (c *CheckRunEvent) GetRequestedAction() *RequestedAction
GetRequestedAction returns the RequestedAction field.
func (*CheckRunEvent)GetSender¶
func (c *CheckRunEvent) GetSender() *User
GetSender returns the Sender field.
typeCheckRunImage¶
type CheckRunImage struct {Alt *string `json:"alt,omitempty"`ImageURL *string `json:"image_url,omitempty"`Caption *string `json:"caption,omitempty"`}
CheckRunImage represents an image object for a CheckRun output.
func (*CheckRunImage)GetAlt¶
func (c *CheckRunImage) GetAlt()string
GetAlt returns the Alt field if it's non-nil, zero value otherwise.
func (*CheckRunImage)GetCaption¶
func (c *CheckRunImage) GetCaption()string
GetCaption returns the Caption field if it's non-nil, zero value otherwise.
func (*CheckRunImage)GetImageURL¶
func (c *CheckRunImage) GetImageURL()string
GetImageURL returns the ImageURL field if it's non-nil, zero value otherwise.
typeCheckRunOutput¶
type CheckRunOutput struct {Title *string `json:"title,omitempty"`Summary *string `json:"summary,omitempty"`Text *string `json:"text,omitempty"`AnnotationsCount *int `json:"annotations_count,omitempty"`AnnotationsURL *string `json:"annotations_url,omitempty"`Annotations []*CheckRunAnnotation `json:"annotations,omitempty"`Images []*CheckRunImage `json:"images,omitempty"`}
CheckRunOutput represents the output of a CheckRun.
func (*CheckRunOutput)GetAnnotationsCount¶
func (c *CheckRunOutput) GetAnnotationsCount()int
GetAnnotationsCount returns the AnnotationsCount field if it's non-nil, zero value otherwise.
func (*CheckRunOutput)GetAnnotationsURL¶
func (c *CheckRunOutput) GetAnnotationsURL()string
GetAnnotationsURL returns the AnnotationsURL field if it's non-nil, zero value otherwise.
func (*CheckRunOutput)GetSummary¶
func (c *CheckRunOutput) GetSummary()string
GetSummary returns the Summary field if it's non-nil, zero value otherwise.
func (*CheckRunOutput)GetText¶
func (c *CheckRunOutput) GetText()string
GetText returns the Text field if it's non-nil, zero value otherwise.
func (*CheckRunOutput)GetTitle¶
func (c *CheckRunOutput) GetTitle()string
GetTitle returns the Title field if it's non-nil, zero value otherwise.
typeCheckSuite¶
type CheckSuite struct {ID *int64 `json:"id,omitempty"`NodeID *string `json:"node_id,omitempty"`HeadBranch *string `json:"head_branch,omitempty"`HeadSHA *string `json:"head_sha,omitempty"`URL *string `json:"url,omitempty"`BeforeSHA *string `json:"before,omitempty"`AfterSHA *string `json:"after,omitempty"`Status *string `json:"status,omitempty"`Conclusion *string `json:"conclusion,omitempty"`CreatedAt *Timestamp `json:"created_at,omitempty"`UpdatedAt *Timestamp `json:"updated_at,omitempty"`App *App `json:"app,omitempty"`Repository *Repository `json:"repository,omitempty"`PullRequests []*PullRequest `json:"pull_requests,omitempty"`// The following fields are only populated by Webhook events.HeadCommit *Commit `json:"head_commit,omitempty"`}
CheckSuite represents a suite of check runs.
func (*CheckSuite)GetAfterSHA¶
func (c *CheckSuite) GetAfterSHA()string
GetAfterSHA returns the AfterSHA field if it's non-nil, zero value otherwise.
func (*CheckSuite)GetBeforeSHA¶
func (c *CheckSuite) GetBeforeSHA()string
GetBeforeSHA returns the BeforeSHA field if it's non-nil, zero value otherwise.
func (*CheckSuite)GetConclusion¶
func (c *CheckSuite) GetConclusion()string
GetConclusion returns the Conclusion field if it's non-nil, zero value otherwise.
func (*CheckSuite)GetCreatedAt¶
func (c *CheckSuite) GetCreatedAt()Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*CheckSuite)GetHeadBranch¶
func (c *CheckSuite) GetHeadBranch()string
GetHeadBranch returns the HeadBranch field if it's non-nil, zero value otherwise.
func (*CheckSuite)GetHeadCommit¶
func (c *CheckSuite) GetHeadCommit() *Commit
GetHeadCommit returns the HeadCommit field.
func (*CheckSuite)GetHeadSHA¶
func (c *CheckSuite) GetHeadSHA()string
GetHeadSHA returns the HeadSHA field if it's non-nil, zero value otherwise.
func (*CheckSuite)GetID¶
func (c *CheckSuite) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*CheckSuite)GetNodeID¶
func (c *CheckSuite) GetNodeID()string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (*CheckSuite)GetRepository¶
func (c *CheckSuite) GetRepository() *Repository
GetRepository returns the Repository field.
func (*CheckSuite)GetStatus¶
func (c *CheckSuite) GetStatus()string
GetStatus returns the Status field if it's non-nil, zero value otherwise.
func (*CheckSuite)GetURL¶
func (c *CheckSuite) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (*CheckSuite)GetUpdatedAt¶
func (c *CheckSuite) GetUpdatedAt()Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (CheckSuite)String¶
func (cCheckSuite) String()string
typeCheckSuiteEvent¶
type CheckSuiteEvent struct {CheckSuite *CheckSuite `json:"check_suite,omitempty"`// The action performed. Possible values are: "completed", "requested" or "rerequested".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 "rerequested".The Webhook event name is "check_suite".
GitHub API docs:https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#check_suite
func (*CheckSuiteEvent)GetAction¶
func (c *CheckSuiteEvent) GetAction()string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*CheckSuiteEvent)GetCheckSuite¶
func (c *CheckSuiteEvent) GetCheckSuite() *CheckSuite
GetCheckSuite returns the CheckSuite field.
func (*CheckSuiteEvent)GetInstallation¶
func (c *CheckSuiteEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*CheckSuiteEvent)GetOrg¶
func (c *CheckSuiteEvent) GetOrg() *Organization
GetOrg returns the Org field.
func (*CheckSuiteEvent)GetRepo¶
func (c *CheckSuiteEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (*CheckSuiteEvent)GetSender¶
func (c *CheckSuiteEvent) GetSender() *User
GetSender returns the Sender field.
typeCheckSuitePreferenceOptions¶
type CheckSuitePreferenceOptions 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.}
CheckSuitePreferenceOptions set options for check suite preferences for a repository.
typeCheckSuitePreferenceResults¶
type CheckSuitePreferenceResults struct {Preferences *PreferenceList `json:"preferences,omitempty"`Repository *Repository `json:"repository,omitempty"`}
CheckSuitePreferenceResults represents the results of the preference set operation.
func (*CheckSuitePreferenceResults)GetPreferences¶
func (c *CheckSuitePreferenceResults) GetPreferences() *PreferenceList
GetPreferences returns the Preferences field.
func (*CheckSuitePreferenceResults)GetRepository¶
func (c *CheckSuitePreferenceResults) GetRepository() *Repository
GetRepository returns the Repository field.
typeChecksService¶
type ChecksService service
ChecksService provides access to the Checks API in theGitHub API.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/checks/
func (*ChecksService)CreateCheckRun¶
func (s *ChecksService) CreateCheckRun(ctxcontext.Context, owner, repostring, optsCreateCheckRunOptions) (*CheckRun, *Response,error)
CreateCheckRun creates a check run for repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/checks/#create-a-check-run
func (*ChecksService)CreateCheckSuite¶
func (s *ChecksService) CreateCheckSuite(ctxcontext.Context, owner, repostring, optsCreateCheckSuiteOptions) (*CheckSuite, *Response,error)
CreateCheckSuite manually creates a check suite for a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/checks/#create-a-check-suite
func (*ChecksService)GetCheckRun¶
func (s *ChecksService) GetCheckRun(ctxcontext.Context, owner, repostring, checkRunIDint64) (*CheckRun, *Response,error)
GetCheckRun gets a check-run for a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/checks/#get-a-check-run
func (*ChecksService)GetCheckSuite¶
func (s *ChecksService) GetCheckSuite(ctxcontext.Context, owner, repostring, checkSuiteIDint64) (*CheckSuite, *Response,error)
GetCheckSuite gets a single check suite.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/checks/#get-a-check-suite
func (*ChecksService)ListCheckRunAnnotations¶
func (s *ChecksService) ListCheckRunAnnotations(ctxcontext.Context, owner, repostring, checkRunIDint64, opts *ListOptions) ([]*CheckRunAnnotation, *Response,error)
ListCheckRunAnnotations lists the annotations for a check run.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/checks/#list-check-run-annotations
func (*ChecksService)ListCheckRunsCheckSuite¶
func (s *ChecksService) ListCheckRunsCheckSuite(ctxcontext.Context, owner, repostring, checkSuiteIDint64, opts *ListCheckRunsOptions) (*ListCheckRunsResults, *Response,error)
ListCheckRunsCheckSuite lists check runs for a check suite.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/checks/#list-check-runs-in-a-check-suite
func (*ChecksService)ListCheckRunsForRef¶
func (s *ChecksService) ListCheckRunsForRef(ctxcontext.Context, owner, repo, refstring, opts *ListCheckRunsOptions) (*ListCheckRunsResults, *Response,error)
ListCheckRunsForRef lists check runs for a specific ref.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/checks/#list-check-runs-for-a-git-reference
func (*ChecksService)ListCheckSuitesForRef¶
func (s *ChecksService) ListCheckSuitesForRef(ctxcontext.Context, owner, repo, refstring, opts *ListCheckSuiteOptions) (*ListCheckSuiteResults, *Response,error)
ListCheckSuitesForRef lists check suite for a specific ref.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/checks/#list-check-suites-for-a-git-reference
func (*ChecksService)ReRequestCheckSuite¶
func (s *ChecksService) ReRequestCheckSuite(ctxcontext.Context, owner, repostring, checkSuiteIDint64) (*Response,error)
ReRequestCheckSuite triggers GitHub to rerequest an existing check suite, without pushing new code to a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/checks/#rerequest-a-check-suite
func (*ChecksService)SetCheckSuitePreferences¶
func (s *ChecksService) SetCheckSuitePreferences(ctxcontext.Context, owner, repostring, optsCheckSuitePreferenceOptions) (*CheckSuitePreferenceResults, *Response,error)
SetCheckSuitePreferences changes the default automatic flow when creating check suites.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/checks/#update-repository-preferences-for-check-suites
func (*ChecksService)UpdateCheckRun¶
func (s *ChecksService) UpdateCheckRun(ctxcontext.Context, owner, repostring, checkRunIDint64, optsUpdateCheckRunOptions) (*CheckRun, *Response,error)
UpdateCheckRun updates a check run for a specific commit in a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/checks/#update-a-check-run
typeClient¶
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.UserAgentstring// Services used for talking to different parts of the GitHub API.Actions *ActionsServiceActivity *ActivityServiceAdmin *AdminServiceApps *AppsServiceAuthorizations *AuthorizationsServiceBilling *BillingServiceChecks *ChecksServiceCodeScanning *CodeScanningServiceDependabot *DependabotServiceEnterprise *EnterpriseServiceGists *GistsServiceGit *GitServiceGitignores *GitignoresServiceInteractions *InteractionsServiceIssueImport *IssueImportServiceIssues *IssuesServiceLicenses *LicensesServiceMarketplace *MarketplaceServiceMigrations *MigrationServiceOrganizations *OrganizationsServiceProjects *ProjectsServicePullRequests *PullRequestsServiceReactions *ReactionsServiceRepositories *RepositoriesServiceSCIM *SCIMServiceSearch *SearchServiceSecretScanning *SecretScanningServiceTeams *TeamsServiceUsers *UsersService// contains filtered or unexported fields}
A Client manages communication with the GitHub API.
funcNewClient¶
NewClient returns a new GitHub API client. If a nil httpClient isprovided, a new http.Client will be used. To use API methods which requireauthentication, provide an http.Client that will perform the authenticationfor you (such as that provided by the golang.org/x/oauth2 library).
funcNewEnterpriseClient¶
NewEnterpriseClient returns a new GitHub API client with providedbase URL and upload URL (often is your GitHub Enterprise hostname).If the base URL does not have the suffix "/api/v3/", it will be added automatically.If the upload URL does not have the suffix "/api/uploads", it will be added automatically.If a nil httpClient is provided, a new http.Client will be used.
Note that NewEnterpriseClient is a convenience helper only;its behavior is equivalent to using NewClient, followed by settingthe BaseURL and UploadURL fields.
Another important thing is that by default, the GitHub Enterprise URL formatshould be http(s)://[hostname]/api/v3/ or you will always receive the 406 status code.The upload URL format should be http(s)://[hostname]/api/uploads/.
func (*Client)APIMeta¶
APIMeta returns information about GitHub.com, the service. Or, if you accessthis endpoint on your organization’s GitHub Enterprise installation, thisendpoint provides information about that installation.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/meta#get-github-meta-information
func (*Client)BareDo¶
BareDo sends an API request and lets you handle the api response. If an erroror API Error occurs, the error will contain more information. Otherwise youare supposed to read and close the response's Body. If rate limit is exceededand reset time is in the future, BareDo returns *RateLimitError immediatelywithout making a network API call.
The provided ctx must be non-nil, if it is nil an error is returned. If it iscanceled or times out, ctx.Err() will be returned.
func (*Client)Do¶
Do sends an API request and returns the API response. The API response isJSON decoded and stored in the value pointed to by v, or returned as anerror 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 firstdecode it. If v is nil, and no error hapens, the response is returned as is.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 nil an error is returned. If itis canceled or times out, ctx.Err() will be returned.
func (*Client)GetCodeOfConduct¶
GetCodeOfConduct returns an individual code of conduct.
func (*Client)ListCodesOfConduct¶
ListCodesOfConduct returns all codes of conduct.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/codes_of_conduct/#list-all-codes-of-conduct
func (*Client)ListEmojis¶
ListEmojis returns the emojis available to use on GitHub.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/emojis/
func (*Client)ListServiceHooks¶
ListServiceHooks lists all of the available service hooks.
GitHub API docs:https://developer.github.com/webhooks/#services
func (*Client)Markdown¶
func (c *Client) Markdown(ctxcontext.Context, textstring, opts *MarkdownOptions) (string, *Response,error)
Markdown renders an arbitrary Markdown document.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/markdown/
Example¶
package mainimport ("context""fmt""github.com/google/go-github/v43/github")func main() {client := github.NewClient(nil)input := "# heading #\n\nLink to issue #1"opt := &github.MarkdownOptions{Mode: "gfm", Context: "google/go-github"}ctx := context.Background()output, _, err := client.Markdown(ctx, input, opt)if err != nil {fmt.Println(err)}fmt.Println(output)}
func (*Client)NewRequest¶
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. Ifspecified, the value pointed to by body is JSON encoded and included as therequest body.
func (*Client)NewUploadRequest¶
func (c *Client) NewUploadRequest(urlStrstring, readerio.Reader, sizeint64, mediaTypestring) (*http.Request,error)
NewUploadRequest creates an upload request. A relative URL can be provided inurlStr, in which case it is resolved relative to the UploadURL of the Client.Relative URLs should always be specified without a preceding slash.
func (*Client)Octocat¶
Octocat returns an ASCII art octocat with the specified message in a speechbubble. If message is empty, a random zen phrase is used.
func (*Client)RateLimits¶
RateLimits returns the rate limits for the current client.
typeCodeOfConduct¶
type CodeOfConduct struct {Name *string `json:"name,omitempty"`Key *string `json:"key,omitempty"`URL *string `json:"url,omitempty"`Body *string `json:"body,omitempty"`}
CodeOfConduct represents a code of conduct.
func (*CodeOfConduct)GetBody¶
func (c *CodeOfConduct) GetBody()string
GetBody returns the Body field if it's non-nil, zero value otherwise.
func (*CodeOfConduct)GetKey¶
func (c *CodeOfConduct) GetKey()string
GetKey returns the Key field if it's non-nil, zero value otherwise.
func (*CodeOfConduct)GetName¶
func (c *CodeOfConduct) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*CodeOfConduct)GetURL¶
func (c *CodeOfConduct) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (*CodeOfConduct)String¶
func (c *CodeOfConduct) String()string
typeCodeResult¶
type CodeResult struct {Name *string `json:"name,omitempty"`Path *string `json:"path,omitempty"`SHA *string `json:"sha,omitempty"`HTMLURL *string `json:"html_url,omitempty"`Repository *Repository `json:"repository,omitempty"`TextMatches []*TextMatch `json:"text_matches,omitempty"`}
CodeResult represents a single search result.
func (*CodeResult)GetHTMLURL¶
func (c *CodeResult) GetHTMLURL()string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*CodeResult)GetName¶
func (c *CodeResult) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*CodeResult)GetPath¶
func (c *CodeResult) GetPath()string
GetPath returns the Path field if it's non-nil, zero value otherwise.
func (*CodeResult)GetRepository¶
func (c *CodeResult) GetRepository() *Repository
GetRepository returns the Repository field.
func (*CodeResult)GetSHA¶
func (c *CodeResult) GetSHA()string
GetSHA returns the SHA field if it's non-nil, zero value otherwise.
func (CodeResult)String¶
func (cCodeResult) String()string
typeCodeScanningService¶
type CodeScanningService service
CodeScanningService handles communication with the code scanning relatedmethods of the GitHub API.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/code-scanning/
func (*CodeScanningService)GetAlert¶
func (s *CodeScanningService) GetAlert(ctxcontext.Context, owner, repostring, idint64) (*Alert, *Response,error)
GetAlert gets a single code scanning alert for a repository.
You must use an access token with the security_events scope to use this endpoint.GitHub Apps must have the security_events read permission to use this endpoint.
The security alert_id is the number at the end of the security alert's URL.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/code-scanning/#get-a-code-scanning-alert
func (*CodeScanningService)GetAnalysis¶
func (s *CodeScanningService) GetAnalysis(ctxcontext.Context, owner, repostring, idint64) (*ScanningAnalysis, *Response,error)
GetAnalysis gets a single code scanning analysis for a repository.
You must use an access token with the security_events scope to use this endpoint.GitHub Apps must have the security_events read permission to use this endpoint.
The security analysis_id is the ID of the analysis, as returned from the ListAnalysesForRepo operation.
GitHub API docs:https://docs.github.com/en/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository
func (*CodeScanningService)ListAlertsForRepo¶
func (s *CodeScanningService) ListAlertsForRepo(ctxcontext.Context, owner, repostring, opts *AlertListOptions) ([]*Alert, *Response,error)
ListAlertsForRepo lists code scanning alerts for a repository.
Lists all open code scanning alerts for the default branch (usually master) and protected branches in a repository.You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_eventsread permission to use this endpoint.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/code-scanning/#list-code-scanning-alerts-for-a-repository
func (*CodeScanningService)ListAnalysesForRepo¶
func (s *CodeScanningService) ListAnalysesForRepo(ctxcontext.Context, owner, repostring, opts *AnalysesListOptions) ([]*ScanningAnalysis, *Response,error)
ListAnalysesForRepo lists code scanning analyses for a repository.
Lists the details of all code scanning analyses for a repository, starting with the most recent.You must use an access token with the security_events scope to use this endpoint.GitHub Apps must have the security_events read permission to use this endpoint.
GitHub API docs:https://docs.github.com/en/rest/reference/code-scanning#list-code-scanning-analyses-for-a-repository
func (*CodeScanningService)UploadSarif¶
func (s *CodeScanningService) UploadSarif(ctxcontext.Context, owner, repostring, sarif *SarifAnalysis) (*SarifID, *Response,error)
UploadSarif uploads the result of code scanning job to GitHub.
For the parameter sarif, you must first compress your SARIF file using gzip and then translate the contents of the file into a Base64 encoding string.You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_eventswrite permission to use this endpoint.
GitHub API docs:https://docs.github.com/en/rest/reference/code-scanning#upload-an-analysis-as-sarif-data
typeCodeSearchResult¶
type CodeSearchResult struct {Total *int `json:"total_count,omitempty"`IncompleteResults *bool `json:"incomplete_results,omitempty"`CodeResults []*CodeResult `json:"items,omitempty"`}
CodeSearchResult represents the result of a code search.
func (*CodeSearchResult)GetIncompleteResults¶
func (c *CodeSearchResult) GetIncompleteResults()bool
GetIncompleteResults returns the IncompleteResults field if it's non-nil, zero value otherwise.
func (*CodeSearchResult)GetTotal¶
func (c *CodeSearchResult) GetTotal()int
GetTotal returns the Total field if it's non-nil, zero value otherwise.
typeCollaboratorInvitation¶
type CollaboratorInvitation struct {ID *int64 `json:"id,omitempty"`Repo *Repository `json:"repository,omitempty"`Invitee *User `json:"invitee,omitempty"`Inviter *User `json:"inviter,omitempty"`Permissions *string `json:"permissions,omitempty"`CreatedAt *Timestamp `json:"created_at,omitempty"`URL *string `json:"url,omitempty"`HTMLURL *string `json:"html_url,omitempty"`}
CollaboratorInvitation represents an invitation created when adding a collaborator.GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/collaborators/#response-when-a-new-invitation-is-created
func (*CollaboratorInvitation)GetCreatedAt¶
func (c *CollaboratorInvitation) GetCreatedAt()Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*CollaboratorInvitation)GetHTMLURL¶
func (c *CollaboratorInvitation) GetHTMLURL()string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*CollaboratorInvitation)GetID¶
func (c *CollaboratorInvitation) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*CollaboratorInvitation)GetInvitee¶
func (c *CollaboratorInvitation) GetInvitee() *User
GetInvitee returns the Invitee field.
func (*CollaboratorInvitation)GetInviter¶
func (c *CollaboratorInvitation) GetInviter() *User
GetInviter returns the Inviter field.
func (*CollaboratorInvitation)GetPermissions¶
func (c *CollaboratorInvitation) GetPermissions()string
GetPermissions returns the Permissions field if it's non-nil, zero value otherwise.
func (*CollaboratorInvitation)GetRepo¶
func (c *CollaboratorInvitation) GetRepo() *Repository
GetRepo returns the Repo field.
func (*CollaboratorInvitation)GetURL¶
func (c *CollaboratorInvitation) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
typeCombinedStatus¶
type CombinedStatus struct {// State is the combined state of the repository. Possible values are:// failure, pending, or success.State *string `json:"state,omitempty"`Name *string `json:"name,omitempty"`SHA *string `json:"sha,omitempty"`TotalCount *int `json:"total_count,omitempty"`Statuses []*RepoStatus `json:"statuses,omitempty"`CommitURL *string `json:"commit_url,omitempty"`RepositoryURL *string `json:"repository_url,omitempty"`}
CombinedStatus represents the combined status of a repository at a particular reference.
func (*CombinedStatus)GetCommitURL¶
func (c *CombinedStatus) GetCommitURL()string
GetCommitURL returns the CommitURL field if it's non-nil, zero value otherwise.
func (*CombinedStatus)GetName¶
func (c *CombinedStatus) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*CombinedStatus)GetRepositoryURL¶
func (c *CombinedStatus) GetRepositoryURL()string
GetRepositoryURL returns the RepositoryURL field if it's non-nil, zero value otherwise.
func (*CombinedStatus)GetSHA¶
func (c *CombinedStatus) GetSHA()string
GetSHA returns the SHA field if it's non-nil, zero value otherwise.
func (*CombinedStatus)GetState¶
func (c *CombinedStatus) GetState()string
GetState returns the State field if it's non-nil, zero value otherwise.
func (*CombinedStatus)GetTotalCount¶
func (c *CombinedStatus) GetTotalCount()int
GetTotalCount returns the TotalCount field if it's non-nil, zero value otherwise.
func (CombinedStatus)String¶
func (sCombinedStatus) String()string
typeComment¶
Comment represents comments of issue to import.
func (*Comment)GetCreatedAt¶
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
typeCommentStats¶
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, issuesand pull requests.
func (*CommentStats)GetTotalCommitComments¶
func (c *CommentStats) GetTotalCommitComments()int
GetTotalCommitComments returns the TotalCommitComments field if it's non-nil, zero value otherwise.
func (*CommentStats)GetTotalGistComments¶
func (c *CommentStats) GetTotalGistComments()int
GetTotalGistComments returns the TotalGistComments field if it's non-nil, zero value otherwise.
func (*CommentStats)GetTotalIssueComments¶
func (c *CommentStats) GetTotalIssueComments()int
GetTotalIssueComments returns the TotalIssueComments field if it's non-nil, zero value otherwise.
func (*CommentStats)GetTotalPullRequestComments¶
func (c *CommentStats) GetTotalPullRequestComments()int
GetTotalPullRequestComments returns the TotalPullRequestComments field if it's non-nil, zero value otherwise.
func (CommentStats)String¶
func (sCommentStats) String()string
typeCommit¶
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"`// SigningKey denotes a key to sign the commit with. If not nil this key will// be used to sign the commit. The private key must be present and already// decrypted. Ignored if Verification.Signature is defined.SigningKey *openpgp.Entity `json:"-"`}
Commit represents a GitHub commit.
func (*Commit)GetAuthor¶
func (c *Commit) GetAuthor() *CommitAuthor
GetAuthor returns the Author field.
func (*Commit)GetCommentCount¶
GetCommentCount returns the CommentCount field if it's non-nil, zero value otherwise.
func (*Commit)GetCommitter¶
func (c *Commit) GetCommitter() *CommitAuthor
GetCommitter returns the Committer field.
func (*Commit)GetHTMLURL¶
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*Commit)GetMessage¶
GetMessage returns the Message field if it's non-nil, zero value otherwise.
func (*Commit)GetVerification¶
func (c *Commit) GetVerification() *SignatureVerification
GetVerification returns the Verification field.
typeCommitAuthor¶
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 commitauthor may not correspond to a GitHub User.
func (*CommitAuthor)GetDate¶
func (c *CommitAuthor) GetDate()time.Time
GetDate returns the Date field if it's non-nil, zero value otherwise.
func (*CommitAuthor)GetEmail¶
func (c *CommitAuthor) GetEmail()string
GetEmail returns the Email field if it's non-nil, zero value otherwise.
func (*CommitAuthor)GetLogin¶
func (c *CommitAuthor) GetLogin()string
GetLogin returns the Login field if it's non-nil, zero value otherwise.
func (*CommitAuthor)GetName¶
func (c *CommitAuthor) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (CommitAuthor)String¶
func (cCommitAuthor) String()string
typeCommitCommentEvent¶
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://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#commit_comment
func (*CommitCommentEvent)GetAction¶
func (c *CommitCommentEvent) GetAction()string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*CommitCommentEvent)GetComment¶
func (c *CommitCommentEvent) GetComment() *RepositoryComment
GetComment returns the Comment field.
func (*CommitCommentEvent)GetInstallation¶
func (c *CommitCommentEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*CommitCommentEvent)GetRepo¶
func (c *CommitCommentEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (*CommitCommentEvent)GetSender¶
func (c *CommitCommentEvent) GetSender() *User
GetSender returns the Sender field.
typeCommitFile¶
type CommitFile struct {SHA *string `json:"sha,omitempty"`Filename *string `json:"filename,omitempty"`Additions *int `json:"additions,omitempty"`Deletions *int `json:"deletions,omitempty"`Changes *int `json:"changes,omitempty"`Status *string `json:"status,omitempty"`Patch *string `json:"patch,omitempty"`BlobURL *string `json:"blob_url,omitempty"`RawURL *string `json:"raw_url,omitempty"`ContentsURL *string `json:"contents_url,omitempty"`PreviousFilename *string `json:"previous_filename,omitempty"`}
CommitFile represents a file modified in a commit.
func (*CommitFile)GetAdditions¶
func (c *CommitFile) GetAdditions()int
GetAdditions returns the Additions field if it's non-nil, zero value otherwise.
func (*CommitFile)GetBlobURL¶
func (c *CommitFile) GetBlobURL()string
GetBlobURL returns the BlobURL field if it's non-nil, zero value otherwise.
func (*CommitFile)GetChanges¶
func (c *CommitFile) GetChanges()int
GetChanges returns the Changes field if it's non-nil, zero value otherwise.
func (*CommitFile)GetContentsURL¶
func (c *CommitFile) GetContentsURL()string
GetContentsURL returns the ContentsURL field if it's non-nil, zero value otherwise.
func (*CommitFile)GetDeletions¶
func (c *CommitFile) GetDeletions()int
GetDeletions returns the Deletions field if it's non-nil, zero value otherwise.
func (*CommitFile)GetFilename¶
func (c *CommitFile) GetFilename()string
GetFilename returns the Filename field if it's non-nil, zero value otherwise.
func (*CommitFile)GetPatch¶
func (c *CommitFile) GetPatch()string
GetPatch returns the Patch field if it's non-nil, zero value otherwise.
func (*CommitFile)GetPreviousFilename¶
func (c *CommitFile) GetPreviousFilename()string
GetPreviousFilename returns the PreviousFilename field if it's non-nil, zero value otherwise.
func (*CommitFile)GetRawURL¶
func (c *CommitFile) GetRawURL()string
GetRawURL returns the RawURL field if it's non-nil, zero value otherwise.
func (*CommitFile)GetSHA¶
func (c *CommitFile) GetSHA()string
GetSHA returns the SHA field if it's non-nil, zero value otherwise.
func (*CommitFile)GetStatus¶
func (c *CommitFile) GetStatus()string
GetStatus returns the Status field if it's non-nil, zero value otherwise.
func (CommitFile)String¶
func (cCommitFile) String()string
typeCommitResult¶
type CommitResult struct {SHA *string `json:"sha,omitempty"`Commit *Commit `json:"commit,omitempty"`Author *User `json:"author,omitempty"`Committer *User `json:"committer,omitempty"`Parents []*Commit `json:"parents,omitempty"`HTMLURL *string `json:"html_url,omitempty"`URL *string `json:"url,omitempty"`CommentsURL *string `json:"comments_url,omitempty"`Repository *Repository `json:"repository,omitempty"`Score *float64 `json:"score,omitempty"`}
CommitResult represents a commit object as returned in commit search endpoint response.
func (*CommitResult)GetAuthor¶
func (c *CommitResult) GetAuthor() *User
GetAuthor returns the Author field.
func (*CommitResult)GetCommentsURL¶
func (c *CommitResult) GetCommentsURL()string
GetCommentsURL returns the CommentsURL field if it's non-nil, zero value otherwise.
func (*CommitResult)GetCommit¶
func (c *CommitResult) GetCommit() *Commit
GetCommit returns the Commit field.
func (*CommitResult)GetCommitter¶
func (c *CommitResult) GetCommitter() *User
GetCommitter returns the Committer field.
func (*CommitResult)GetHTMLURL¶
func (c *CommitResult) GetHTMLURL()string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*CommitResult)GetRepository¶
func (c *CommitResult) GetRepository() *Repository
GetRepository returns the Repository field.
func (*CommitResult)GetSHA¶
func (c *CommitResult) GetSHA()string
GetSHA returns the SHA field if it's non-nil, zero value otherwise.
func (*CommitResult)GetScore¶
func (c *CommitResult) GetScore() *float64
GetScore returns the Score field.
func (*CommitResult)GetURL¶
func (c *CommitResult) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
typeCommitStats¶
type CommitStats struct {Additions *int `json:"additions,omitempty"`Deletions *int `json:"deletions,omitempty"`Total *int `json:"total,omitempty"`}
CommitStats represents the number of additions / deletions from a file in a given RepositoryCommit or GistCommit.
func (*CommitStats)GetAdditions¶
func (c *CommitStats) GetAdditions()int
GetAdditions returns the Additions field if it's non-nil, zero value otherwise.
func (*CommitStats)GetDeletions¶
func (c *CommitStats) GetDeletions()int
GetDeletions returns the Deletions field if it's non-nil, zero value otherwise.
func (*CommitStats)GetTotal¶
func (c *CommitStats) GetTotal()int
GetTotal returns the Total field if it's non-nil, zero value otherwise.
func (CommitStats)String¶
func (cCommitStats) String()string
typeCommitsComparison¶
type CommitsComparison struct {BaseCommit *RepositoryCommit `json:"base_commit,omitempty"`MergeBaseCommit *RepositoryCommit `json:"merge_base_commit,omitempty"`// Head can be 'behind' or 'ahead'Status *string `json:"status,omitempty"`AheadBy *int `json:"ahead_by,omitempty"`BehindBy *int `json:"behind_by,omitempty"`TotalCommits *int `json:"total_commits,omitempty"`Commits []*RepositoryCommit `json:"commits,omitempty"`Files []*CommitFile `json:"files,omitempty"`HTMLURL *string `json:"html_url,omitempty"`PermalinkURL *string `json:"permalink_url,omitempty"`DiffURL *string `json:"diff_url,omitempty"`PatchURL *string `json:"patch_url,omitempty"`URL *string `json:"url,omitempty"`// API URL.}
CommitsComparison is the result of comparing two commits.See CompareCommits() for details.
func (*CommitsComparison)GetAheadBy¶
func (c *CommitsComparison) GetAheadBy()int
GetAheadBy returns the AheadBy field if it's non-nil, zero value otherwise.
func (*CommitsComparison)GetBaseCommit¶
func (c *CommitsComparison) GetBaseCommit() *RepositoryCommit
GetBaseCommit returns the BaseCommit field.
func (*CommitsComparison)GetBehindBy¶
func (c *CommitsComparison) GetBehindBy()int
GetBehindBy returns the BehindBy field if it's non-nil, zero value otherwise.
func (*CommitsComparison)GetDiffURL¶
func (c *CommitsComparison) GetDiffURL()string
GetDiffURL returns the DiffURL field if it's non-nil, zero value otherwise.
func (*CommitsComparison)GetHTMLURL¶
func (c *CommitsComparison) GetHTMLURL()string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*CommitsComparison)GetMergeBaseCommit¶
func (c *CommitsComparison) GetMergeBaseCommit() *RepositoryCommit
GetMergeBaseCommit returns the MergeBaseCommit field.
func (*CommitsComparison)GetPatchURL¶
func (c *CommitsComparison) GetPatchURL()string
GetPatchURL returns the PatchURL field if it's non-nil, zero value otherwise.
func (*CommitsComparison)GetPermalinkURL¶
func (c *CommitsComparison) GetPermalinkURL()string
GetPermalinkURL returns the PermalinkURL field if it's non-nil, zero value otherwise.
func (*CommitsComparison)GetStatus¶
func (c *CommitsComparison) GetStatus()string
GetStatus returns the Status field if it's non-nil, zero value otherwise.
func (*CommitsComparison)GetTotalCommits¶
func (c *CommitsComparison) GetTotalCommits()int
GetTotalCommits returns the TotalCommits field if it's non-nil, zero value otherwise.
func (*CommitsComparison)GetURL¶
func (c *CommitsComparison) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (CommitsComparison)String¶
func (cCommitsComparison) String()string
typeCommitsListOptions¶
type CommitsListOptions struct {// SHA or branch to start listing Commits from.SHAstring `url:"sha,omitempty"`// Path that should be touched by the returned Commits.Pathstring `url:"path,omitempty"`// Author of by which to filter Commits.Authorstring `url:"author,omitempty"`// Since when should Commits be included in the response.Sincetime.Time `url:"since,omitempty"`// Until when should Commits be included in the response.Untiltime.Time `url:"until,omitempty"`ListOptions}
CommitsListOptions specifies the optional parameters to theRepositoriesService.ListCommits method.
typeCommitsSearchResult¶
type CommitsSearchResult struct {Total *int `json:"total_count,omitempty"`IncompleteResults *bool `json:"incomplete_results,omitempty"`Commits []*CommitResult `json:"items,omitempty"`}
CommitsSearchResult represents the result of a commits search.
func (*CommitsSearchResult)GetIncompleteResults¶
func (c *CommitsSearchResult) GetIncompleteResults()bool
GetIncompleteResults returns the IncompleteResults field if it's non-nil, zero value otherwise.
func (*CommitsSearchResult)GetTotal¶
func (c *CommitsSearchResult) GetTotal()int
GetTotal returns the Total field if it's non-nil, zero value otherwise.
typeCommunityHealthFiles¶
type CommunityHealthFiles struct {CodeOfConduct *Metric `json:"code_of_conduct"`CodeOfConductFile *Metric `json:"code_of_conduct_file"`Contributing *Metric `json:"contributing"`IssueTemplate *Metric `json:"issue_template"`PullRequestTemplate *Metric `json:"pull_request_template"`License *Metric `json:"license"`Readme *Metric `json:"readme"`}
CommunityHealthFiles represents the different files in the community health metrics response.
func (*CommunityHealthFiles)GetCodeOfConduct¶
func (c *CommunityHealthFiles) GetCodeOfConduct() *Metric
GetCodeOfConduct returns the CodeOfConduct field.
func (*CommunityHealthFiles)GetCodeOfConductFile¶
func (c *CommunityHealthFiles) GetCodeOfConductFile() *Metric
GetCodeOfConductFile returns the CodeOfConductFile field.
func (*CommunityHealthFiles)GetContributing¶
func (c *CommunityHealthFiles) GetContributing() *Metric
GetContributing returns the Contributing field.
func (*CommunityHealthFiles)GetIssueTemplate¶
func (c *CommunityHealthFiles) GetIssueTemplate() *Metric
GetIssueTemplate returns the IssueTemplate field.
func (*CommunityHealthFiles)GetLicense¶
func (c *CommunityHealthFiles) GetLicense() *Metric
GetLicense returns the License field.
func (*CommunityHealthFiles)GetPullRequestTemplate¶
func (c *CommunityHealthFiles) GetPullRequestTemplate() *Metric
GetPullRequestTemplate returns the PullRequestTemplate field.
func (*CommunityHealthFiles)GetReadme¶
func (c *CommunityHealthFiles) GetReadme() *Metric
GetReadme returns the Readme field.
typeCommunityHealthMetrics¶
type CommunityHealthMetrics struct {HealthPercentage *int `json:"health_percentage"`Description *string `json:"description"`Documentation *string `json:"documentation"`Files *CommunityHealthFiles `json:"files"`UpdatedAt *time.Time `json:"updated_at"`ContentReportsEnabled *bool `json:"content_reports_enabled"`}
CommunityHealthMetrics represents a response containing the community metrics of a repository.
func (*CommunityHealthMetrics)GetContentReportsEnabled¶
func (c *CommunityHealthMetrics) GetContentReportsEnabled()bool
GetContentReportsEnabled returns the ContentReportsEnabled field if it's non-nil, zero value otherwise.
func (*CommunityHealthMetrics)GetDescription¶
func (c *CommunityHealthMetrics) GetDescription()string
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (*CommunityHealthMetrics)GetDocumentation¶
func (c *CommunityHealthMetrics) GetDocumentation()string
GetDocumentation returns the Documentation field if it's non-nil, zero value otherwise.
func (*CommunityHealthMetrics)GetFiles¶
func (c *CommunityHealthMetrics) GetFiles() *CommunityHealthFiles
GetFiles returns the Files field.
func (*CommunityHealthMetrics)GetHealthPercentage¶
func (c *CommunityHealthMetrics) GetHealthPercentage()int
GetHealthPercentage returns the HealthPercentage field if it's non-nil, zero value otherwise.
func (*CommunityHealthMetrics)GetUpdatedAt¶
func (c *CommunityHealthMetrics) GetUpdatedAt()time.Time
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
typeContentReference¶
type ContentReference struct {ID *int64 `json:"id,omitempty"`NodeID *string `json:"node_id,omitempty"`Reference *string `json:"reference,omitempty"`}
ContentReference represents a reference to a URL in an issue or pull request.
func (*ContentReference)GetID¶
func (c *ContentReference) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*ContentReference)GetNodeID¶
func (c *ContentReference) GetNodeID()string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (*ContentReference)GetReference¶
func (c *ContentReference) GetReference()string
GetReference returns the Reference field if it's non-nil, zero value otherwise.
typeContentReferenceEvent¶
type ContentReferenceEvent struct {Action *string `json:"action,omitempty"`ContentReference *ContentReference `json:"content_reference,omitempty"`Repo *Repository `json:"repository,omitempty"`Sender *User `json:"sender,omitempty"`Installation *Installation `json:"installation,omitempty"`}
ContentReferenceEvent is triggered when the body or comment of an issue orpull request includes a URL that matches a configured content referencedomain.The Webhook event name is "content_reference".
GitHub API docs:https://developer.github.com/webhooks/event-payloads/#content_reference
func (*ContentReferenceEvent)GetAction¶
func (c *ContentReferenceEvent) GetAction()string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*ContentReferenceEvent)GetContentReference¶
func (c *ContentReferenceEvent) GetContentReference() *ContentReference
GetContentReference returns the ContentReference field.
func (*ContentReferenceEvent)GetInstallation¶
func (c *ContentReferenceEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*ContentReferenceEvent)GetRepo¶
func (c *ContentReferenceEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (*ContentReferenceEvent)GetSender¶
func (c *ContentReferenceEvent) GetSender() *User
GetSender returns the Sender field.
typeContributor¶
type Contributor struct {Login *string `json:"login,omitempty"`ID *int64 `json:"id,omitempty"`NodeID *string `json:"node_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"`Name *string `json:"name,omitempty"`Email *string `json:"email,omitempty"`}
Contributor represents a repository contributor
func (*Contributor)GetAvatarURL¶
func (c *Contributor) GetAvatarURL()string
GetAvatarURL returns the AvatarURL field if it's non-nil, zero value otherwise.
func (*Contributor)GetContributions¶
func (c *Contributor) GetContributions()int
GetContributions returns the Contributions field if it's non-nil, zero value otherwise.
func (*Contributor)GetEmail¶
func (c *Contributor) GetEmail()string
GetEmail returns the Email field if it's non-nil, zero value otherwise.
func (*Contributor)GetEventsURL¶
func (c *Contributor) GetEventsURL()string
GetEventsURL returns the EventsURL field if it's non-nil, zero value otherwise.
func (*Contributor)GetFollowersURL¶
func (c *Contributor) GetFollowersURL()string
GetFollowersURL returns the FollowersURL field if it's non-nil, zero value otherwise.
func (*Contributor)GetFollowingURL¶
func (c *Contributor) GetFollowingURL()string
GetFollowingURL returns the FollowingURL field if it's non-nil, zero value otherwise.
func (*Contributor)GetGistsURL¶
func (c *Contributor) GetGistsURL()string
GetGistsURL returns the GistsURL field if it's non-nil, zero value otherwise.
func (*Contributor)GetGravatarID¶
func (c *Contributor) GetGravatarID()string
GetGravatarID returns the GravatarID field if it's non-nil, zero value otherwise.
func (*Contributor)GetHTMLURL¶
func (c *Contributor) GetHTMLURL()string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*Contributor)GetID¶
func (c *Contributor) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*Contributor)GetLogin¶
func (c *Contributor) GetLogin()string
GetLogin returns the Login field if it's non-nil, zero value otherwise.
func (*Contributor)GetName¶
func (c *Contributor) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*Contributor)GetNodeID¶
func (c *Contributor) GetNodeID()string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (*Contributor)GetOrganizationsURL¶
func (c *Contributor) GetOrganizationsURL()string
GetOrganizationsURL returns the OrganizationsURL field if it's non-nil, zero value otherwise.
func (*Contributor)GetReceivedEventsURL¶
func (c *Contributor) GetReceivedEventsURL()string
GetReceivedEventsURL returns the ReceivedEventsURL field if it's non-nil, zero value otherwise.
func (*Contributor)GetReposURL¶
func (c *Contributor) GetReposURL()string
GetReposURL returns the ReposURL field if it's non-nil, zero value otherwise.
func (*Contributor)GetSiteAdmin¶
func (c *Contributor) GetSiteAdmin()bool
GetSiteAdmin returns the SiteAdmin field if it's non-nil, zero value otherwise.
func (*Contributor)GetStarredURL¶
func (c *Contributor) GetStarredURL()string
GetStarredURL returns the StarredURL field if it's non-nil, zero value otherwise.
func (*Contributor)GetSubscriptionsURL¶
func (c *Contributor) GetSubscriptionsURL()string
GetSubscriptionsURL returns the SubscriptionsURL field if it's non-nil, zero value otherwise.
func (*Contributor)GetType¶
func (c *Contributor) GetType()string
GetType returns the Type field if it's non-nil, zero value otherwise.
func (*Contributor)GetURL¶
func (c *Contributor) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
typeContributorStats¶
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 theirweekly contributions to a given repo.
func (*ContributorStats)GetAuthor¶
func (c *ContributorStats) GetAuthor() *Contributor
GetAuthor returns the Author field.
func (*ContributorStats)GetTotal¶
func (c *ContributorStats) GetTotal()int
GetTotal returns the Total field if it's non-nil, zero value otherwise.
func (ContributorStats)String¶
func (cContributorStats) String()string
typeCreateCheckRunOptions¶
type CreateCheckRunOptions struct {Namestring `json:"name"`// The name of the check (e.g., "code-coverage"). (Required.)HeadSHAstring `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", "skipped", "timed_out", or "action_required". (Optional. Required if you provide a status of "completed".)StartedAt *Timestamp `json:"started_at,omitempty"`// The time that the check run began. (Optional.)CompletedAt *Timestamp `json:"completed_at,omitempty"`// The time the check completed. (Optional. Required if you provide conclusion.)Output *CheckRunOutput `json:"output,omitempty"`// Provide descriptive details about the run. (Optional)Actions []*CheckRunAction `json:"actions,omitempty"`// Possible further actions the integrator can perform, which a user may trigger. (Optional.)}
CreateCheckRunOptions sets up parameters needed to create a CheckRun.
func (*CreateCheckRunOptions)GetCompletedAt¶
func (c *CreateCheckRunOptions) GetCompletedAt()Timestamp
GetCompletedAt returns the CompletedAt field if it's non-nil, zero value otherwise.
func (*CreateCheckRunOptions)GetConclusion¶
func (c *CreateCheckRunOptions) GetConclusion()string
GetConclusion returns the Conclusion field if it's non-nil, zero value otherwise.
func (*CreateCheckRunOptions)GetDetailsURL¶
func (c *CreateCheckRunOptions) GetDetailsURL()string
GetDetailsURL returns the DetailsURL field if it's non-nil, zero value otherwise.
func (*CreateCheckRunOptions)GetExternalID¶
func (c *CreateCheckRunOptions) GetExternalID()string
GetExternalID returns the ExternalID field if it's non-nil, zero value otherwise.
func (*CreateCheckRunOptions)GetOutput¶
func (c *CreateCheckRunOptions) GetOutput() *CheckRunOutput
GetOutput returns the Output field.
func (*CreateCheckRunOptions)GetStartedAt¶
func (c *CreateCheckRunOptions) GetStartedAt()Timestamp
GetStartedAt returns the StartedAt field if it's non-nil, zero value otherwise.
func (*CreateCheckRunOptions)GetStatus¶
func (c *CreateCheckRunOptions) GetStatus()string
GetStatus returns the Status field if it's non-nil, zero value otherwise.
typeCreateCheckSuiteOptions¶
type CreateCheckSuiteOptions struct {HeadSHAstring `json:"head_sha"`// The sha of the head commit. (Required.)HeadBranch *string `json:"head_branch,omitempty"`// The name of the head branch where the code changes are implemented.}
CreateCheckSuiteOptions sets up parameters to manually create a check suites
func (*CreateCheckSuiteOptions)GetHeadBranch¶
func (c *CreateCheckSuiteOptions) GetHeadBranch()string
GetHeadBranch returns the HeadBranch field if it's non-nil, zero value otherwise.
typeCreateEvent¶
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 morethan three tags are pushed at once.
GitHub API docs:https://docs.github.com/en/developers/webhooks-and-events/github-event-types#createevent
func (*CreateEvent)GetDescription¶
func (c *CreateEvent) GetDescription()string
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (*CreateEvent)GetInstallation¶
func (c *CreateEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*CreateEvent)GetMasterBranch¶
func (c *CreateEvent) GetMasterBranch()string
GetMasterBranch returns the MasterBranch field if it's non-nil, zero value otherwise.
func (*CreateEvent)GetPusherType¶
func (c *CreateEvent) GetPusherType()string
GetPusherType returns the PusherType field if it's non-nil, zero value otherwise.
func (*CreateEvent)GetRef¶
func (c *CreateEvent) GetRef()string
GetRef returns the Ref field if it's non-nil, zero value otherwise.
func (*CreateEvent)GetRefType¶
func (c *CreateEvent) GetRefType()string
GetRefType returns the RefType field if it's non-nil, zero value otherwise.
func (*CreateEvent)GetRepo¶
func (c *CreateEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (*CreateEvent)GetSender¶
func (c *CreateEvent) GetSender() *User
GetSender returns the Sender field.
typeCreateOrgInvitationOptions¶
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 InviteeIDEmail *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.Invitemethod.
func (*CreateOrgInvitationOptions)GetEmail¶
func (c *CreateOrgInvitationOptions) GetEmail()string
GetEmail returns the Email field if it's non-nil, zero value otherwise.
func (*CreateOrgInvitationOptions)GetInviteeID¶
func (c *CreateOrgInvitationOptions) GetInviteeID()int64
GetInviteeID returns the InviteeID field if it's non-nil, zero value otherwise.
func (*CreateOrgInvitationOptions)GetRole¶
func (c *CreateOrgInvitationOptions) GetRole()string
GetRole returns the Role field if it's non-nil, zero value otherwise.
typeCreateRunnerGroupRequest¶
type CreateRunnerGroupRequest struct {Name *string `json:"name,omitempty"`Visibility *string `json:"visibility,omitempty"`// List of repository IDs that can access the runner group.SelectedRepositoryIDs []int64 `json:"selected_repository_ids,omitempty"`// Runners represent a list of runner IDs to add to the runner group.Runners []int64 `json:"runners,omitempty"`// If set to True, public repos can use this runner groupAllowsPublicRepositories *bool `json:"allows_public_repositories,omitempty"`}
CreateRunnerGroupRequest represents a request to create a Runner group for an organization.
func (*CreateRunnerGroupRequest)GetAllowsPublicRepositories¶
func (c *CreateRunnerGroupRequest) GetAllowsPublicRepositories()bool
GetAllowsPublicRepositories returns the AllowsPublicRepositories field if it's non-nil, zero value otherwise.
func (*CreateRunnerGroupRequest)GetName¶
func (c *CreateRunnerGroupRequest) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*CreateRunnerGroupRequest)GetVisibility¶
func (c *CreateRunnerGroupRequest) GetVisibility()string
GetVisibility returns the Visibility field if it's non-nil, zero value otherwise.
typeCreateUpdateEnvironment¶
type CreateUpdateEnvironment struct {WaitTimer *int `json:"wait_timer"`Reviewers []*EnvReviewers `json:"reviewers"`DeploymentBranchPolicy *BranchPolicy `json:"deployment_branch_policy"`}
CreateUpdateEnvironment represents the fields required for the create/update operationfollowing the Create/Update release example.Seehttps://github.com/google/go-github/issues/992 for more information.Removed omitempty here as the API expects null values for reviewers and deployment_branch_policy to clear them.
func (*CreateUpdateEnvironment)GetDeploymentBranchPolicy¶
func (c *CreateUpdateEnvironment) GetDeploymentBranchPolicy() *BranchPolicy
GetDeploymentBranchPolicy returns the DeploymentBranchPolicy field.
func (*CreateUpdateEnvironment)GetWaitTimer¶
func (c *CreateUpdateEnvironment) GetWaitTimer()int
GetWaitTimer returns the WaitTimer field if it's non-nil, zero value otherwise.
func (*CreateUpdateEnvironment)MarshalJSON¶
func (c *CreateUpdateEnvironment) MarshalJSON() ([]byte,error)
MarshalJSON implements the json.Marshaler interface.As the only way to clear a WaitTimer is to set it to 0, a missing WaitTimer object should default to 0, not null.
typeCreateUserProjectOptions¶
type CreateUserProjectOptions struct {// The name of the project. (Required.)Namestring `json:"name"`// The description of the project. (Optional.)Body *string `json:"body,omitempty"`}
CreateUserProjectOptions specifies the parameters to the UsersService.CreateProject method.
func (*CreateUserProjectOptions)GetBody¶
func (c *CreateUserProjectOptions) GetBody()string
GetBody returns the Body field if it's non-nil, zero value otherwise.
typeCreateWorkflowDispatchEventRequest¶
type CreateWorkflowDispatchEventRequest struct {// Ref represents the reference of the workflow run.// The reference can be a branch or a tag.// Ref is required when creating a workflow dispatch event.Refstring `json:"ref"`// Inputs represents input keys and values configured in the workflow file.// The maximum number of properties is 10.// Default: Any default properties configured in the workflow file will be used when `inputs` are omitted.Inputs map[string]interface{} `json:"inputs,omitempty"`}
CreateWorkflowDispatchEventRequest represents a request to create a workflow dispatch event.
typeDeleteEvent¶
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 tagsare deleted at once.
GitHub API docs:https://docs.github.com/en/developers/webhooks-and-events/github-event-types#deleteevent
func (*DeleteEvent)GetInstallation¶
func (d *DeleteEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*DeleteEvent)GetPusherType¶
func (d *DeleteEvent) GetPusherType()string
GetPusherType returns the PusherType field if it's non-nil, zero value otherwise.
func (*DeleteEvent)GetRef¶
func (d *DeleteEvent) GetRef()string
GetRef returns the Ref field if it's non-nil, zero value otherwise.
func (*DeleteEvent)GetRefType¶
func (d *DeleteEvent) GetRefType()string
GetRefType returns the RefType field if it's non-nil, zero value otherwise.
func (*DeleteEvent)GetRepo¶
func (d *DeleteEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (*DeleteEvent)GetSender¶
func (d *DeleteEvent) GetSender() *User
GetSender returns the Sender field.
typeDependabotService¶
type DependabotService service
DependabotService handles communication with the Dependabot relatedmethods of the GitHub API.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/dependabot/
func (*DependabotService)AddSelectedRepoToOrgSecret¶
func (s *DependabotService) AddSelectedRepoToOrgSecret(ctxcontext.Context, org, namestring, repo *Repository) (*Response,error)
AddSelectedRepoToOrgSecret adds a repository to an organization Dependabot secret.
GitHub API docs:https://docs.github.com/en/rest/reference/dependabot#add-selected-repository-to-an-organization-secret
func (*DependabotService)CreateOrUpdateOrgSecret¶
func (s *DependabotService) CreateOrUpdateOrgSecret(ctxcontext.Context, orgstring, eSecret *EncryptedSecret) (*Response,error)
CreateOrUpdateOrgSecret creates or updates an organization Dependabot secret with an encrypted value.
GitHub API docs:https://docs.github.com/en/rest/reference/dependabot#create-or-update-an-organization-secret
func (*DependabotService)CreateOrUpdateRepoSecret¶
func (s *DependabotService) CreateOrUpdateRepoSecret(ctxcontext.Context, owner, repostring, eSecret *EncryptedSecret) (*Response,error)
CreateOrUpdateRepoSecret creates or updates a repository Dependabot secret with an encrypted value.
GitHub API docs:https://docs.github.com/en/rest/reference/dependabot#create-or-update-a-repository-secret
func (*DependabotService)DeleteOrgSecret¶
DeleteOrgSecret deletes a Dependabot secret in an organization using the secret name.
GitHub API docs:https://docs.github.com/en/rest/reference/dependabot#delete-an-organization-secret
func (*DependabotService)DeleteRepoSecret¶
func (s *DependabotService) DeleteRepoSecret(ctxcontext.Context, owner, repo, namestring) (*Response,error)
DeleteRepoSecret deletes a Dependabot secret in a repository using the secret name.
GitHub API docs:https://docs.github.com/en/rest/reference/dependabot#delete-a-repository-secret
func (*DependabotService)GetOrgPublicKey¶
func (s *DependabotService) GetOrgPublicKey(ctxcontext.Context, orgstring) (*PublicKey, *Response,error)
GetOrgPublicKey gets a public key that should be used for Dependabot secret encryption.
GitHub API docs:https://docs.github.com/en/rest/reference/dependabot#get-an-organization-public-key
func (*DependabotService)GetOrgSecret¶
func (s *DependabotService) GetOrgSecret(ctxcontext.Context, org, namestring) (*Secret, *Response,error)
GetOrgSecret gets a single organization Dependabot secret without revealing its encrypted value.
GitHub API docs:https://docs.github.com/en/rest/reference/dependabot#get-an-organization-secret
func (*DependabotService)GetRepoPublicKey¶
func (s *DependabotService) GetRepoPublicKey(ctxcontext.Context, owner, repostring) (*PublicKey, *Response,error)
GetRepoPublicKey gets a public key that should be used for Dependabot secret encryption.
GitHub API docs:https://docs.github.com/en/rest/reference/dependabot#get-a-repository-public-key
func (*DependabotService)GetRepoSecret¶
func (s *DependabotService) GetRepoSecret(ctxcontext.Context, owner, repo, namestring) (*Secret, *Response,error)
GetRepoSecret gets a single repository Dependabot secret without revealing its encrypted value.
GitHub API docs:https://docs.github.com/en/rest/reference/dependabot#get-a-repository-secret
func (*DependabotService)ListOrgSecrets¶
func (s *DependabotService) ListOrgSecrets(ctxcontext.Context, orgstring, opts *ListOptions) (*Secrets, *Response,error)
ListOrgSecrets lists all Dependabot secrets available in an organizationwithout revealing their encrypted values.
GitHub API docs:https://docs.github.com/en/rest/reference/dependabot#list-organization-secrets
func (*DependabotService)ListRepoSecrets¶
func (s *DependabotService) ListRepoSecrets(ctxcontext.Context, owner, repostring, opts *ListOptions) (*Secrets, *Response,error)
ListRepoSecrets lists all Dependabot secrets available in a repositorywithout revealing their encrypted values.
GitHub API docs:https://docs.github.com/en/rest/reference/dependabot#list-repository-secrets
func (*DependabotService)ListSelectedReposForOrgSecret¶
func (s *DependabotService) ListSelectedReposForOrgSecret(ctxcontext.Context, org, namestring, opts *ListOptions) (*SelectedReposList, *Response,error)
ListSelectedReposForOrgSecret lists all repositories that have access to a Dependabot secret.
GitHub API docs:https://docs.github.com/en/rest/reference/dependabot#list-selected-repositories-for-an-organization-secret
func (*DependabotService)RemoveSelectedRepoFromOrgSecret¶
func (s *DependabotService) RemoveSelectedRepoFromOrgSecret(ctxcontext.Context, org, namestring, repo *Repository) (*Response,error)
RemoveSelectedRepoFromOrgSecret removes a repository from an organization Dependabot secret.
GitHub API docs:https://docs.github.com/en/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret
func (*DependabotService)SetSelectedReposForOrgSecret¶
func (s *DependabotService) SetSelectedReposForOrgSecret(ctxcontext.Context, org, namestring, idsSelectedRepoIDs) (*Response,error)
SetSelectedReposForOrgSecret sets the repositories that have access to a Dependabot secret.
GitHub API docs:https://docs.github.com/en/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret
typeDeployKeyEvent¶
type DeployKeyEvent struct {// Action is the action that was performed. Possible values are:// "created" or "deleted".Action *string `json:"action,omitempty"`// The deploy key resource.Key *Key `json:"key,omitempty"`// The Repository where the event occurredRepo *Repository `json:"repository,omitempty"`// The following field is only present when the webhook is triggered on// a repository belonging to an organization.Organization *Organization `json:"organization,omitempty"`// The following fields are only populated by Webhook events.Sender *User `json:"sender,omitempty"`Installation *Installation `json:"installation,omitempty"`}
DeployKeyEvent is triggered when a deploy key is added or removed from a repository.The Webhook event name is "deploy_key".
GitHub API docs:https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#deploy_key
func (*DeployKeyEvent)GetAction¶
func (d *DeployKeyEvent) GetAction()string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*DeployKeyEvent)GetInstallation¶
func (d *DeployKeyEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*DeployKeyEvent)GetOrganization¶
func (d *DeployKeyEvent) GetOrganization() *Organization
GetOrganization returns the Organization field.
func (*DeployKeyEvent)GetRepo¶
func (d *DeployKeyEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (*DeployKeyEvent)GetSender¶
func (d *DeployKeyEvent) GetSender() *User
GetSender returns the Sender field.
typeDeployment¶
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"`Payloadjson.RawMessage `json:"payload,omitempty"`Environment *string `json:"environment,omitempty"`Description *string `json:"description,omitempty"`Creator *User `json:"creator,omitempty"`CreatedAt *Timestamp `json:"created_at,omitempty"`UpdatedAt *Timestamp `json:"updated_at,omitempty"`StatusesURL *string `json:"statuses_url,omitempty"`RepositoryURL *string `json:"repository_url,omitempty"`NodeID *string `json:"node_id,omitempty"`}
Deployment represents a deployment in a repo
func (*Deployment)GetCreatedAt¶
func (d *Deployment) GetCreatedAt()Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*Deployment)GetCreator¶
func (d *Deployment) GetCreator() *User
GetCreator returns the Creator field.
func (*Deployment)GetDescription¶
func (d *Deployment) GetDescription()string
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (*Deployment)GetEnvironment¶
func (d *Deployment) GetEnvironment()string
GetEnvironment returns the Environment field if it's non-nil, zero value otherwise.
func (*Deployment)GetID¶
func (d *Deployment) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*Deployment)GetNodeID¶
func (d *Deployment) GetNodeID()string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (*Deployment)GetRef¶
func (d *Deployment) GetRef()string
GetRef returns the Ref field if it's non-nil, zero value otherwise.
func (*Deployment)GetRepositoryURL¶
func (d *Deployment) GetRepositoryURL()string
GetRepositoryURL returns the RepositoryURL field if it's non-nil, zero value otherwise.
func (*Deployment)GetSHA¶
func (d *Deployment) GetSHA()string
GetSHA returns the SHA field if it's non-nil, zero value otherwise.
func (*Deployment)GetStatusesURL¶
func (d *Deployment) GetStatusesURL()string
GetStatusesURL returns the StatusesURL field if it's non-nil, zero value otherwise.
func (*Deployment)GetTask¶
func (d *Deployment) GetTask()string
GetTask returns the Task field if it's non-nil, zero value otherwise.
func (*Deployment)GetURL¶
func (d *Deployment) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (*Deployment)GetUpdatedAt¶
func (d *Deployment) GetUpdatedAt()Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
typeDeploymentEvent¶
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://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#deployment
func (*DeploymentEvent)GetDeployment¶
func (d *DeploymentEvent) GetDeployment() *Deployment
GetDeployment returns the Deployment field.
func (*DeploymentEvent)GetInstallation¶
func (d *DeploymentEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*DeploymentEvent)GetRepo¶
func (d *DeploymentEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (*DeploymentEvent)GetSender¶
func (d *DeploymentEvent) GetSender() *User
GetSender returns the Sender field.
typeDeploymentRequest¶
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 interface{} `json:"payload,omitempty"`Environment *string `json:"environment,omitempty"`Description *string `json:"description,omitempty"`TransientEnvironment *bool `json:"transient_environment,omitempty"`ProductionEnvironment *bool `json:"production_environment,omitempty"`}
DeploymentRequest represents a deployment request
func (*DeploymentRequest)GetAutoMerge¶
func (d *DeploymentRequest) GetAutoMerge()bool
GetAutoMerge returns the AutoMerge field if it's non-nil, zero value otherwise.
func (*DeploymentRequest)GetDescription¶
func (d *DeploymentRequest) GetDescription()string
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (*DeploymentRequest)GetEnvironment¶
func (d *DeploymentRequest) GetEnvironment()string
GetEnvironment returns the Environment field if it's non-nil, zero value otherwise.
func (*DeploymentRequest)GetProductionEnvironment¶
func (d *DeploymentRequest) GetProductionEnvironment()bool
GetProductionEnvironment returns the ProductionEnvironment field if it's non-nil, zero value otherwise.
func (*DeploymentRequest)GetRef¶
func (d *DeploymentRequest) GetRef()string
GetRef returns the Ref field if it's non-nil, zero value otherwise.
func (*DeploymentRequest)GetRequiredContexts¶
func (d *DeploymentRequest) GetRequiredContexts() []string
GetRequiredContexts returns the RequiredContexts field if it's non-nil, zero value otherwise.
func (*DeploymentRequest)GetTask¶
func (d *DeploymentRequest) GetTask()string
GetTask returns the Task field if it's non-nil, zero value otherwise.
func (*DeploymentRequest)GetTransientEnvironment¶
func (d *DeploymentRequest) GetTransientEnvironment()bool
GetTransientEnvironment returns the TransientEnvironment field if it's non-nil, zero value otherwise.
typeDeploymentStatus¶
type DeploymentStatus struct {ID *int64 `json:"id,omitempty"`// State is the deployment state.// Possible values are: "pending", "success", "failure", "error",// "inactive", "in_progress", "queued".State *string `json:"state,omitempty"`Creator *User `json:"creator,omitempty"`Description *string `json:"description,omitempty"`Environment *string `json:"environment,omitempty"`NodeID *string `json:"node_id,omitempty"`CreatedAt *Timestamp `json:"created_at,omitempty"`UpdatedAt *Timestamp `json:"updated_at,omitempty"`TargetURL *string `json:"target_url,omitempty"`DeploymentURL *string `json:"deployment_url,omitempty"`RepositoryURL *string `json:"repository_url,omitempty"`EnvironmentURL *string `json:"environment_url,omitempty"`LogURL *string `json:"log_url,omitempty"`URL *string `json:"url,omitempty"`}
DeploymentStatus represents the status of aparticular deployment.
func (*DeploymentStatus)GetCreatedAt¶
func (d *DeploymentStatus) GetCreatedAt()Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*DeploymentStatus)GetCreator¶
func (d *DeploymentStatus) GetCreator() *User
GetCreator returns the Creator field.
func (*DeploymentStatus)GetDeploymentURL¶
func (d *DeploymentStatus) GetDeploymentURL()string
GetDeploymentURL returns the DeploymentURL field if it's non-nil, zero value otherwise.
func (*DeploymentStatus)GetDescription¶
func (d *DeploymentStatus) GetDescription()string
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (*DeploymentStatus)GetEnvironment¶
func (d *DeploymentStatus) GetEnvironment()string
GetEnvironment returns the Environment field if it's non-nil, zero value otherwise.
func (*DeploymentStatus)GetEnvironmentURL¶
func (d *DeploymentStatus) GetEnvironmentURL()string
GetEnvironmentURL returns the EnvironmentURL field if it's non-nil, zero value otherwise.
func (*DeploymentStatus)GetID¶
func (d *DeploymentStatus) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*DeploymentStatus)GetLogURL¶
func (d *DeploymentStatus) GetLogURL()string
GetLogURL returns the LogURL field if it's non-nil, zero value otherwise.
func (*DeploymentStatus)GetNodeID¶
func (d *DeploymentStatus) GetNodeID()string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (*DeploymentStatus)GetRepositoryURL¶
func (d *DeploymentStatus) GetRepositoryURL()string
GetRepositoryURL returns the RepositoryURL field if it's non-nil, zero value otherwise.
func (*DeploymentStatus)GetState¶
func (d *DeploymentStatus) GetState()string
GetState returns the State field if it's non-nil, zero value otherwise.
func (*DeploymentStatus)GetTargetURL¶
func (d *DeploymentStatus) GetTargetURL()string
GetTargetURL returns the TargetURL field if it's non-nil, zero value otherwise.
func (*DeploymentStatus)GetURL¶
func (d *DeploymentStatus) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (*DeploymentStatus)GetUpdatedAt¶
func (d *DeploymentStatus) GetUpdatedAt()Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
typeDeploymentStatusEvent¶
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://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#deployment_status
func (*DeploymentStatusEvent)GetDeployment¶
func (d *DeploymentStatusEvent) GetDeployment() *Deployment
GetDeployment returns the Deployment field.
func (*DeploymentStatusEvent)GetDeploymentStatus¶
func (d *DeploymentStatusEvent) GetDeploymentStatus() *DeploymentStatus
GetDeploymentStatus returns the DeploymentStatus field.
func (*DeploymentStatusEvent)GetInstallation¶
func (d *DeploymentStatusEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*DeploymentStatusEvent)GetRepo¶
func (d *DeploymentStatusEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (*DeploymentStatusEvent)GetSender¶
func (d *DeploymentStatusEvent) GetSender() *User
GetSender returns the Sender field.
typeDeploymentStatusRequest¶
type DeploymentStatusRequest struct {State *string `json:"state,omitempty"`LogURL *string `json:"log_url,omitempty"`Description *string `json:"description,omitempty"`Environment *string `json:"environment,omitempty"`EnvironmentURL *string `json:"environment_url,omitempty"`AutoInactive *bool `json:"auto_inactive,omitempty"`}
DeploymentStatusRequest represents a deployment request
func (*DeploymentStatusRequest)GetAutoInactive¶
func (d *DeploymentStatusRequest) GetAutoInactive()bool
GetAutoInactive returns the AutoInactive field if it's non-nil, zero value otherwise.
func (*DeploymentStatusRequest)GetDescription¶
func (d *DeploymentStatusRequest) GetDescription()string
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (*DeploymentStatusRequest)GetEnvironment¶
func (d *DeploymentStatusRequest) GetEnvironment()string
GetEnvironment returns the Environment field if it's non-nil, zero value otherwise.
func (*DeploymentStatusRequest)GetEnvironmentURL¶
func (d *DeploymentStatusRequest) GetEnvironmentURL()string
GetEnvironmentURL returns the EnvironmentURL field if it's non-nil, zero value otherwise.
func (*DeploymentStatusRequest)GetLogURL¶
func (d *DeploymentStatusRequest) GetLogURL()string
GetLogURL returns the LogURL field if it's non-nil, zero value otherwise.
func (*DeploymentStatusRequest)GetState¶
func (d *DeploymentStatusRequest) GetState()string
GetState returns the State field if it's non-nil, zero value otherwise.
typeDeploymentsListOptions¶
type DeploymentsListOptions struct {// SHA of the Deployment.SHAstring `url:"sha,omitempty"`// List deployments for a given ref.Refstring `url:"ref,omitempty"`// List deployments for a given task.Taskstring `url:"task,omitempty"`// List deployments for a given environment.Environmentstring `url:"environment,omitempty"`ListOptions}
DeploymentsListOptions specifies the optional parameters to theRepositoriesService.ListDeployments method.
typeDiscussion¶
type Discussion struct {RepositoryURL *string `json:"repository_url,omitempty"`DiscussionCategory *DiscussionCategory `json:"category,omitempty"`AnswerHTMLURL *string `json:"answer_html_url,omitempty"`AnswerChosenAt *Timestamp `json:"answer_chosen_at,omitempty"`AnswerChosenBy *string `json:"answer_chosen_by,omitempty"`HTMLURL *string `json:"html_url,omitempty"`ID *int64 `json:"id,omitempty"`NodeID *string `json:"node_id,omitempty"`Number *int `json:"number,omitempty"`Title *string `json:"title,omitempty"`User *User `json:"user,omitempty"`State *string `json:"state,omitempty"`Locked *bool `json:"locked,omitempty"`Comments *int `json:"comments,omitempty"`CreatedAt *Timestamp `json:"created_at,omitempty"`UpdatedAt *Timestamp `json:"updated_at,omitempty"`AuthorAssociation *string `json:"author_association,omitempty"`ActiveLockReason *string `json:"active_lock_reason,omitempty"`Body *string `json:"body,omitempty"`}
Discussion represents a discussion in a GitHub DiscussionEvent.
func (*Discussion)GetActiveLockReason¶
func (d *Discussion) GetActiveLockReason()string
GetActiveLockReason returns the ActiveLockReason field if it's non-nil, zero value otherwise.
func (*Discussion)GetAnswerChosenAt¶
func (d *Discussion) GetAnswerChosenAt()Timestamp
GetAnswerChosenAt returns the AnswerChosenAt field if it's non-nil, zero value otherwise.
func (*Discussion)GetAnswerChosenBy¶
func (d *Discussion) GetAnswerChosenBy()string
GetAnswerChosenBy returns the AnswerChosenBy field if it's non-nil, zero value otherwise.
func (*Discussion)GetAnswerHTMLURL¶
func (d *Discussion) GetAnswerHTMLURL()string
GetAnswerHTMLURL returns the AnswerHTMLURL field if it's non-nil, zero value otherwise.
func (*Discussion)GetAuthorAssociation¶
func (d *Discussion) GetAuthorAssociation()string
GetAuthorAssociation returns the AuthorAssociation field if it's non-nil, zero value otherwise.
func (*Discussion)GetBody¶
func (d *Discussion) GetBody()string
GetBody returns the Body field if it's non-nil, zero value otherwise.
func (*Discussion)GetComments¶
func (d *Discussion) GetComments()int
GetComments returns the Comments field if it's non-nil, zero value otherwise.
func (*Discussion)GetCreatedAt¶
func (d *Discussion) GetCreatedAt()Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*Discussion)GetDiscussionCategory¶
func (d *Discussion) GetDiscussionCategory() *DiscussionCategory
GetDiscussionCategory returns the DiscussionCategory field.
func (*Discussion)GetHTMLURL¶
func (d *Discussion) GetHTMLURL()string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*Discussion)GetID¶
func (d *Discussion) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*Discussion)GetLocked¶
func (d *Discussion) GetLocked()bool
GetLocked returns the Locked field if it's non-nil, zero value otherwise.
func (*Discussion)GetNodeID¶
func (d *Discussion) GetNodeID()string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (*Discussion)GetNumber¶
func (d *Discussion) GetNumber()int
GetNumber returns the Number field if it's non-nil, zero value otherwise.
func (*Discussion)GetRepositoryURL¶
func (d *Discussion) GetRepositoryURL()string
GetRepositoryURL returns the RepositoryURL field if it's non-nil, zero value otherwise.
func (*Discussion)GetState¶
func (d *Discussion) GetState()string
GetState returns the State field if it's non-nil, zero value otherwise.
func (*Discussion)GetTitle¶
func (d *Discussion) GetTitle()string
GetTitle returns the Title field if it's non-nil, zero value otherwise.
func (*Discussion)GetUpdatedAt¶
func (d *Discussion) GetUpdatedAt()Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
typeDiscussionCategory¶
type DiscussionCategory struct {ID *int64 `json:"id,omitempty"`NodeID *string `json:"node_id,omitempty"`RepositoryID *int64 `json:"repository_id,omitempty"`Emoji *string `json:"emoji,omitempty"`Name *string `json:"name,omitempty"`Description *string `json:"description,omitempty"`CreatedAt *Timestamp `json:"created_at,omitempty"`UpdatedAt *Timestamp `json:"updated_at,omitempty"`Slug *string `json:"slug,omitempty"`IsAnswerable *bool `json:"is_answerable,omitempty"`}
DiscussionCategory represents a discussion category in a GitHub DiscussionEvent.
func (*DiscussionCategory)GetCreatedAt¶
func (d *DiscussionCategory) GetCreatedAt()Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*DiscussionCategory)GetDescription¶
func (d *DiscussionCategory) GetDescription()string
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (*DiscussionCategory)GetEmoji¶
func (d *DiscussionCategory) GetEmoji()string
GetEmoji returns the Emoji field if it's non-nil, zero value otherwise.
func (*DiscussionCategory)GetID¶
func (d *DiscussionCategory) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*DiscussionCategory)GetIsAnswerable¶
func (d *DiscussionCategory) GetIsAnswerable()bool
GetIsAnswerable returns the IsAnswerable field if it's non-nil, zero value otherwise.
func (*DiscussionCategory)GetName¶
func (d *DiscussionCategory) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*DiscussionCategory)GetNodeID¶
func (d *DiscussionCategory) GetNodeID()string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (*DiscussionCategory)GetRepositoryID¶
func (d *DiscussionCategory) GetRepositoryID()int64
GetRepositoryID returns the RepositoryID field if it's non-nil, zero value otherwise.
func (*DiscussionCategory)GetSlug¶
func (d *DiscussionCategory) GetSlug()string
GetSlug returns the Slug field if it's non-nil, zero value otherwise.
func (*DiscussionCategory)GetUpdatedAt¶
func (d *DiscussionCategory) GetUpdatedAt()Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
typeDiscussionComment¶
type DiscussionComment struct {Author *User `json:"author,omitempty"`Body *string `json:"body,omitempty"`BodyHTML *string `json:"body_html,omitempty"`BodyVersion *string `json:"body_version,omitempty"`CreatedAt *Timestamp `json:"created_at,omitempty"`LastEditedAt *Timestamp `json:"last_edited_at,omitempty"`DiscussionURL *string `json:"discussion_url,omitempty"`HTMLURL *string `json:"html_url,omitempty"`NodeID *string `json:"node_id,omitempty"`Number *int `json:"number,omitempty"`UpdatedAt *Timestamp `json:"updated_at,omitempty"`URL *string `json:"url,omitempty"`Reactions *Reactions `json:"reactions,omitempty"`}
DiscussionComment represents a GitHub dicussion in a team.
func (*DiscussionComment)GetAuthor¶
func (d *DiscussionComment) GetAuthor() *User
GetAuthor returns the Author field.
func (*DiscussionComment)GetBody¶
func (d *DiscussionComment) GetBody()string
GetBody returns the Body field if it's non-nil, zero value otherwise.
func (*DiscussionComment)GetBodyHTML¶
func (d *DiscussionComment) GetBodyHTML()string
GetBodyHTML returns the BodyHTML field if it's non-nil, zero value otherwise.
func (*DiscussionComment)GetBodyVersion¶
func (d *DiscussionComment) GetBodyVersion()string
GetBodyVersion returns the BodyVersion field if it's non-nil, zero value otherwise.
func (*DiscussionComment)GetCreatedAt¶
func (d *DiscussionComment) GetCreatedAt()Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*DiscussionComment)GetDiscussionURL¶
func (d *DiscussionComment) GetDiscussionURL()string
GetDiscussionURL returns the DiscussionURL field if it's non-nil, zero value otherwise.
func (*DiscussionComment)GetHTMLURL¶
func (d *DiscussionComment) GetHTMLURL()string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*DiscussionComment)GetLastEditedAt¶
func (d *DiscussionComment) GetLastEditedAt()Timestamp
GetLastEditedAt returns the LastEditedAt field if it's non-nil, zero value otherwise.
func (*DiscussionComment)GetNodeID¶
func (d *DiscussionComment) GetNodeID()string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (*DiscussionComment)GetNumber¶
func (d *DiscussionComment) GetNumber()int
GetNumber returns the Number field if it's non-nil, zero value otherwise.
func (*DiscussionComment)GetReactions¶
func (d *DiscussionComment) GetReactions() *Reactions
GetReactions returns the Reactions field.
func (*DiscussionComment)GetURL¶
func (d *DiscussionComment) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (*DiscussionComment)GetUpdatedAt¶
func (d *DiscussionComment) GetUpdatedAt()Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (DiscussionComment)String¶
func (cDiscussionComment) String()string
typeDiscussionCommentListOptions¶
type DiscussionCommentListOptions struct {// Sorts the discussion comments by the date they were created.// Accepted values are asc and desc. Default is desc.Directionstring `url:"direction,omitempty"`ListOptions}
DiscussionCommentListOptions specifies optional parameters to theTeamServices.ListComments method.
typeDiscussionEvent¶
type DiscussionEvent struct {// Action is the action that was performed. Possible values are:// created, edited, deleted, pinned, unpinned, locked, unlocked,// transferred, category_changed, answered, or unanswered.Action *string `json:"action,omitempty"`Discussion *Discussion `json:"discussion,omitempty"`Repo *Repository `json:"repository,omitempty"`Org *Organization `json:"organization,omitempty"`Sender *User `json:"sender,omitempty"`Installation *Installation `json:"installation,omitempty"`}
DiscussionEvent represents a webhook event for a discussion.The Webhook event name is "discussion".
GitHub API docs:https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion
func (*DiscussionEvent)GetAction¶
func (d *DiscussionEvent) GetAction()string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*DiscussionEvent)GetDiscussion¶
func (d *DiscussionEvent) GetDiscussion() *Discussion
GetDiscussion returns the Discussion field.
func (*DiscussionEvent)GetInstallation¶
func (d *DiscussionEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*DiscussionEvent)GetOrg¶
func (d *DiscussionEvent) GetOrg() *Organization
GetOrg returns the Org field.
func (*DiscussionEvent)GetRepo¶
func (d *DiscussionEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (*DiscussionEvent)GetSender¶
func (d *DiscussionEvent) GetSender() *User
GetSender returns the Sender field.
typeDiscussionListOptions¶
type DiscussionListOptions struct {// Sorts the discussion by the date they were created.// Accepted values are asc and desc. Default is desc.Directionstring `url:"direction,omitempty"`ListOptions}
DiscussionListOptions specifies optional parameters to theTeamServices.ListDiscussions method.
typeDismissalRestrictions¶
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.
typeDismissalRestrictionsRequest¶
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 therestriction to allows only specific users or teams to dimiss pull request reviews. It isseparate from DismissalRestrictions above because the request structure isdifferent from the response structure.Note: Both Users and Teams must be nil, or both must be non-nil.
func (*DismissalRestrictionsRequest)GetTeams¶
func (d *DismissalRestrictionsRequest) GetTeams() []string
GetTeams returns the Teams field if it's non-nil, zero value otherwise.
func (*DismissalRestrictionsRequest)GetUsers¶
func (d *DismissalRestrictionsRequest) GetUsers() []string
GetUsers returns the Users field if it's non-nil, zero value otherwise.
typeDismissedReview¶
type DismissedReview struct {// State represents the state of the dismissed review.// Possible values are: "commented", "approved", and "changes_requested".State *string `json:"state,omitempty"`ReviewID *int64 `json:"review_id,omitempty"`DismissalMessage *string `json:"dismissal_message,omitempty"`DismissalCommitID *string `json:"dismissal_commit_id,omitempty"`}
DismissedReview represents details for 'dismissed_review' events.
func (*DismissedReview)GetDismissalCommitID¶
func (d *DismissedReview) GetDismissalCommitID()string
GetDismissalCommitID returns the DismissalCommitID field if it's non-nil, zero value otherwise.
func (*DismissedReview)GetDismissalMessage¶
func (d *DismissedReview) GetDismissalMessage()string
GetDismissalMessage returns the DismissalMessage field if it's non-nil, zero value otherwise.
func (*DismissedReview)GetReviewID¶
func (d *DismissedReview) GetReviewID()int64
GetReviewID returns the ReviewID field if it's non-nil, zero value otherwise.
func (*DismissedReview)GetState¶
func (d *DismissedReview) GetState()string
GetState returns the State field if it's non-nil, zero value otherwise.
typeDispatchRequestOptions¶
type DispatchRequestOptions struct {// EventType is a custom webhook event name. (Required.)EventTypestring `json:"event_type"`// ClientPayload is a custom JSON payload with extra information about the webhook event.// Defaults to an empty JSON object.ClientPayload *json.RawMessage `json:"client_payload,omitempty"`}
DispatchRequestOptions represents a request to trigger a repository_dispatch event.
func (*DispatchRequestOptions)GetClientPayload¶
func (d *DispatchRequestOptions) GetClientPayload()json.RawMessage
GetClientPayload returns the ClientPayload field if it's non-nil, zero value otherwise.
typeDraftReviewComment¶
type DraftReviewComment struct {Path *string `json:"path,omitempty"`Position *int `json:"position,omitempty"`Body *string `json:"body,omitempty"`// The new comfort-fade-preview fieldsStartSide *string `json:"start_side,omitempty"`Side *string `json:"side,omitempty"`StartLine *int `json:"start_line,omitempty"`Line *int `json:"line,omitempty"`}
DraftReviewComment represents a comment part of the review.
func (*DraftReviewComment)GetBody¶
func (d *DraftReviewComment) GetBody()string
GetBody returns the Body field if it's non-nil, zero value otherwise.
func (*DraftReviewComment)GetLine¶
func (d *DraftReviewComment) GetLine()int
GetLine returns the Line field if it's non-nil, zero value otherwise.
func (*DraftReviewComment)GetPath¶
func (d *DraftReviewComment) GetPath()string
GetPath returns the Path field if it's non-nil, zero value otherwise.
func (*DraftReviewComment)GetPosition¶
func (d *DraftReviewComment) GetPosition()int
GetPosition returns the Position field if it's non-nil, zero value otherwise.
func (*DraftReviewComment)GetSide¶
func (d *DraftReviewComment) GetSide()string
GetSide returns the Side field if it's non-nil, zero value otherwise.
func (*DraftReviewComment)GetStartLine¶
func (d *DraftReviewComment) GetStartLine()int
GetStartLine returns the StartLine field if it's non-nil, zero value otherwise.
func (*DraftReviewComment)GetStartSide¶
func (d *DraftReviewComment) GetStartSide()string
GetStartSide returns the StartSide field if it's non-nil, zero value otherwise.
func (DraftReviewComment)String¶
func (cDraftReviewComment) String()string
typeEditBody¶
type EditBody struct {From *string `json:"from,omitempty"`}
EditBody represents a change of pull-request body.
typeEditChange¶
type EditChange struct {Title *EditTitle `json:"title,omitempty"`Body *EditBody `json:"body,omitempty"`Base *EditBase `json:"base,omitempty"`Repo *EditRepo `json:"repository,omitempty"`}
EditChange represents the changes when an issue, pull request, comment,or repository has been edited.
func (*EditChange)GetTitle¶
func (e *EditChange) GetTitle() *EditTitle
GetTitle returns the Title field.
typeEditRef¶
type EditRef struct {From *string `json:"from,omitempty"`}
EditRef represents a ref change of a pull-request.
typeEditRepo¶
type EditRepo struct {Name *RepoName `json:"name,omitempty"`}
EditRepo represents a change of repository name.
typeEditSHA¶
type EditSHA struct {From *string `json:"from,omitempty"`}
EditSHA represents a sha change of a pull-request.
typeEditTitle¶
type EditTitle struct {From *string `json:"from,omitempty"`}
EditTitle represents a pull-request title change.
typeEncryptedSecret¶
type EncryptedSecret struct {Namestring `json:"-"`KeyIDstring `json:"key_id"`EncryptedValuestring `json:"encrypted_value"`Visibilitystring `json:"visibility,omitempty"`SelectedRepositoryIDsSelectedRepoIDs `json:"selected_repository_ids,omitempty"`}
EncryptedSecret represents a secret that is encrypted using a public key.
The value of EncryptedValue must be your secret, encrypted withLibSodium (see documentation here:https://libsodium.gitbook.io/doc/bindings_for_other_languages)using the public key retrieved using the GetPublicKey method.
typeEnterprise¶
type Enterprise struct {ID *int `json:"id,omitempty"`Slug *string `json:"slug,omitempty"`Name *string `json:"name,omitempty"`NodeID *string `json:"node_id,omitempty"`AvatarURL *string `json:"avatar_url,omitempty"`Description *string `json:"description,omitempty"`WebsiteURL *string `json:"website_url,omitempty"`HTMLURL *string `json:"html_url,omitempty"`CreatedAt *Timestamp `json:"created_at,omitempty"`UpdatedAt *Timestamp `json:"updated_at,omitempty"`}
Enterprise represents the GitHub enterprise profile.
func (*Enterprise)GetAvatarURL¶
func (e *Enterprise) GetAvatarURL()string
GetAvatarURL returns the AvatarURL field if it's non-nil, zero value otherwise.
func (*Enterprise)GetCreatedAt¶
func (e *Enterprise) GetCreatedAt()Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*Enterprise)GetDescription¶
func (e *Enterprise) GetDescription()string
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (*Enterprise)GetHTMLURL¶
func (e *Enterprise) GetHTMLURL()string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*Enterprise)GetID¶
func (e *Enterprise) GetID()int
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*Enterprise)GetName¶
func (e *Enterprise) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*Enterprise)GetNodeID¶
func (e *Enterprise) GetNodeID()string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (*Enterprise)GetSlug¶
func (e *Enterprise) GetSlug()string
GetSlug returns the Slug field if it's non-nil, zero value otherwise.
func (*Enterprise)GetUpdatedAt¶
func (e *Enterprise) GetUpdatedAt()Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (*Enterprise)GetWebsiteURL¶
func (e *Enterprise) GetWebsiteURL()string
GetWebsiteURL returns the WebsiteURL field if it's non-nil, zero value otherwise.
func (Enterprise)String¶
func (mEnterprise) String()string
typeEnterpriseService¶
type EnterpriseService service
EnterpriseService provides access to the enterprise related functionsin the GitHub API.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/enterprise-admin/
func (*EnterpriseService)CreateRegistrationToken¶
func (s *EnterpriseService) CreateRegistrationToken(ctxcontext.Context, enterprisestring) (*RegistrationToken, *Response,error)
CreateRegistrationToken creates a token that can be used to add a self-hosted runner.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/enterprise-admin/#create-a-registration-token-for-an-enterprise
func (*EnterpriseService)GetAuditLog¶
func (s *EnterpriseService) GetAuditLog(ctxcontext.Context, enterprisestring, opts *GetAuditLogOptions) ([]*AuditEntry, *Response,error)
GetAuditLog gets the audit-log entries for an organization.
GitHub API docs:https://docs.github.com/en/rest/reference/enterprise-admin#get-the-audit-log-for-an-enterprise
func (*EnterpriseService)ListRunners¶
func (s *EnterpriseService) ListRunners(ctxcontext.Context, enterprisestring, opts *ListOptions) (*Runners, *Response,error)
ListRunners lists all the self-hosted runners for a enterprise.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/enterprise-admin/#list-self-hosted-runners-for-an-enterprise
func (*EnterpriseService)RemoveRunner¶
func (s *EnterpriseService) RemoveRunner(ctxcontext.Context, enterprisestring, runnerIDint64) (*Response,error)
RemoveRunner forces the removal of a self-hosted runner from an enterprise using the runner id.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/enterprise-admin/#delete-a-self-hosted-runner-from-an-enterprise
typeEnvResponse¶
type EnvResponse struct {TotalCount *int `json:"total_count,omitempty"`Environments []*Environment `json:"environments,omitempty"`}
EnvResponse represents the slightly different format of response that comes back when you list an environment.
func (*EnvResponse)GetTotalCount¶
func (e *EnvResponse) GetTotalCount()int
GetTotalCount returns the TotalCount field if it's non-nil, zero value otherwise.
typeEnvReviewers¶
EnvReviewers represents a single environment reviewer entry.
func (*EnvReviewers)GetID¶
func (e *EnvReviewers) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*EnvReviewers)GetType¶
func (e *EnvReviewers) GetType()string
GetType returns the Type field if it's non-nil, zero value otherwise.
typeEnvironment¶
type Environment struct {Owner *string `json:"owner,omitempty"`Repo *string `json:"repo,omitempty"`EnvironmentName *string `json:"environment_name,omitempty"`WaitTimer *int `json:"wait_timer,omitempty"`Reviewers []*EnvReviewers `json:"reviewers,omitempty"`DeploymentBranchPolicy *BranchPolicy `json:"deployment_branch_policy,omitempty"`// Return/response only valuesID *int64 `json:"id,omitempty"`NodeID *string `json:"node_id,omitempty"`Name *string `json:"name,omitempty"`URL *string `json:"url,omitempty"`HTMLURL *string `json:"html_url,omitempty"`CreatedAt *Timestamp `json:"created_at,omitempty"`UpdatedAt *Timestamp `json:"updated_at,omitempty"`ProtectionRules []*ProtectionRule `json:"protection_rules,omitempty"`}
Environment represents a single environment in a repository.
func (*Environment)GetCreatedAt¶
func (e *Environment) GetCreatedAt()Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*Environment)GetDeploymentBranchPolicy¶
func (e *Environment) GetDeploymentBranchPolicy() *BranchPolicy
GetDeploymentBranchPolicy returns the DeploymentBranchPolicy field.
func (*Environment)GetEnvironmentName¶
func (e *Environment) GetEnvironmentName()string
GetEnvironmentName returns the EnvironmentName field if it's non-nil, zero value otherwise.
func (*Environment)GetHTMLURL¶
func (e *Environment) GetHTMLURL()string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*Environment)GetID¶
func (e *Environment) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*Environment)GetName¶
func (e *Environment) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*Environment)GetNodeID¶
func (e *Environment) GetNodeID()string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (*Environment)GetOwner¶
func (e *Environment) GetOwner()string
GetOwner returns the Owner field if it's non-nil, zero value otherwise.
func (*Environment)GetRepo¶
func (e *Environment) GetRepo()string
GetRepo returns the Repo field if it's non-nil, zero value otherwise.
func (*Environment)GetURL¶
func (e *Environment) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (*Environment)GetUpdatedAt¶
func (e *Environment) GetUpdatedAt()Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (*Environment)GetWaitTimer¶
func (e *Environment) GetWaitTimer()int
GetWaitTimer returns the WaitTimer field if it's non-nil, zero value otherwise.
typeEnvironmentListOptions¶
type EnvironmentListOptions struct {ListOptions}
EnvironmentListOptions specifies the optional parameters to theRepositoriesService.ListEnvironments method.
typeError¶
type Error struct {Resourcestring `json:"resource"`// resource on which the error occurredFieldstring `json:"field"`// field on which the error occurredCodestring `json:"code"`// validation error codeMessagestring `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 existmissing_field: a required field on a resource has not been setinvalid: the formatting of a field is invalidalready_exists: another resource has the same valid as this fieldcustom: some resources return this (e.g. github.User.CreateKey()), additional information is set in the Message field of the Error
GitHub error responses structure are often undocumented and inconsistent.Sometimes error is just a simple string (Issue #540).In such cases, Message represents an error message as a workaround.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/#client-errors
func (*Error)UnmarshalJSON¶
typeErrorBlock¶
type ErrorBlock struct {Reasonstring `json:"reason,omitempty"`CreatedAt *Timestamp `json:"created_at,omitempty"`}
ErrorBlock contains a further explanation for the reason of an error.Seehttps://developer.github.com/changes/2016-03-17-the-451-status-code-is-now-supported/for more information.
func (*ErrorBlock)GetCreatedAt¶
func (e *ErrorBlock) GetCreatedAt()Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
typeErrorResponse¶
type ErrorResponse struct {Response *http.Response// HTTP response that caused this errorMessagestring `json:"message"`// error messageErrors []Error `json:"errors"`// more detail on individual errors// Block is only populated on certain types of errors such as code 451.Block *ErrorBlock `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://docs.github.com/en/free-pro-team@latest/rest/reference/#client-errorsDocumentationURLstring `json:"documentation_url,omitempty"`}
An ErrorResponse reports one or more errors caused by an API request.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/#client-errors
func (*ErrorResponse)Error¶
func (r *ErrorResponse) Error()string
func (*ErrorResponse)GetBlock¶
func (e *ErrorResponse) GetBlock() *ErrorBlock
GetBlock returns the Block field.
func (*ErrorResponse)Is¶
func (r *ErrorResponse) Is(targeterror)bool
Is returns whether the provided error equals this error.
typeEvent¶
type Event struct {Type *string `json:"type,omitempty"`Public *bool `json:"public,omitempty"`RawPayload *json.RawMessage `json:"payload,omitempty"`Repo *Repository `json:"repo,omitempty"`Actor *User `json:"actor,omitempty"`Org *Organization `json:"org,omitempty"`CreatedAt *time.Time `json:"created_at,omitempty"`ID *string `json:"id,omitempty"`}
Event represents a GitHub event.
func (*Event)GetCreatedAt¶
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*Event)GetRawPayload¶
func (e *Event) GetRawPayload()json.RawMessage
GetRawPayload returns the RawPayload field if it's non-nil, zero value otherwise.
func (*Event)ParsePayload¶
ParsePayload parses the event payload. For recognized event types,a value of the corresponding struct type will be returned.
func (*Event)Payloaddeprecated
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 errorrather than panics if JSON unmarshaling raw payload fails.
typeExternalGroup¶
type ExternalGroup struct {GroupID *int64 `json:"group_id,omitempty"`GroupName *string `json:"group_name,omitempty"`UpdatedAt *Timestamp `json:"updated_at,omitempty"`Teams []*ExternalGroupTeam `json:"teams,omitempty"`Members []*ExternalGroupMember `json:"members,omitempty"`}
ExternalGroup represents an external group.
func (*ExternalGroup)GetGroupID¶
func (e *ExternalGroup) GetGroupID()int64
GetGroupID returns the GroupID field if it's non-nil, zero value otherwise.
func (*ExternalGroup)GetGroupName¶
func (e *ExternalGroup) GetGroupName()string
GetGroupName returns the GroupName field if it's non-nil, zero value otherwise.
func (*ExternalGroup)GetUpdatedAt¶
func (e *ExternalGroup) GetUpdatedAt()Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
typeExternalGroupList¶
type ExternalGroupList struct {Groups []*ExternalGroup `json:"groups"`}
ExternalGroupList represents a list of external groups.
typeExternalGroupMember¶
type ExternalGroupMember struct {MemberID *int64 `json:"member_id,omitempty"`MemberLogin *string `json:"member_login,omitempty"`MemberName *string `json:"member_name,omitempty"`MemberEmail *string `json:"member_email,omitempty"`}
ExternalGroupMember represents a member of an external group.
func (*ExternalGroupMember)GetMemberEmail¶
func (e *ExternalGroupMember) GetMemberEmail()string
GetMemberEmail returns the MemberEmail field if it's non-nil, zero value otherwise.
func (*ExternalGroupMember)GetMemberID¶
func (e *ExternalGroupMember) GetMemberID()int64
GetMemberID returns the MemberID field if it's non-nil, zero value otherwise.
func (*ExternalGroupMember)GetMemberLogin¶
func (e *ExternalGroupMember) GetMemberLogin()string
GetMemberLogin returns the MemberLogin field if it's non-nil, zero value otherwise.
func (*ExternalGroupMember)GetMemberName¶
func (e *ExternalGroupMember) GetMemberName()string
GetMemberName returns the MemberName field if it's non-nil, zero value otherwise.
typeExternalGroupTeam¶
type ExternalGroupTeam struct {TeamID *int64 `json:"team_id,omitempty"`TeamName *string `json:"team_name,omitempty"`}
ExternalGroupTeam represents a team connected to an external group.
func (*ExternalGroupTeam)GetTeamID¶
func (e *ExternalGroupTeam) GetTeamID()int64
GetTeamID returns the TeamID field if it's non-nil, zero value otherwise.
func (*ExternalGroupTeam)GetTeamName¶
func (e *ExternalGroupTeam) GetTeamName()string
GetTeamName returns the TeamName field if it's non-nil, zero value otherwise.
typeFeedLink¶
FeedLink represents a link to a related resource.
typeFeedLinks¶
type FeedLinks 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"`}
FeedLinks represents the links in a Feed.
func (*FeedLinks)GetCurrentUser¶
GetCurrentUser returns the CurrentUser field.
func (*FeedLinks)GetCurrentUserActor¶
GetCurrentUserActor returns the CurrentUserActor field.
func (*FeedLinks)GetCurrentUserOrganization¶
GetCurrentUserOrganization returns the CurrentUserOrganization field.
func (*FeedLinks)GetCurrentUserPublic¶
GetCurrentUserPublic returns the CurrentUserPublic field.
func (*FeedLinks)GetTimeline¶
GetTimeline returns the Timeline field.
typeFeeds¶
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 *FeedLinks `json:"_links,omitempty"`}
Feeds represents timeline resources in Atom format.
func (*Feeds)GetCurrentUserActorURL¶
GetCurrentUserActorURL returns the CurrentUserActorURL field if it's non-nil, zero value otherwise.
func (*Feeds)GetCurrentUserOrganizationURL¶
GetCurrentUserOrganizationURL returns the CurrentUserOrganizationURL field if it's non-nil, zero value otherwise.
func (*Feeds)GetCurrentUserPublicURL¶
GetCurrentUserPublicURL returns the CurrentUserPublicURL field if it's non-nil, zero value otherwise.
func (*Feeds)GetCurrentUserURL¶
GetCurrentUserURL returns the CurrentUserURL field if it's non-nil, zero value otherwise.
func (*Feeds)GetTimelineURL¶
GetTimelineURL returns the TimelineURL field if it's non-nil, zero value otherwise.
func (*Feeds)GetUserURL¶
GetUserURL returns the UserURL field if it's non-nil, zero value otherwise.
typeForkEvent¶
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://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#fork
func (*ForkEvent)GetForkee¶
func (f *ForkEvent) GetForkee() *Repository
GetForkee returns the Forkee field.
func (*ForkEvent)GetInstallation¶
func (f *ForkEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
typeGPGEmail¶
type GPGEmail struct {Email *string `json:"email,omitempty"`Verified *bool `json:"verified,omitempty"`}
GPGEmail represents an email address associated to a GPG key.
func (*GPGEmail)GetVerified¶
GetVerified returns the Verified field if it's non-nil, zero value otherwise.
typeGPGKey¶
type GPGKey struct {ID *int64 `json:"id,omitempty"`PrimaryKeyID *int64 `json:"primary_key_id,omitempty"`KeyID *string `json:"key_id,omitempty"`RawKey *string `json:"raw_key,omitempty"`PublicKey *string `json:"public_key,omitempty"`Emails []*GPGEmail `json:"emails,omitempty"`Subkeys []*GPGKey `json:"subkeys,omitempty"`CanSign *bool `json:"can_sign,omitempty"`CanEncryptComms *bool `json:"can_encrypt_comms,omitempty"`CanEncryptStorage *bool `json:"can_encrypt_storage,omitempty"`CanCertify *bool `json:"can_certify,omitempty"`CreatedAt *time.Time `json:"created_at,omitempty"`ExpiresAt *time.Time `json:"expires_at,omitempty"`}
GPGKey represents a GitHub user's public GPG key used to verify GPG signed commits and tags.
https://developer.github.com/changes/2016-04-04-git-signing-api-preview/
func (*GPGKey)GetCanCertify¶
GetCanCertify returns the CanCertify field if it's non-nil, zero value otherwise.
func (*GPGKey)GetCanEncryptComms¶
GetCanEncryptComms returns the CanEncryptComms field if it's non-nil, zero value otherwise.
func (*GPGKey)GetCanEncryptStorage¶
GetCanEncryptStorage returns the CanEncryptStorage field if it's non-nil, zero value otherwise.
func (*GPGKey)GetCanSign¶
GetCanSign returns the CanSign field if it's non-nil, zero value otherwise.
func (*GPGKey)GetCreatedAt¶
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*GPGKey)GetExpiresAt¶
GetExpiresAt returns the ExpiresAt field if it's non-nil, zero value otherwise.
func (*GPGKey)GetPrimaryKeyID¶
GetPrimaryKeyID returns the PrimaryKeyID field if it's non-nil, zero value otherwise.
func (*GPGKey)GetPublicKey¶
GetPublicKey returns the PublicKey field if it's non-nil, zero value otherwise.
typeGenerateNotesOptions¶
type GenerateNotesOptions struct {TagNamestring `json:"tag_name"`PreviousTagName *string `json:"previous_tag_name,omitempty"`TargetCommitish *string `json:"target_commitish,omitempty"`}
GenerateNotesOptions represents the options to generate release notes.
func (*GenerateNotesOptions)GetPreviousTagName¶
func (g *GenerateNotesOptions) GetPreviousTagName()string
GetPreviousTagName returns the PreviousTagName field if it's non-nil, zero value otherwise.
func (*GenerateNotesOptions)GetTargetCommitish¶
func (g *GenerateNotesOptions) GetTargetCommitish()string
GetTargetCommitish returns the TargetCommitish field if it's non-nil, zero value otherwise.
typeGetAuditLogOptions¶
type GetAuditLogOptions struct {Phrase *string `url:"phrase,omitempty"`// A search phrase. (Optional.)Include *string `url:"include,omitempty"`// Event type includes. Can be one of "web", "git", "all". Default: "web". (Optional.)Order *string `url:"order,omitempty"`// The order of audit log events. Can be one of "asc" or "desc". Default: "desc". (Optional.)ListCursorOptions}
GetAuditLogOptions sets up optional parameters to query audit-log endpoint.
func (*GetAuditLogOptions)GetInclude¶
func (g *GetAuditLogOptions) GetInclude()string
GetInclude returns the Include field if it's non-nil, zero value otherwise.
func (*GetAuditLogOptions)GetOrder¶
func (g *GetAuditLogOptions) GetOrder()string
GetOrder returns the Order field if it's non-nil, zero value otherwise.
func (*GetAuditLogOptions)GetPhrase¶
func (g *GetAuditLogOptions) GetPhrase()string
GetPhrase returns the Phrase field if it's non-nil, zero value otherwise.
typeGist¶
type Gist struct {ID *string `json:"id,omitempty"`Description *string `json:"description,omitempty"`Public *bool `json:"public,omitempty"`Owner *User `json:"owner,omitempty"`Files map[GistFilename]GistFile `json:"files,omitempty"`Comments *int `json:"comments,omitempty"`HTMLURL *string `json:"html_url,omitempty"`GitPullURL *string `json:"git_pull_url,omitempty"`GitPushURL *string `json:"git_push_url,omitempty"`CreatedAt *time.Time `json:"created_at,omitempty"`UpdatedAt *time.Time `json:"updated_at,omitempty"`NodeID *string `json:"node_id,omitempty"`}
Gist represents a GitHub's gist.
func (*Gist)GetComments¶
GetComments returns the Comments field if it's non-nil, zero value otherwise.
func (*Gist)GetCreatedAt¶
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*Gist)GetDescription¶
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (*Gist)GetFiles¶
func (g *Gist) GetFiles() map[GistFilename]GistFile
GetFiles returns the Files map if it's non-nil, an empty map otherwise.
func (*Gist)GetGitPullURL¶
GetGitPullURL returns the GitPullURL field if it's non-nil, zero value otherwise.
func (*Gist)GetGitPushURL¶
GetGitPushURL returns the GitPushURL field if it's non-nil, zero value otherwise.
func (*Gist)GetHTMLURL¶
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*Gist)GetUpdatedAt¶
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
typeGistComment¶
type GistComment struct {ID *int64 `json:"id,omitempty"`URL *string `json:"url,omitempty"`Body *string `json:"body,omitempty"`User *User `json:"user,omitempty"`CreatedAt *time.Time `json:"created_at,omitempty"`}
GistComment represents a Gist comment.
func (*GistComment)GetBody¶
func (g *GistComment) GetBody()string
GetBody returns the Body field if it's non-nil, zero value otherwise.
func (*GistComment)GetCreatedAt¶
func (g *GistComment) GetCreatedAt()time.Time
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*GistComment)GetID¶
func (g *GistComment) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*GistComment)GetURL¶
func (g *GistComment) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (GistComment)String¶
func (gGistComment) String()string
typeGistCommit¶
type GistCommit struct {URL *string `json:"url,omitempty"`Version *string `json:"version,omitempty"`User *User `json:"user,omitempty"`ChangeStatus *CommitStats `json:"change_status,omitempty"`CommittedAt *Timestamp `json:"committed_at,omitempty"`NodeID *string `json:"node_id,omitempty"`}
GistCommit represents a commit on a gist.
func (*GistCommit)GetChangeStatus¶
func (g *GistCommit) GetChangeStatus() *CommitStats
GetChangeStatus returns the ChangeStatus field.
func (*GistCommit)GetCommittedAt¶
func (g *GistCommit) GetCommittedAt()Timestamp
GetCommittedAt returns the CommittedAt field if it's non-nil, zero value otherwise.
func (*GistCommit)GetNodeID¶
func (g *GistCommit) GetNodeID()string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (*GistCommit)GetURL¶
func (g *GistCommit) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (*GistCommit)GetVersion¶
func (g *GistCommit) GetVersion()string
GetVersion returns the Version field if it's non-nil, zero value otherwise.
func (GistCommit)String¶
func (gcGistCommit) String()string
typeGistFile¶
type GistFile struct {Size *int `json:"size,omitempty"`Filename *string `json:"filename,omitempty"`Language *string `json:"language,omitempty"`Type *string `json:"type,omitempty"`RawURL *string `json:"raw_url,omitempty"`Content *string `json:"content,omitempty"`}
GistFile represents a file on a gist.
func (*GistFile)GetContent¶
GetContent returns the Content field if it's non-nil, zero value otherwise.
func (*GistFile)GetFilename¶
GetFilename returns the Filename field if it's non-nil, zero value otherwise.
func (*GistFile)GetLanguage¶
GetLanguage returns the Language field if it's non-nil, zero value otherwise.
typeGistFork¶
type GistFork struct {URL *string `json:"url,omitempty"`User *User `json:"user,omitempty"`ID *string `json:"id,omitempty"`CreatedAt *Timestamp `json:"created_at,omitempty"`UpdatedAt *Timestamp `json:"updated_at,omitempty"`NodeID *string `json:"node_id,omitempty"`}
GistFork represents a fork of a gist.
func (*GistFork)GetCreatedAt¶
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*GistFork)GetUpdatedAt¶
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
typeGistListOptions¶
type GistListOptions struct {// Since filters Gists by time.Sincetime.Time `url:"since,omitempty"`ListOptions}
GistListOptions specifies the optional parameters to theGistsService.List, GistsService.ListAll, and GistsService.ListStarred methods.
typeGistStats¶
type GistStats struct {TotalGists *int `json:"total_gists,omitempty"`PrivateGists *int `json:"private_gists,omitempty"`PublicGists *int `json:"public_gists,omitempty"`}
GistStats represents the number of total, private and public gists.
func (*GistStats)GetPrivateGists¶
GetPrivateGists returns the PrivateGists field if it's non-nil, zero value otherwise.
func (*GistStats)GetPublicGists¶
GetPublicGists returns the PublicGists field if it's non-nil, zero value otherwise.
func (*GistStats)GetTotalGists¶
GetTotalGists returns the TotalGists field if it's non-nil, zero value otherwise.
typeGistsService¶
type GistsService service
GistsService handles communication with the Gist relatedmethods of the GitHub API.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/gists/
func (*GistsService)Create¶
Create a gist for authenticated user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/gists/#create-a-gist
func (*GistsService)CreateComment¶
func (s *GistsService) CreateComment(ctxcontext.Context, gistIDstring, comment *GistComment) (*GistComment, *Response,error)
CreateComment creates a comment for a gist.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/gists/#create-a-gist-comment
func (*GistsService)Delete¶
Delete a gist.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/gists/#delete-a-gist
func (*GistsService)DeleteComment¶
func (s *GistsService) DeleteComment(ctxcontext.Context, gistIDstring, commentIDint64) (*Response,error)
DeleteComment deletes a gist comment.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/gists/#delete-a-gist-comment
func (*GistsService)Edit¶
Edit a gist.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/gists/#update-a-gist
func (*GistsService)EditComment¶
func (s *GistsService) EditComment(ctxcontext.Context, gistIDstring, commentIDint64, comment *GistComment) (*GistComment, *Response,error)
EditComment edits an existing gist comment.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/gists/#update-a-gist-comment
func (*GistsService)Fork¶
Fork a gist.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/gists/#fork-a-gist
func (*GistsService)Get¶
Get a single gist.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/gists/#get-a-gist
func (*GistsService)GetComment¶
func (s *GistsService) GetComment(ctxcontext.Context, gistIDstring, commentIDint64) (*GistComment, *Response,error)
GetComment retrieves a single comment from a gist.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/gists/#get-a-gist-comment
func (*GistsService)GetRevision¶
GetRevision gets a specific revision of a gist.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/gists/#get-a-gist-revision
func (*GistsService)IsStarred¶
IsStarred checks if a gist is starred by authenticated user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/gists/#check-if-a-gist-is-starred
func (*GistsService)List¶
func (s *GistsService) List(ctxcontext.Context, userstring, opts *GistListOptions) ([]*Gist, *Response,error)
List gists for a user. Passing the empty string will listall public gists if called anonymously. However, if the callis authenticated, it will returns all gists for the authenticateduser.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/gists/#list-gists-for-the-authenticated-userGitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/gists/#list-gists-for-a-user
func (*GistsService)ListAll¶
func (s *GistsService) ListAll(ctxcontext.Context, opts *GistListOptions) ([]*Gist, *Response,error)
ListAll lists all public gists.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/gists/#list-public-gists
func (*GistsService)ListComments¶
func (s *GistsService) ListComments(ctxcontext.Context, gistIDstring, opts *ListOptions) ([]*GistComment, *Response,error)
ListComments lists all comments for a gist.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/gists/#list-gist-comments
func (*GistsService)ListCommits¶
func (s *GistsService) ListCommits(ctxcontext.Context, idstring, opts *ListOptions) ([]*GistCommit, *Response,error)
ListCommits lists commits of a gist.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/gists/#list-gist-commits
func (*GistsService)ListForks¶
func (s *GistsService) ListForks(ctxcontext.Context, idstring, opts *ListOptions) ([]*GistFork, *Response,error)
ListForks lists forks of a gist.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/gists/#list-gist-forks
func (*GistsService)ListStarred¶
func (s *GistsService) ListStarred(ctxcontext.Context, opts *GistListOptions) ([]*Gist, *Response,error)
ListStarred lists starred gists of authenticated user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/gists/#list-starred-gists
func (*GistsService)Star¶
Star a gist on behalf of authenticated user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/gists/#star-a-gist
func (*GistsService)Unstar¶
Unstar a gist on a behalf of authenticated user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/gists/#unstar-a-gist
typeGitHubAppAuthorizationEvent¶
type GitHubAppAuthorizationEvent struct {// The action performed. Possible value is: "revoked".Action *string `json:"action,omitempty"`// The following fields are only populated by Webhook events.Sender *User `json:"sender,omitempty"`Installation *Installation `json:"installation,omitempty"`}
GitHubAppAuthorizationEvent is triggered when a user's authorization for aGitHub Application is revoked.
GitHub API docs:https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#github_app_authorization
func (*GitHubAppAuthorizationEvent)GetAction¶
func (g *GitHubAppAuthorizationEvent) GetAction()string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*GitHubAppAuthorizationEvent)GetInstallation¶
func (g *GitHubAppAuthorizationEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*GitHubAppAuthorizationEvent)GetSender¶
func (g *GitHubAppAuthorizationEvent) GetSender() *User
GetSender returns the Sender field.
typeGitObject¶
GitObject represents a Git object.
typeGitService¶
type GitService service
GitService handles communication with the git data relatedmethods of the GitHub API.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/git/
func (*GitService)CreateBlob¶
func (s *GitService) CreateBlob(ctxcontext.Context, ownerstring, repostring, blob *Blob) (*Blob, *Response,error)
CreateBlob creates a blob object.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/git/#create-a-blob
func (*GitService)CreateCommit¶
func (s *GitService) CreateCommit(ctxcontext.Context, ownerstring, repostring, 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.Authordata if omitted. If the commit.Author is omitted, it will be filled in withthe authenticated user’s information and the current date.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/git/#create-a-commit
func (*GitService)CreateRef¶
func (s *GitService) CreateRef(ctxcontext.Context, ownerstring, repostring, ref *Reference) (*Reference, *Response,error)
CreateRef creates a new ref in a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/git/#create-a-reference
func (*GitService)CreateTag¶
func (s *GitService) CreateTag(ctxcontext.Context, ownerstring, repostring, tag *Tag) (*Tag, *Response,error)
CreateTag creates a tag object.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/git/#create-a-tag-object
func (*GitService)CreateTree¶
func (s *GitService) CreateTree(ctxcontext.Context, ownerstring, repostring, baseTreestring, entries []*TreeEntry) (*Tree, *Response,error)
CreateTree creates a new tree in a repository. If both a tree and a nestedpath modifying that tree are specified, it will overwrite the contents ofthat tree with the new path contents and write a new tree out.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/git/#create-a-tree
func (*GitService)DeleteRef¶
func (s *GitService) DeleteRef(ctxcontext.Context, ownerstring, repostring, refstring) (*Response,error)
DeleteRef deletes a ref from a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/git/#delete-a-reference
func (*GitService)GetBlob¶
func (s *GitService) GetBlob(ctxcontext.Context, ownerstring, repostring, shastring) (*Blob, *Response,error)
GetBlob fetches a blob from a repo given a SHA.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/git/#get-a-blob
func (*GitService)GetBlobRaw¶
func (s *GitService) GetBlobRaw(ctxcontext.Context, owner, repo, shastring) ([]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://docs.github.com/en/free-pro-team@latest/rest/reference/git/#get-a-blob
func (*GitService)GetCommit¶
func (s *GitService) GetCommit(ctxcontext.Context, ownerstring, repostring, shastring) (*Commit, *Response,error)
GetCommit fetches the Commit object for a given SHA.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/git/#get-a-commit
func (*GitService)GetRef¶
func (s *GitService) GetRef(ctxcontext.Context, ownerstring, repostring, refstring) (*Reference, *Response,error)
GetRef fetches a single reference in a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/git/#get-a-reference
func (*GitService)GetTag¶
func (s *GitService) GetTag(ctxcontext.Context, ownerstring, repostring, shastring) (*Tag, *Response,error)
GetTag fetches a tag from a repo given a SHA.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/git/#get-a-tag
func (*GitService)GetTree¶
func (s *GitService) GetTree(ctxcontext.Context, ownerstring, repostring, shastring, recursivebool) (*Tree, *Response,error)
GetTree fetches the Tree object for a given sha hash from a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/git/#get-a-tree
func (*GitService)ListMatchingRefs¶
func (s *GitService) ListMatchingRefs(ctxcontext.Context, owner, repostring, opts *ReferenceListOptions) ([]*Reference, *Response,error)
ListMatchingRefs lists references in a repository that match a supplied ref.Use an empty ref to list all references.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/git/#list-matching-references
func (*GitService)UpdateRef¶
func (s *GitService) UpdateRef(ctxcontext.Context, ownerstring, repostring, ref *Reference, forcebool) (*Reference, *Response,error)
UpdateRef updates an existing ref in a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/git/#update-a-reference
typeGitignore¶
type Gitignore struct {Name *string `json:"name,omitempty"`Source *string `json:"source,omitempty"`}
Gitignore represents a .gitignore file as returned by the GitHub API.
typeGitignoresService¶
type GitignoresService service
GitignoresService provides access to the gitignore related functions in theGitHub API.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/gitignore/
func (*GitignoresService)Get¶
Get a Gitignore by name.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/gitignore/#get-a-gitignore-template
func (*GitignoresService)List¶
List all available Gitignore templates.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/gitignore/#listing-available-templates
typeGollumEvent¶
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://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#gollum
func (*GollumEvent)GetInstallation¶
func (g *GollumEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*GollumEvent)GetRepo¶
func (g *GollumEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (*GollumEvent)GetSender¶
func (g *GollumEvent) GetSender() *User
GetSender returns the Sender field.
typeGrant¶
type Grant struct {ID *int64 `json:"id,omitempty"`URL *string `json:"url,omitempty"`App *AuthorizationApp `json:"app,omitempty"`CreatedAt *Timestamp `json:"created_at,omitempty"`UpdatedAt *Timestamp `json:"updated_at,omitempty"`Scopes []string `json:"scopes,omitempty"`}
Grant represents an OAuth application that has been granted access to an account.
func (*Grant)GetCreatedAt¶
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*Grant)GetUpdatedAt¶
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
typeHeadCommit¶
type HeadCommit 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"`}
HeadCommit represents a git commit in a GitHub PushEvent.
func (*HeadCommit)GetAuthor¶
func (h *HeadCommit) GetAuthor() *CommitAuthor
GetAuthor returns the Author field.
func (*HeadCommit)GetCommitter¶
func (h *HeadCommit) GetCommitter() *CommitAuthor
GetCommitter returns the Committer field.
func (*HeadCommit)GetDistinct¶
func (h *HeadCommit) GetDistinct()bool
GetDistinct returns the Distinct field if it's non-nil, zero value otherwise.
func (*HeadCommit)GetID¶
func (h *HeadCommit) GetID()string
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*HeadCommit)GetMessage¶
func (h *HeadCommit) GetMessage()string
GetMessage returns the Message field if it's non-nil, zero value otherwise.
func (*HeadCommit)GetSHA¶
func (h *HeadCommit) GetSHA()string
GetSHA returns the SHA field if it's non-nil, zero value otherwise.
func (*HeadCommit)GetTimestamp¶
func (h *HeadCommit) GetTimestamp()Timestamp
GetTimestamp returns the Timestamp field if it's non-nil, zero value otherwise.
func (*HeadCommit)GetTreeID¶
func (h *HeadCommit) GetTreeID()string
GetTreeID returns the TreeID field if it's non-nil, zero value otherwise.
func (*HeadCommit)GetURL¶
func (h *HeadCommit) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (HeadCommit)String¶
func (pHeadCommit) String()string
typeHook¶
type Hook struct {CreatedAt *time.Time `json:"created_at,omitempty"`UpdatedAt *time.Time `json:"updated_at,omitempty"`URL *string `json:"url,omitempty"`ID *int64 `json:"id,omitempty"`Type *string `json:"type,omitempty"`Name *string `json:"name,omitempty"`TestURL *string `json:"test_url,omitempty"`PingURL *string `json:"ping_url,omitempty"`LastResponse map[string]interface{} `json:"last_response,omitempty"`// Only the following fields are used when creating a hook.// Config is required.Config map[string]interface{} `json:"config,omitempty"`Events []string `json:"events,omitempty"`Active *bool `json:"active,omitempty"`}
Hook represents a GitHub (web and service) hook for a repository.
func (*Hook)GetCreatedAt¶
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*Hook)GetPingURL¶
GetPingURL returns the PingURL field if it's non-nil, zero value otherwise.
func (*Hook)GetTestURL¶
GetTestURL returns the TestURL field if it's non-nil, zero value otherwise.
func (*Hook)GetUpdatedAt¶
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
typeHookConfig¶
type HookConfig struct {ContentType *string `json:"content_type,omitempty"`InsecureSSL *string `json:"insecure_ssl,omitempty"`URL *string `json:"url,omitempty"`// Secret is returned obfuscated by GitHub, but it can be set for outgoing requests.Secret *string `json:"secret,omitempty"`}
HookConfig describes metadata about a webhook configuration.
func (*HookConfig)GetContentType¶
func (h *HookConfig) GetContentType()string
GetContentType returns the ContentType field if it's non-nil, zero value otherwise.
func (*HookConfig)GetInsecureSSL¶
func (h *HookConfig) GetInsecureSSL()string
GetInsecureSSL returns the InsecureSSL field if it's non-nil, zero value otherwise.
func (*HookConfig)GetSecret¶
func (h *HookConfig) GetSecret()string
GetSecret returns the Secret field if it's non-nil, zero value otherwise.
func (*HookConfig)GetURL¶
func (h *HookConfig) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
typeHookDelivery¶
type HookDelivery struct {ID *int64 `json:"id,omitempty"`GUID *string `json:"guid,omitempty"`DeliveredAt *Timestamp `json:"delivered_at,omitempty"`Redelivery *bool `json:"redelivery,omitempty"`Duration *float64 `json:"duration,omitempty"`Status *string `json:"status,omitempty"`StatusCode *int `json:"status_code,omitempty"`Event *string `json:"event,omitempty"`Action *string `json:"action,omitempty"`InstallationID *int64 `json:"installation_id,omitempty"`RepositoryID *int64 `json:"repository_id,omitempty"`// Request is populated by GetHookDelivery.Request *HookRequest `json:"request,omitempty"`// Response is populated by GetHookDelivery.Response *HookResponse `json:"response,omitempty"`}
HookDelivery represents the data that is received from GitHub's Webhook Delivery API
GitHub API docs:-https://docs.github.com/en/rest/reference/repos#list-deliveries-for-a-repository-webhook-https://docs.github.com/en/rest/reference/repos#get-a-delivery-for-a-repository-webhook
func (*HookDelivery)GetAction¶
func (h *HookDelivery) GetAction()string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*HookDelivery)GetDeliveredAt¶
func (h *HookDelivery) GetDeliveredAt()Timestamp
GetDeliveredAt returns the DeliveredAt field if it's non-nil, zero value otherwise.
func (*HookDelivery)GetDuration¶
func (h *HookDelivery) GetDuration() *float64
GetDuration returns the Duration field.
func (*HookDelivery)GetEvent¶
func (h *HookDelivery) GetEvent()string
GetEvent returns the Event field if it's non-nil, zero value otherwise.
func (*HookDelivery)GetGUID¶
func (h *HookDelivery) GetGUID()string
GetGUID returns the GUID field if it's non-nil, zero value otherwise.
func (*HookDelivery)GetID¶
func (h *HookDelivery) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*HookDelivery)GetInstallationID¶
func (h *HookDelivery) GetInstallationID()int64
GetInstallationID returns the InstallationID field if it's non-nil, zero value otherwise.
func (*HookDelivery)GetRedelivery¶
func (h *HookDelivery) GetRedelivery()bool
GetRedelivery returns the Redelivery field if it's non-nil, zero value otherwise.
func (*HookDelivery)GetRepositoryID¶
func (h *HookDelivery) GetRepositoryID()int64
GetRepositoryID returns the RepositoryID field if it's non-nil, zero value otherwise.
func (*HookDelivery)GetRequest¶
func (h *HookDelivery) GetRequest() *HookRequest
GetRequest returns the Request field.
func (*HookDelivery)GetResponse¶
func (h *HookDelivery) GetResponse() *HookResponse
GetResponse returns the Response field.
func (*HookDelivery)GetStatus¶
func (h *HookDelivery) GetStatus()string
GetStatus returns the Status field if it's non-nil, zero value otherwise.
func (*HookDelivery)GetStatusCode¶
func (h *HookDelivery) GetStatusCode()int
GetStatusCode returns the StatusCode field if it's non-nil, zero value otherwise.
func (*HookDelivery)ParseRequestPayload¶
func (d *HookDelivery) ParseRequestPayload() (interface{},error)
ParseRequestPayload parses the request payload. For recognized event types,a value of the corresponding struct type will be returned.
func (HookDelivery)String¶
func (dHookDelivery) String()string
typeHookRequest¶
type HookRequest struct {Headers map[string]string `json:"headers,omitempty"`RawPayload *json.RawMessage `json:"payload,omitempty"`}
HookRequest is a part of HookDelivery that containsthe HTTP headers and the JSON payload of the webhook request.
func (*HookRequest)GetHeaders¶
func (h *HookRequest) GetHeaders() map[string]string
GetHeaders returns the Headers map if it's non-nil, an empty map otherwise.
func (*HookRequest)GetRawPayload¶
func (h *HookRequest) GetRawPayload()json.RawMessage
GetRawPayload returns the RawPayload field if it's non-nil, zero value otherwise.
func (HookRequest)String¶
func (rHookRequest) String()string
typeHookResponse¶
type HookResponse struct {Headers map[string]string `json:"headers,omitempty"`RawPayload *json.RawMessage `json:"payload,omitempty"`}
HookResponse is a part of HookDelivery that containsthe HTTP headers and the response body served by the webhook endpoint.
func (*HookResponse)GetHeaders¶
func (h *HookResponse) GetHeaders() map[string]string
GetHeaders returns the Headers map if it's non-nil, an empty map otherwise.
func (*HookResponse)GetRawPayload¶
func (h *HookResponse) GetRawPayload()json.RawMessage
GetRawPayload returns the RawPayload field if it's non-nil, zero value otherwise.
func (HookResponse)String¶
func (rHookResponse) String()string
typeHookStats¶
type HookStats struct {TotalHooks *int `json:"total_hooks,omitempty"`ActiveHooks *int `json:"active_hooks,omitempty"`InactiveHooks *int `json:"inactive_hooks,omitempty"`}
HookStats represents the number of total, active and inactive hooks.
func (*HookStats)GetActiveHooks¶
GetActiveHooks returns the ActiveHooks field if it's non-nil, zero value otherwise.
func (*HookStats)GetInactiveHooks¶
GetInactiveHooks returns the InactiveHooks field if it's non-nil, zero value otherwise.
func (*HookStats)GetTotalHooks¶
GetTotalHooks returns the TotalHooks field if it's non-nil, zero value otherwise.
typeHovercard¶
type Hovercard struct {Contexts []*UserContext `json:"contexts,omitempty"`}
Hovercard represents hovercard information about a user.
typeHovercardOptions¶
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.)SubjectTypestring `url:"subject_type"`// SubjectID specifies the ID for the SubjectType. (Required when using subject_type.)SubjectIDstring `url:"subject_id"`}
HovercardOptions specifies optional parameters to the UsersService.GetHovercardmethod.
typeIDPGroup¶
type IDPGroup struct {GroupID *string `json:"group_id,omitempty"`GroupName *string `json:"group_name,omitempty"`GroupDescription *string `json:"group_description,omitempty"`}
IDPGroup represents an external identity provider (IDP) group.
func (*IDPGroup)GetGroupDescription¶
GetGroupDescription returns the GroupDescription field if it's non-nil, zero value otherwise.
func (*IDPGroup)GetGroupID¶
GetGroupID returns the GroupID field if it's non-nil, zero value otherwise.
func (*IDPGroup)GetGroupName¶
GetGroupName returns the GroupName field if it's non-nil, zero value otherwise.
typeIDPGroupList¶
type IDPGroupList struct {Groups []*IDPGroup `json:"groups"`}
IDPGroupList represents a list of external identity provider (IDP) groups.
typeImpersonateUserOptions¶
type ImpersonateUserOptions struct {Scopes []string `json:"scopes,omitempty"`}
ImpersonateUserOptions represents the scoping for the OAuth token.
typeImport¶
type Import struct {// The URL of the originating repository.VCSURL *string `json:"vcs_url,omitempty"`// The originating VCS type. Can be one of 'subversion', 'git',// 'mercurial', or 'tfvc'. Without this parameter, the import job will// take additional time to detect the VCS type before beginning the// import. This detection step will be reflected in the response.VCS *string `json:"vcs,omitempty"`// VCSUsername and VCSPassword are only used for StartImport calls that// are importing a password-protected repository.VCSUsername *string `json:"vcs_username,omitempty"`VCSPassword *string `json:"vcs_password,omitempty"`// For a tfvc import, the name of the project that is being imported.TFVCProject *string `json:"tfvc_project,omitempty"`// Describes whether the import has been opted in or out of using Git// LFS. The value can be 'opt_in', 'opt_out', or 'undecided' if no// action has been taken.UseLFS *string `json:"use_lfs,omitempty"`// Describes whether files larger than 100MB were found during the// importing step.HasLargeFiles *bool `json:"has_large_files,omitempty"`// The total size in gigabytes of files larger than 100MB found in the// originating repository.LargeFilesSize *int `json:"large_files_size,omitempty"`// The total number of files larger than 100MB found in the originating// repository. To see a list of these files, call LargeFiles.LargeFilesCount *int `json:"large_files_count,omitempty"`// Identifies the current status of an import. An import that does not// have errors will progress through these steps://// detecting - the "detection" step of the import is in progress// because the request did not include a VCS parameter. The// import is identifying the type of source control present at// the URL.// importing - the "raw" step of the import is in progress. This is// where commit data is fetched from the original repository.// The import progress response will include CommitCount (the// total number of raw commits that will be imported) and// Percent (0 - 100, the current progress through the import).// mapping - the "rewrite" step of the import is in progress. This// is where SVN branches are converted to Git branches, and// where author updates are applied. The import progress// response does not include progress information.// pushing - the "push" step of the import is in progress. This is// where the importer updates the repository on GitHub. The// import progress response will include PushPercent, which is// the percent value reported by git push when it is "Writing// objects".// complete - the import is complete, and the repository is ready// on GitHub.//// If there are problems, you will see one of these in the status field://// auth_failed - the import requires authentication in order to// connect to the original repository. Make an UpdateImport// request, and include VCSUsername and VCSPassword.// error - the import encountered an error. The import progress// response will include the FailedStep and an error message.// Contact GitHub support for more information.// detection_needs_auth - the importer requires authentication for// the originating repository to continue detection. Make an// UpdatImport request, and include VCSUsername and// VCSPassword.// detection_found_nothing - the importer didn't recognize any// source control at the URL.// detection_found_multiple - the importer found several projects// or repositories at the provided URL. When this is the case,// the Import Progress response will also include a// ProjectChoices field with the possible project choices as// values. Make an UpdateImport request, and include VCS and// (if applicable) TFVCProject.Status *string `json:"status,omitempty"`CommitCount *int `json:"commit_count,omitempty"`StatusText *string `json:"status_text,omitempty"`AuthorsCount *int `json:"authors_count,omitempty"`Percent *int `json:"percent,omitempty"`PushPercent *int `json:"push_percent,omitempty"`URL *string `json:"url,omitempty"`HTMLURL *string `json:"html_url,omitempty"`AuthorsURL *string `json:"authors_url,omitempty"`RepositoryURL *string `json:"repository_url,omitempty"`Message *string `json:"message,omitempty"`FailedStep *string `json:"failed_step,omitempty"`// Human readable display name, provided when the Import appears as// part of ProjectChoices.HumanName *string `json:"human_name,omitempty"`// When the importer finds several projects or repositories at the// provided URLs, this will identify the available choices. Call// UpdateImport with the selected Import value.ProjectChoices []*Import `json:"project_choices,omitempty"`}
Import represents a repository import request.
func (*Import)GetAuthorsCount¶
GetAuthorsCount returns the AuthorsCount field if it's non-nil, zero value otherwise.
func (*Import)GetAuthorsURL¶
GetAuthorsURL returns the AuthorsURL field if it's non-nil, zero value otherwise.
func (*Import)GetCommitCount¶
GetCommitCount returns the CommitCount field if it's non-nil, zero value otherwise.
func (*Import)GetFailedStep¶
GetFailedStep returns the FailedStep field if it's non-nil, zero value otherwise.
func (*Import)GetHTMLURL¶
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*Import)GetHasLargeFiles¶
GetHasLargeFiles returns the HasLargeFiles field if it's non-nil, zero value otherwise.
func (*Import)GetHumanName¶
GetHumanName returns the HumanName field if it's non-nil, zero value otherwise.
func (*Import)GetLargeFilesCount¶
GetLargeFilesCount returns the LargeFilesCount field if it's non-nil, zero value otherwise.
func (*Import)GetLargeFilesSize¶
GetLargeFilesSize returns the LargeFilesSize field if it's non-nil, zero value otherwise.
func (*Import)GetMessage¶
GetMessage returns the Message field if it's non-nil, zero value otherwise.
func (*Import)GetPercent¶
GetPercent returns the Percent field if it's non-nil, zero value otherwise.
func (*Import)GetPushPercent¶
GetPushPercent returns the PushPercent field if it's non-nil, zero value otherwise.
func (*Import)GetRepositoryURL¶
GetRepositoryURL returns the RepositoryURL field if it's non-nil, zero value otherwise.
func (*Import)GetStatusText¶
GetStatusText returns the StatusText field if it's non-nil, zero value otherwise.
func (*Import)GetTFVCProject¶
GetTFVCProject returns the TFVCProject field if it's non-nil, zero value otherwise.
func (*Import)GetVCSPassword¶
GetVCSPassword returns the VCSPassword field if it's non-nil, zero value otherwise.
func (*Import)GetVCSUsername¶
GetVCSUsername returns the VCSUsername field if it's non-nil, zero value otherwise.
typeInstallation¶
type Installation struct {ID *int64 `json:"id,omitempty"`NodeID *string `json:"node_id,omitempty"`AppID *int64 `json:"app_id,omitempty"`AppSlug *string `json:"app_slug,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"`SingleFilePaths []string `json:"single_file_paths,omitempty"`Permissions *InstallationPermissions `json:"permissions,omitempty"`CreatedAt *Timestamp `json:"created_at,omitempty"`UpdatedAt *Timestamp `json:"updated_at,omitempty"`HasMultipleSingleFiles *bool `json:"has_multiple_single_files,omitempty"`SuspendedBy *User `json:"suspended_by,omitempty"`SuspendedAt *Timestamp `json:"suspended_at,omitempty"`}
Installation represents a GitHub Apps installation.
func (*Installation)GetAccessTokensURL¶
func (i *Installation) GetAccessTokensURL()string
GetAccessTokensURL returns the AccessTokensURL field if it's non-nil, zero value otherwise.
func (*Installation)GetAccount¶
func (i *Installation) GetAccount() *User
GetAccount returns the Account field.
func (*Installation)GetAppID¶
func (i *Installation) GetAppID()int64
GetAppID returns the AppID field if it's non-nil, zero value otherwise.
func (*Installation)GetAppSlug¶
func (i *Installation) GetAppSlug()string
GetAppSlug returns the AppSlug field if it's non-nil, zero value otherwise.
func (*Installation)GetCreatedAt¶
func (i *Installation) GetCreatedAt()Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*Installation)GetHTMLURL¶
func (i *Installation) GetHTMLURL()string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*Installation)GetHasMultipleSingleFiles¶
func (i *Installation) GetHasMultipleSingleFiles()bool
GetHasMultipleSingleFiles returns the HasMultipleSingleFiles field if it's non-nil, zero value otherwise.
func (*Installation)GetID¶
func (i *Installation) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*Installation)GetNodeID¶
func (i *Installation) GetNodeID()string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (*Installation)GetPermissions¶
func (i *Installation) GetPermissions() *InstallationPermissions
GetPermissions returns the Permissions field.
func (*Installation)GetRepositoriesURL¶
func (i *Installation) GetRepositoriesURL()string
GetRepositoriesURL returns the RepositoriesURL field if it's non-nil, zero value otherwise.
func (*Installation)GetRepositorySelection¶
func (i *Installation) GetRepositorySelection()string
GetRepositorySelection returns the RepositorySelection field if it's non-nil, zero value otherwise.
func (*Installation)GetSingleFileName¶
func (i *Installation) GetSingleFileName()string
GetSingleFileName returns the SingleFileName field if it's non-nil, zero value otherwise.
func (*Installation)GetSuspendedAt¶
func (i *Installation) GetSuspendedAt()Timestamp
GetSuspendedAt returns the SuspendedAt field if it's non-nil, zero value otherwise.
func (*Installation)GetSuspendedBy¶
func (i *Installation) GetSuspendedBy() *User
GetSuspendedBy returns the SuspendedBy field.
func (*Installation)GetTargetID¶
func (i *Installation) GetTargetID()int64
GetTargetID returns the TargetID field if it's non-nil, zero value otherwise.
func (*Installation)GetTargetType¶
func (i *Installation) GetTargetType()string
GetTargetType returns the TargetType field if it's non-nil, zero value otherwise.
func (*Installation)GetUpdatedAt¶
func (i *Installation) GetUpdatedAt()Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (Installation)String¶
func (iInstallation) String()string
typeInstallationEvent¶
type InstallationEvent struct {// The action that was performed. Can be either "created", "deleted", "suspend", "unsuspend" or "new_permissions_accepted".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, uninstalled, suspend, unsuspendedor new permissions have been accepted.The Webhook event name is "installation".
GitHub API docs:https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#installation
func (*InstallationEvent)GetAction¶
func (i *InstallationEvent) GetAction()string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*InstallationEvent)GetInstallation¶
func (i *InstallationEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*InstallationEvent)GetSender¶
func (i *InstallationEvent) GetSender() *User
GetSender returns the Sender field.
typeInstallationPermissions¶
type InstallationPermissions struct {Actions *string `json:"actions,omitempty"`Administration *string `json:"administration,omitempty"`Blocking *string `json:"blocking,omitempty"`Checks *string `json:"checks,omitempty"`Contents *string `json:"contents,omitempty"`ContentReferences *string `json:"content_references,omitempty"`Deployments *string `json:"deployments,omitempty"`Emails *string `json:"emails,omitempty"`Environments *string `json:"environments,omitempty"`Followers *string `json:"followers,omitempty"`Issues *string `json:"issues,omitempty"`Metadata *string `json:"metadata,omitempty"`Members *string `json:"members,omitempty"`OrganizationAdministration *string `json:"organization_administration,omitempty"`OrganizationHooks *string `json:"organization_hooks,omitempty"`OrganizationPlan *string `json:"organization_plan,omitempty"`OrganizationPreReceiveHooks *string `json:"organization_pre_receive_hooks,omitempty"`OrganizationProjects *string `json:"organization_projects,omitempty"`OrganizationSecrets *string `json:"organization_secrets,omitempty"`OrganizationSelfHostedRunners *string `json:"organization_self_hosted_runners,omitempty"`OrganizationUserBlocking *string `json:"organization_user_blocking,omitempty"`Packages *string `json:"packages,omitempty"`Pages *string `json:"pages,omitempty"`PullRequests *string `json:"pull_requests,omitempty"`RepositoryHooks *string `json:"repository_hooks,omitempty"`RepositoryProjects *string `json:"repository_projects,omitempty"`RepositoryPreReceiveHooks *string `json:"repository_pre_receive_hooks,omitempty"`Secrets *string `json:"secrets,omitempty"`SecretScanningAlerts *string `json:"secret_scanning_alerts,omitempty"`SecurityEvents *string `json:"security_events,omitempty"`SingleFile *string `json:"single_file,omitempty"`Statuses *string `json:"statuses,omitempty"`TeamDiscussions *string `json:"team_discussions,omitempty"`VulnerabilityAlerts *string `json:"vulnerability_alerts,omitempty"`Workflows *string `json:"workflows,omitempty"`}
InstallationPermissions lists the repository and organization permissions for an installation.
Permission names taken from:
https://docs.github.com/en/enterprise-server@3.0/rest/reference/apps#create-an-installation-access-token-for-an-apphttps://docs.github.com/en/rest/reference/apps#create-an-installation-access-token-for-an-app
func (*InstallationPermissions)GetActions¶
func (i *InstallationPermissions) GetActions()string
GetActions returns the Actions field if it's non-nil, zero value otherwise.
func (*InstallationPermissions)GetAdministration¶
func (i *InstallationPermissions) GetAdministration()string
GetAdministration returns the Administration field if it's non-nil, zero value otherwise.
func (*InstallationPermissions)GetBlocking¶
func (i *InstallationPermissions) GetBlocking()string
GetBlocking returns the Blocking field if it's non-nil, zero value otherwise.
func (*InstallationPermissions)GetChecks¶
func (i *InstallationPermissions) GetChecks()string
GetChecks returns the Checks field if it's non-nil, zero value otherwise.
func (*InstallationPermissions)GetContentReferences¶
func (i *InstallationPermissions) GetContentReferences()string
GetContentReferences returns the ContentReferences field if it's non-nil, zero value otherwise.
func (*InstallationPermissions)GetContents¶
func (i *InstallationPermissions) GetContents()string
GetContents returns the Contents field if it's non-nil, zero value otherwise.
func (*InstallationPermissions)GetDeployments¶
func (i *InstallationPermissions) GetDeployments()string
GetDeployments returns the Deployments field if it's non-nil, zero value otherwise.
func (*InstallationPermissions)GetEmails¶
func (i *InstallationPermissions) GetEmails()string
GetEmails returns the Emails field if it's non-nil, zero value otherwise.
func (*InstallationPermissions)GetEnvironments¶
func (i *InstallationPermissions) GetEnvironments()string
GetEnvironments returns the Environments field if it's non-nil, zero value otherwise.
func (*InstallationPermissions)GetFollowers¶
func (i *InstallationPermissions) GetFollowers()string
GetFollowers returns the Followers field if it's non-nil, zero value otherwise.
func (*InstallationPermissions)GetIssues¶
func (i *InstallationPermissions) GetIssues()string
GetIssues returns the Issues field if it's non-nil, zero value otherwise.
func (*InstallationPermissions)GetMembers¶
func (i *InstallationPermissions) GetMembers()string
GetMembers returns the Members field if it's non-nil, zero value otherwise.
func (*InstallationPermissions)GetMetadata¶
func (i *InstallationPermissions) GetMetadata()string
GetMetadata returns the Metadata field if it's non-nil, zero value otherwise.
func (*InstallationPermissions)GetOrganizationAdministration¶
func (i *InstallationPermissions) GetOrganizationAdministration()string
GetOrganizationAdministration returns the OrganizationAdministration field if it's non-nil, zero value otherwise.
func (*InstallationPermissions)GetOrganizationHooks¶
func (i *InstallationPermissions) GetOrganizationHooks()string
GetOrganizationHooks returns the OrganizationHooks field if it's non-nil, zero value otherwise.
func (*InstallationPermissions)GetOrganizationPlan¶
func (i *InstallationPermissions) GetOrganizationPlan()string
GetOrganizationPlan returns the OrganizationPlan field if it's non-nil, zero value otherwise.
func (*InstallationPermissions)GetOrganizationPreReceiveHooks¶
func (i *InstallationPermissions) GetOrganizationPreReceiveHooks()string
GetOrganizationPreReceiveHooks returns the OrganizationPreReceiveHooks field if it's non-nil, zero value otherwise.
func (*InstallationPermissions)GetOrganizationProjects¶
func (i *InstallationPermissions) GetOrganizationProjects()string
GetOrganizationProjects returns the OrganizationProjects field if it's non-nil, zero value otherwise.
func (*InstallationPermissions)GetOrganizationSecrets¶
func (i *InstallationPermissions) GetOrganizationSecrets()string
GetOrganizationSecrets returns the OrganizationSecrets field if it's non-nil, zero value otherwise.
func (*InstallationPermissions)GetOrganizationSelfHostedRunners¶
func (i *InstallationPermissions) GetOrganizationSelfHostedRunners()string
GetOrganizationSelfHostedRunners returns the OrganizationSelfHostedRunners field if it's non-nil, zero value otherwise.
func (*InstallationPermissions)GetOrganizationUserBlocking¶
func (i *InstallationPermissions) GetOrganizationUserBlocking()string
GetOrganizationUserBlocking returns the OrganizationUserBlocking field if it's non-nil, zero value otherwise.
func (*InstallationPermissions)GetPackages¶
func (i *InstallationPermissions) GetPackages()string
GetPackages returns the Packages field if it's non-nil, zero value otherwise.
func (*InstallationPermissions)GetPages¶
func (i *InstallationPermissions) GetPages()string
GetPages returns the Pages field if it's non-nil, zero value otherwise.
func (*InstallationPermissions)GetPullRequests¶
func (i *InstallationPermissions) GetPullRequests()string
GetPullRequests returns the PullRequests field if it's non-nil, zero value otherwise.
func (*InstallationPermissions)GetRepositoryHooks¶
func (i *InstallationPermissions) GetRepositoryHooks()string
GetRepositoryHooks returns the RepositoryHooks field if it's non-nil, zero value otherwise.
func (*InstallationPermissions)GetRepositoryPreReceiveHooks¶
func (i *InstallationPermissions) GetRepositoryPreReceiveHooks()string
GetRepositoryPreReceiveHooks returns the RepositoryPreReceiveHooks field if it's non-nil, zero value otherwise.
func (*InstallationPermissions)GetRepositoryProjects¶
func (i *InstallationPermissions) GetRepositoryProjects()string
GetRepositoryProjects returns the RepositoryProjects field if it's non-nil, zero value otherwise.
func (*InstallationPermissions)GetSecretScanningAlerts¶
func (i *InstallationPermissions) GetSecretScanningAlerts()string
GetSecretScanningAlerts returns the SecretScanningAlerts field if it's non-nil, zero value otherwise.
func (*InstallationPermissions)GetSecrets¶
func (i *InstallationPermissions) GetSecrets()string
GetSecrets returns the Secrets field if it's non-nil, zero value otherwise.
func (*InstallationPermissions)GetSecurityEvents¶
func (i *InstallationPermissions) GetSecurityEvents()string
GetSecurityEvents returns the SecurityEvents field if it's non-nil, zero value otherwise.
func (*InstallationPermissions)GetSingleFile¶
func (i *InstallationPermissions) GetSingleFile()string
GetSingleFile returns the SingleFile field if it's non-nil, zero value otherwise.
func (*InstallationPermissions)GetStatuses¶
func (i *InstallationPermissions) GetStatuses()string
GetStatuses returns the Statuses field if it's non-nil, zero value otherwise.
func (*InstallationPermissions)GetTeamDiscussions¶
func (i *InstallationPermissions) GetTeamDiscussions()string
GetTeamDiscussions returns the TeamDiscussions field if it's non-nil, zero value otherwise.
func (*InstallationPermissions)GetVulnerabilityAlerts¶
func (i *InstallationPermissions) GetVulnerabilityAlerts()string
GetVulnerabilityAlerts returns the VulnerabilityAlerts field if it's non-nil, zero value otherwise.
func (*InstallationPermissions)GetWorkflows¶
func (i *InstallationPermissions) GetWorkflows()string
GetWorkflows returns the Workflows field if it's non-nil, zero value otherwise.
typeInstallationRepositoriesEvent¶
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 orremoved from an installation. The Webhook event name is "installation_repositories".
GitHub API docs:https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#installation_repositories
func (*InstallationRepositoriesEvent)GetAction¶
func (i *InstallationRepositoriesEvent) GetAction()string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*InstallationRepositoriesEvent)GetInstallation¶
func (i *InstallationRepositoriesEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*InstallationRepositoriesEvent)GetRepositorySelection¶
func (i *InstallationRepositoriesEvent) GetRepositorySelection()string
GetRepositorySelection returns the RepositorySelection field if it's non-nil, zero value otherwise.
func (*InstallationRepositoriesEvent)GetSender¶
func (i *InstallationRepositoriesEvent) GetSender() *User
GetSender returns the Sender field.
typeInstallationToken¶
type InstallationToken struct {Token *string `json:"token,omitempty"`ExpiresAt *time.Time `json:"expires_at,omitempty"`Permissions *InstallationPermissions `json:"permissions,omitempty"`Repositories []*Repository `json:"repositories,omitempty"`}
InstallationToken represents an installation token.
func (*InstallationToken)GetExpiresAt¶
func (i *InstallationToken) GetExpiresAt()time.Time
GetExpiresAt returns the ExpiresAt field if it's non-nil, zero value otherwise.
func (*InstallationToken)GetPermissions¶
func (i *InstallationToken) GetPermissions() *InstallationPermissions
GetPermissions returns the Permissions field.
func (*InstallationToken)GetToken¶
func (i *InstallationToken) GetToken()string
GetToken returns the Token field if it's non-nil, zero value otherwise.
typeInstallationTokenOptions¶
type InstallationTokenOptions struct {// The IDs of the repositories that the installation token can access.// Providing repository IDs restricts the access of an installation token to specific repositories.RepositoryIDs []int64 `json:"repository_ids,omitempty"`// The names of the repositories that the installation token can access.// Providing repository names restricts the access of an installation token to specific repositories.Repositories []string `json:"repositories,omitempty"`// The permissions granted to the access token.// The permissions object includes the permission names and their access type.Permissions *InstallationPermissions `json:"permissions,omitempty"`}
InstallationTokenOptions allow restricting a token's access to specific repositories.
func (*InstallationTokenOptions)GetPermissions¶
func (i *InstallationTokenOptions) GetPermissions() *InstallationPermissions
GetPermissions returns the Permissions field.
typeInteractionRestriction¶
type InteractionRestriction struct {// Specifies the group of GitHub users who can// comment, open issues, or create pull requests for the given repository.// Possible values are: "existing_users", "contributors_only" and "collaborators_only".Limit *string `json:"limit,omitempty"`// Origin specifies the type of the resource to interact with.// Possible values are: "repository" and "organization".Origin *string `json:"origin,omitempty"`// ExpiresAt specifies the time after which the interaction restrictions expire.// The default expiry time is 24 hours from the time restriction is created.ExpiresAt *Timestamp `json:"expires_at,omitempty"`}
InteractionRestriction represents the interaction restrictions for repository and organization.
func (*InteractionRestriction)GetExpiresAt¶
func (i *InteractionRestriction) GetExpiresAt()Timestamp
GetExpiresAt returns the ExpiresAt field if it's non-nil, zero value otherwise.
func (*InteractionRestriction)GetLimit¶
func (i *InteractionRestriction) GetLimit()string
GetLimit returns the Limit field if it's non-nil, zero value otherwise.
func (*InteractionRestriction)GetOrigin¶
func (i *InteractionRestriction) GetOrigin()string
GetOrigin returns the Origin field if it's non-nil, zero value otherwise.
typeInteractionsService¶
type InteractionsService service
InteractionsService handles communication with the repository and organization relatedmethods of the GitHub API.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/interactions/
func (*InteractionsService)GetRestrictionsForOrg¶
func (s *InteractionsService) GetRestrictionsForOrg(ctxcontext.Context, organizationstring) (*InteractionRestriction, *Response,error)
GetRestrictionsForOrg fetches the interaction restrictions for an organization.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/interactions/#get-interaction-restrictions-for-an-organization
func (*InteractionsService)GetRestrictionsForRepo¶
func (s *InteractionsService) GetRestrictionsForRepo(ctxcontext.Context, owner, repostring) (*InteractionRestriction, *Response,error)
GetRestrictionsForRepo fetches the interaction restrictions for a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/interactions/#get-interaction-restrictions-for-a-repository
func (*InteractionsService)RemoveRestrictionsFromOrg¶
func (s *InteractionsService) RemoveRestrictionsFromOrg(ctxcontext.Context, organizationstring) (*Response,error)
RemoveRestrictionsFromOrg removes the interaction restrictions for an organization.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/interactions/#remove-interaction-restrictions-for-an-organization
func (*InteractionsService)RemoveRestrictionsFromRepo¶
func (s *InteractionsService) RemoveRestrictionsFromRepo(ctxcontext.Context, owner, repostring) (*Response,error)
RemoveRestrictionsFromRepo removes the interaction restrictions for a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/interactions/#remove-interaction-restrictions-for-a-repository
func (*InteractionsService)UpdateRestrictionsForOrg¶
func (s *InteractionsService) UpdateRestrictionsForOrg(ctxcontext.Context, organization, limitstring) (*InteractionRestriction, *Response,error)
UpdateRestrictionsForOrg adds or updates the interaction restrictions for an organization.
limit specifies the group of GitHub users who can comment, open issues, or create pull requestsin public repositories for the given organization.Possible values are: "existing_users", "contributors_only", "collaborators_only".
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/interactions/#set-interaction-restrictions-for-an-organization
func (*InteractionsService)UpdateRestrictionsForRepo¶
func (s *InteractionsService) UpdateRestrictionsForRepo(ctxcontext.Context, owner, repo, limitstring) (*InteractionRestriction, *Response,error)
UpdateRestrictionsForRepo adds or updates the interaction restrictions for a repository.
limit specifies the group of GitHub users who can comment, open issues, or create pull requestsfor the given repository.Possible values are: "existing_users", "contributors_only", "collaborators_only".
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/interactions/#set-interaction-restrictions-for-a-repository
typeInvitation¶
type Invitation struct {ID *int64 `json:"id,omitempty"`NodeID *string `json:"node_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"`FailedAt *Timestamp `json:"failed_at,omitempty"`FailedReason *string `json:"failed_reason,omitempty"`}
Invitation represents a team member's invitation status.
func (*Invitation)GetCreatedAt¶
func (i *Invitation) GetCreatedAt()time.Time
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*Invitation)GetEmail¶
func (i *Invitation) GetEmail()string
GetEmail returns the Email field if it's non-nil, zero value otherwise.
func (*Invitation)GetFailedAt¶
func (i *Invitation) GetFailedAt()Timestamp
GetFailedAt returns the FailedAt field if it's non-nil, zero value otherwise.
func (*Invitation)GetFailedReason¶
func (i *Invitation) GetFailedReason()string
GetFailedReason returns the FailedReason field if it's non-nil, zero value otherwise.
func (*Invitation)GetID¶
func (i *Invitation) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*Invitation)GetInvitationTeamURL¶
func (i *Invitation) GetInvitationTeamURL()string
GetInvitationTeamURL returns the InvitationTeamURL field if it's non-nil, zero value otherwise.
func (*Invitation)GetInviter¶
func (i *Invitation) GetInviter() *User
GetInviter returns the Inviter field.
func (*Invitation)GetLogin¶
func (i *Invitation) GetLogin()string
GetLogin returns the Login field if it's non-nil, zero value otherwise.
func (*Invitation)GetNodeID¶
func (i *Invitation) GetNodeID()string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (*Invitation)GetRole¶
func (i *Invitation) GetRole()string
GetRole returns the Role field if it's non-nil, zero value otherwise.
func (*Invitation)GetTeamCount¶
func (i *Invitation) GetTeamCount()int
GetTeamCount returns the TeamCount field if it's non-nil, zero value otherwise.
func (Invitation)String¶
func (iInvitation) String()string
typeIssue¶
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"`AuthorAssociation *string `json:"author_association,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 andhttps://docs.github.com/en/free-pro-team@latest/rest/reference/search/#text-match-metadataTextMatches []*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 webhooksmay 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 (*Issue)GetActiveLockReason¶
GetActiveLockReason returns the ActiveLockReason field if it's non-nil, zero value otherwise.
func (*Issue)GetAuthorAssociation¶
GetAuthorAssociation returns the AuthorAssociation field if it's non-nil, zero value otherwise.
func (*Issue)GetClosedAt¶
GetClosedAt returns the ClosedAt field if it's non-nil, zero value otherwise.
func (*Issue)GetComments¶
GetComments returns the Comments field if it's non-nil, zero value otherwise.
func (*Issue)GetCommentsURL¶
GetCommentsURL returns the CommentsURL field if it's non-nil, zero value otherwise.
func (*Issue)GetCreatedAt¶
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*Issue)GetEventsURL¶
GetEventsURL returns the EventsURL field if it's non-nil, zero value otherwise.
func (*Issue)GetHTMLURL¶
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*Issue)GetLabelsURL¶
GetLabelsURL returns the LabelsURL field if it's non-nil, zero value otherwise.
func (*Issue)GetMilestone¶
GetMilestone returns the Milestone field.
func (*Issue)GetPullRequestLinks¶
func (i *Issue) GetPullRequestLinks() *PullRequestLinks
GetPullRequestLinks returns the PullRequestLinks field.
func (*Issue)GetReactions¶
GetReactions returns the Reactions field.
func (*Issue)GetRepository¶
func (i *Issue) GetRepository() *Repository
GetRepository returns the Repository field.
func (*Issue)GetRepositoryURL¶
GetRepositoryURL returns the RepositoryURL field if it's non-nil, zero value otherwise.
func (*Issue)GetUpdatedAt¶
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (Issue)IsPullRequest¶
IsPullRequest reports whether the issue is also a pull request. It uses themethod recommended by GitHub's API documentation, which is to check whetherPullRequestLinks is non-nil.
typeIssueComment¶
type IssueComment struct {ID *int64 `json:"id,omitempty"`NodeID *string `json:"node_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 (*IssueComment)GetAuthorAssociation¶
func (i *IssueComment) GetAuthorAssociation()string
GetAuthorAssociation returns the AuthorAssociation field if it's non-nil, zero value otherwise.
func (*IssueComment)GetBody¶
func (i *IssueComment) GetBody()string
GetBody returns the Body field if it's non-nil, zero value otherwise.
func (*IssueComment)GetCreatedAt¶
func (i *IssueComment) GetCreatedAt()time.Time
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*IssueComment)GetHTMLURL¶
func (i *IssueComment) GetHTMLURL()string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*IssueComment)GetID¶
func (i *IssueComment) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*IssueComment)GetIssueURL¶
func (i *IssueComment) GetIssueURL()string
GetIssueURL returns the IssueURL field if it's non-nil, zero value otherwise.
func (*IssueComment)GetNodeID¶
func (i *IssueComment) GetNodeID()string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (*IssueComment)GetReactions¶
func (i *IssueComment) GetReactions() *Reactions
GetReactions returns the Reactions field.
func (*IssueComment)GetURL¶
func (i *IssueComment) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (*IssueComment)GetUpdatedAt¶
func (i *IssueComment) GetUpdatedAt()time.Time
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (IssueComment)String¶
func (iIssueComment) String()string
typeIssueCommentEvent¶
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"`// The following field is only present when the webhook is triggered on// a repository belonging to an organization.Organization *Organization `json:"organization,omitempty"`}
IssueCommentEvent is triggered when an issue comment is created on an issueor pull request.The Webhook event name is "issue_comment".
GitHub API docs:https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#issue_comment
func (*IssueCommentEvent)GetAction¶
func (i *IssueCommentEvent) GetAction()string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*IssueCommentEvent)GetChanges¶
func (i *IssueCommentEvent) GetChanges() *EditChange
GetChanges returns the Changes field.
func (*IssueCommentEvent)GetComment¶
func (i *IssueCommentEvent) GetComment() *IssueComment
GetComment returns the Comment field.
func (*IssueCommentEvent)GetInstallation¶
func (i *IssueCommentEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*IssueCommentEvent)GetIssue¶
func (i *IssueCommentEvent) GetIssue() *Issue
GetIssue returns the Issue field.
func (*IssueCommentEvent)GetOrganization¶
func (i *IssueCommentEvent) GetOrganization() *Organization
GetOrganization returns the Organization field.
func (*IssueCommentEvent)GetRepo¶
func (i *IssueCommentEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (*IssueCommentEvent)GetSender¶
func (i *IssueCommentEvent) GetSender() *User
GetSender returns the Sender field.
typeIssueEvent¶
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.//// review_dismissed// The review was dismissed and `DismissedReview` will be populated below.//// review_requested, review_request_removed// The Actor requested or removed the request for a review.// RequestedReviewer and ReviewRequester will be populated below.//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"`ProjectCard *ProjectCard `json:"project_card,omitempty"`DismissedReview *DismissedReview `json:"dismissed_review,omitempty"`RequestedReviewer *User `json:"requested_reviewer,omitempty"`ReviewRequester *User `json:"review_requester,omitempty"`}
IssueEvent represents an event that occurred around an Issue or Pull Request.
func (*IssueEvent)GetAssignee¶
func (i *IssueEvent) GetAssignee() *User
GetAssignee returns the Assignee field.
func (*IssueEvent)GetAssigner¶
func (i *IssueEvent) GetAssigner() *User
GetAssigner returns the Assigner field.
func (*IssueEvent)GetCommitID¶
func (i *IssueEvent) GetCommitID()string
GetCommitID returns the CommitID field if it's non-nil, zero value otherwise.
func (*IssueEvent)GetCreatedAt¶
func (i *IssueEvent) GetCreatedAt()time.Time
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*IssueEvent)GetDismissedReview¶
func (i *IssueEvent) GetDismissedReview() *DismissedReview
GetDismissedReview returns the DismissedReview field.
func (*IssueEvent)GetEvent¶
func (i *IssueEvent) GetEvent()string
GetEvent returns the Event field if it's non-nil, zero value otherwise.
func (*IssueEvent)GetID¶
func (i *IssueEvent) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*IssueEvent)GetLockReason¶
func (i *IssueEvent) GetLockReason()string
GetLockReason returns the LockReason field if it's non-nil, zero value otherwise.
func (*IssueEvent)GetMilestone¶
func (i *IssueEvent) GetMilestone() *Milestone
GetMilestone returns the Milestone field.
func (*IssueEvent)GetProjectCard¶
func (i *IssueEvent) GetProjectCard() *ProjectCard
GetProjectCard returns the ProjectCard field.
func (*IssueEvent)GetRename¶
func (i *IssueEvent) GetRename() *Rename
GetRename returns the Rename field.
func (*IssueEvent)GetRequestedReviewer¶
func (i *IssueEvent) GetRequestedReviewer() *User
GetRequestedReviewer returns the RequestedReviewer field.
func (*IssueEvent)GetReviewRequester¶
func (i *IssueEvent) GetReviewRequester() *User
GetReviewRequester returns the ReviewRequester field.
func (*IssueEvent)GetURL¶
func (i *IssueEvent) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
typeIssueImport¶
type IssueImport struct {Titlestring `json:"title"`Bodystring `json:"body"`CreatedAt *time.Time `json:"created_at,omitempty"`ClosedAt *time.Time `json:"closed_at,omitempty"`UpdatedAt *time.Time `json:"updated_at,omitempty"`Assignee *string `json:"assignee,omitempty"`Milestone *int `json:"milestone,omitempty"`Closed *bool `json:"closed,omitempty"`Labels []string `json:"labels,omitempty"`}
IssueImport represents body of issue to import.
func (*IssueImport)GetAssignee¶
func (i *IssueImport) GetAssignee()string
GetAssignee returns the Assignee field if it's non-nil, zero value otherwise.
func (*IssueImport)GetClosed¶
func (i *IssueImport) GetClosed()bool
GetClosed returns the Closed field if it's non-nil, zero value otherwise.
func (*IssueImport)GetClosedAt¶
func (i *IssueImport) GetClosedAt()time.Time
GetClosedAt returns the ClosedAt field if it's non-nil, zero value otherwise.
func (*IssueImport)GetCreatedAt¶
func (i *IssueImport) GetCreatedAt()time.Time
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*IssueImport)GetMilestone¶
func (i *IssueImport) GetMilestone()int
GetMilestone returns the Milestone field if it's non-nil, zero value otherwise.
func (*IssueImport)GetUpdatedAt¶
func (i *IssueImport) GetUpdatedAt()time.Time
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
typeIssueImportError¶
type IssueImportError struct {Location *string `json:"location,omitempty"`Resource *string `json:"resource,omitempty"`Field *string `json:"field,omitempty"`Value *string `json:"value,omitempty"`Code *string `json:"code,omitempty"`}
IssueImportError represents errors of an issue import create request.
func (*IssueImportError)GetCode¶
func (i *IssueImportError) GetCode()string
GetCode returns the Code field if it's non-nil, zero value otherwise.
func (*IssueImportError)GetField¶
func (i *IssueImportError) GetField()string
GetField returns the Field field if it's non-nil, zero value otherwise.
func (*IssueImportError)GetLocation¶
func (i *IssueImportError) GetLocation()string
GetLocation returns the Location field if it's non-nil, zero value otherwise.
func (*IssueImportError)GetResource¶
func (i *IssueImportError) GetResource()string
GetResource returns the Resource field if it's non-nil, zero value otherwise.
func (*IssueImportError)GetValue¶
func (i *IssueImportError) GetValue()string
GetValue returns the Value field if it's non-nil, zero value otherwise.
typeIssueImportRequest¶
type IssueImportRequest struct {IssueImportIssueImport `json:"issue"`Comments []*Comment `json:"comments,omitempty"`}
IssueImportRequest represents a request to create an issue.
https://gist.github.com/jonmagic/5282384165e0f86ef105#supported-issue-and-comment-fields
typeIssueImportResponse¶
type IssueImportResponse struct {ID *int `json:"id,omitempty"`Status *string `json:"status,omitempty"`URL *string `json:"url,omitempty"`ImportIssuesURL *string `json:"import_issues_url,omitempty"`RepositoryURL *string `json:"repository_url,omitempty"`CreatedAt *time.Time `json:"created_at,omitempty"`UpdatedAt *time.Time `json:"updated_at,omitempty"`Message *string `json:"message,omitempty"`DocumentationURL *string `json:"documentation_url,omitempty"`Errors []*IssueImportError `json:"errors,omitempty"`}
IssueImportResponse represents the response of an issue import create request.
https://gist.github.com/jonmagic/5282384165e0f86ef105#import-issue-response
func (*IssueImportResponse)GetCreatedAt¶
func (i *IssueImportResponse) GetCreatedAt()time.Time
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*IssueImportResponse)GetDocumentationURL¶
func (i *IssueImportResponse) GetDocumentationURL()string
GetDocumentationURL returns the DocumentationURL field if it's non-nil, zero value otherwise.
func (*IssueImportResponse)GetID¶
func (i *IssueImportResponse) GetID()int
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*IssueImportResponse)GetImportIssuesURL¶
func (i *IssueImportResponse) GetImportIssuesURL()string
GetImportIssuesURL returns the ImportIssuesURL field if it's non-nil, zero value otherwise.
func (*IssueImportResponse)GetMessage¶
func (i *IssueImportResponse) GetMessage()string
GetMessage returns the Message field if it's non-nil, zero value otherwise.
func (*IssueImportResponse)GetRepositoryURL¶
func (i *IssueImportResponse) GetRepositoryURL()string
GetRepositoryURL returns the RepositoryURL field if it's non-nil, zero value otherwise.
func (*IssueImportResponse)GetStatus¶
func (i *IssueImportResponse) GetStatus()string
GetStatus returns the Status field if it's non-nil, zero value otherwise.
func (*IssueImportResponse)GetURL¶
func (i *IssueImportResponse) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (*IssueImportResponse)GetUpdatedAt¶
func (i *IssueImportResponse) GetUpdatedAt()time.Time
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
typeIssueImportService¶
type IssueImportService service
IssueImportService handles communication with the issue import relatedmethods of the Issue Import GitHub API.
func (*IssueImportService)CheckStatus¶
func (s *IssueImportService) CheckStatus(ctxcontext.Context, owner, repostring, issueIDint64) (*IssueImportResponse, *Response,error)
CheckStatus checks the status of an imported issue.
https://gist.github.com/jonmagic/5282384165e0f86ef105#import-status-request
func (*IssueImportService)CheckStatusSince¶
func (s *IssueImportService) CheckStatusSince(ctxcontext.Context, owner, repostring, sincetime.Time) ([]*IssueImportResponse, *Response,error)
CheckStatusSince checks the status of multiple imported issues since a given date.
https://gist.github.com/jonmagic/5282384165e0f86ef105#check-status-of-multiple-issues
func (*IssueImportService)Create¶
func (s *IssueImportService) Create(ctxcontext.Context, owner, repostring, issue *IssueImportRequest) (*IssueImportResponse, *Response,error)
Create a new imported issue on the specified repository.
https://gist.github.com/jonmagic/5282384165e0f86ef105#start-an-issue-import
typeIssueListByRepoOptions¶
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.Milestonestring `url:"milestone,omitempty"`// State filters issues based on their state. Possible values are: open,// closed, all. Default is "open".Statestring `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.Assigneestring `url:"assignee,omitempty"`// Creator filters issues based on their creator.Creatorstring `url:"creator,omitempty"`// Mentioned filters issues to those mentioned a specific user.Mentionedstring `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".Sortstring `url:"sort,omitempty"`// Direction in which to sort issues. Possible values are: asc, desc.// Default is "desc".Directionstring `url:"direction,omitempty"`// Since filters issues by time.Sincetime.Time `url:"since,omitempty"`ListOptions}
IssueListByRepoOptions specifies the optional parameters to theIssuesService.ListByRepo method.
typeIssueListCommentsOptions¶
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 theIssuesService.ListComments method.
func (*IssueListCommentsOptions)GetDirection¶
func (i *IssueListCommentsOptions) GetDirection()string
GetDirection returns the Direction field if it's non-nil, zero value otherwise.
func (*IssueListCommentsOptions)GetSince¶
func (i *IssueListCommentsOptions) GetSince()time.Time
GetSince returns the Since field if it's non-nil, zero value otherwise.
func (*IssueListCommentsOptions)GetSort¶
func (i *IssueListCommentsOptions) GetSort()string
GetSort returns the Sort field if it's non-nil, zero value otherwise.
typeIssueListOptions¶
type IssueListOptions struct {// Filter specifies which issues to list. Possible values are: assigned,// created, mentioned, subscribed, all. Default is "assigned".Filterstring `url:"filter,omitempty"`// State filters issues based on their state. Possible values are: open,// closed, all. Default is "open".Statestring `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".Sortstring `url:"sort,omitempty"`// Direction in which to sort issues. Possible values are: asc, desc.// Default is "desc".Directionstring `url:"direction,omitempty"`// Since filters issues by time.Sincetime.Time `url:"since,omitempty"`ListOptions}
IssueListOptions specifies the optional parameters to the IssuesService.Listand IssuesService.ListByOrg methods.
typeIssueRequest¶
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 Labelsand Assignee fail to serialize to the correct JSON.
func (*IssueRequest)GetAssignee¶
func (i *IssueRequest) GetAssignee()string
GetAssignee returns the Assignee field if it's non-nil, zero value otherwise.
func (*IssueRequest)GetAssignees¶
func (i *IssueRequest) GetAssignees() []string
GetAssignees returns the Assignees field if it's non-nil, zero value otherwise.
func (*IssueRequest)GetBody¶
func (i *IssueRequest) GetBody()string
GetBody returns the Body field if it's non-nil, zero value otherwise.
func (*IssueRequest)GetLabels¶
func (i *IssueRequest) GetLabels() []string
GetLabels returns the Labels field if it's non-nil, zero value otherwise.
func (*IssueRequest)GetMilestone¶
func (i *IssueRequest) GetMilestone()int
GetMilestone returns the Milestone field if it's non-nil, zero value otherwise.
func (*IssueRequest)GetState¶
func (i *IssueRequest) GetState()string
GetState returns the State field if it's non-nil, zero value otherwise.
func (*IssueRequest)GetTitle¶
func (i *IssueRequest) GetTitle()string
GetTitle returns the Title field if it's non-nil, zero value otherwise.
typeIssueStats¶
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 (*IssueStats)GetClosedIssues¶
func (i *IssueStats) GetClosedIssues()int
GetClosedIssues returns the ClosedIssues field if it's non-nil, zero value otherwise.
func (*IssueStats)GetOpenIssues¶
func (i *IssueStats) GetOpenIssues()int
GetOpenIssues returns the OpenIssues field if it's non-nil, zero value otherwise.
func (*IssueStats)GetTotalIssues¶
func (i *IssueStats) GetTotalIssues()int
GetTotalIssues returns the TotalIssues field if it's non-nil, zero value otherwise.
func (IssueStats)String¶
func (sIssueStats) String()string
typeIssuesEvent¶
type IssuesEvent struct {// Action is the action that was performed. Possible values are: "opened",// "edited", "deleted", "transferred", "pinned", "unpinned", "closed", "reopened",// "assigned", "unassigned", "labeled", "unlabeled", "locked", "unlocked",// "milestoned", or "demilestoned".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 opened, edited, deleted, transferred,pinned, unpinned, closed, reopened, assigned, unassigned, labeled, unlabeled,locked, unlocked, milestoned, or demilestoned.The Webhook event name is "issues".
GitHub API docs:https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#issues
func (*IssuesEvent)GetAction¶
func (i *IssuesEvent) GetAction()string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*IssuesEvent)GetAssignee¶
func (i *IssuesEvent) GetAssignee() *User
GetAssignee returns the Assignee field.
func (*IssuesEvent)GetChanges¶
func (i *IssuesEvent) GetChanges() *EditChange
GetChanges returns the Changes field.
func (*IssuesEvent)GetInstallation¶
func (i *IssuesEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*IssuesEvent)GetIssue¶
func (i *IssuesEvent) GetIssue() *Issue
GetIssue returns the Issue field.
func (*IssuesEvent)GetLabel¶
func (i *IssuesEvent) GetLabel() *Label
GetLabel returns the Label field.
func (*IssuesEvent)GetRepo¶
func (i *IssuesEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (*IssuesEvent)GetSender¶
func (i *IssuesEvent) GetSender() *User
GetSender returns the Sender field.
typeIssuesSearchResult¶
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 (*IssuesSearchResult)GetIncompleteResults¶
func (i *IssuesSearchResult) GetIncompleteResults()bool
GetIncompleteResults returns the IncompleteResults field if it's non-nil, zero value otherwise.
func (*IssuesSearchResult)GetTotal¶
func (i *IssuesSearchResult) GetTotal()int
GetTotal returns the Total field if it's non-nil, zero value otherwise.
typeIssuesService¶
type IssuesService service
IssuesService handles communication with the issue relatedmethods of the GitHub API.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/issues/
func (*IssuesService)AddAssignees¶
func (s *IssuesService) AddAssignees(ctxcontext.Context, owner, repostring, numberint, assignees []string) (*Issue, *Response,error)
AddAssignees adds the provided GitHub users as assignees to the issue.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/issues/#add-assignees-to-an-issue
func (*IssuesService)AddLabelsToIssue¶
func (s *IssuesService) AddLabelsToIssue(ctxcontext.Context, ownerstring, repostring, numberint, labels []string) ([]*Label, *Response,error)
AddLabelsToIssue adds labels to an issue.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/issues/#add-labels-to-an-issue
func (*IssuesService)Create¶
func (s *IssuesService) Create(ctxcontext.Context, ownerstring, repostring, issue *IssueRequest) (*Issue, *Response,error)
Create a new issue on the specified repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/issues/#create-an-issue
func (*IssuesService)CreateComment¶
func (s *IssuesService) CreateComment(ctxcontext.Context, ownerstring, repostring, numberint, comment *IssueComment) (*IssueComment, *Response,error)
CreateComment creates a new comment on the specified issue.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/issues/#create-an-issue-comment
func (*IssuesService)CreateLabel¶
func (s *IssuesService) CreateLabel(ctxcontext.Context, ownerstring, repostring, label *Label) (*Label, *Response,error)
CreateLabel creates a new label on the specified repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/issues/#create-a-label
func (*IssuesService)CreateMilestone¶
func (s *IssuesService) CreateMilestone(ctxcontext.Context, ownerstring, repostring, milestone *Milestone) (*Milestone, *Response,error)
CreateMilestone creates a new milestone on the specified repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/issues/#create-a-milestone
func (*IssuesService)DeleteComment¶
func (s *IssuesService) DeleteComment(ctxcontext.Context, ownerstring, repostring, commentIDint64) (*Response,error)
DeleteComment deletes an issue comment.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/issues/#delete-an-issue-comment
func (*IssuesService)DeleteLabel¶
func (s *IssuesService) DeleteLabel(ctxcontext.Context, ownerstring, repostring, namestring) (*Response,error)
DeleteLabel deletes a label.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/issues/#delete-a-label
func (*IssuesService)DeleteMilestone¶
func (s *IssuesService) DeleteMilestone(ctxcontext.Context, ownerstring, repostring, numberint) (*Response,error)
DeleteMilestone deletes a milestone.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/issues/#delete-a-milestone
func (*IssuesService)Edit¶
func (s *IssuesService) Edit(ctxcontext.Context, ownerstring, repostring, numberint, issue *IssueRequest) (*Issue, *Response,error)
Edit an issue.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/issues/#update-an-issue
func (*IssuesService)EditComment¶
func (s *IssuesService) EditComment(ctxcontext.Context, ownerstring, repostring, commentIDint64, 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://docs.github.com/en/free-pro-team@latest/rest/reference/issues/#update-an-issue-comment
func (*IssuesService)EditLabel¶
func (s *IssuesService) EditLabel(ctxcontext.Context, ownerstring, repostring, namestring, label *Label) (*Label, *Response,error)
EditLabel edits a label.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/issues/#update-a-label
func (*IssuesService)EditMilestone¶
func (s *IssuesService) EditMilestone(ctxcontext.Context, ownerstring, repostring, numberint, milestone *Milestone) (*Milestone, *Response,error)
EditMilestone edits a milestone.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/issues/#update-a-milestone
func (*IssuesService)Get¶
func (s *IssuesService) Get(ctxcontext.Context, ownerstring, repostring, numberint) (*Issue, *Response,error)
Get a single issue.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/issues/#get-an-issue
func (*IssuesService)GetComment¶
func (s *IssuesService) GetComment(ctxcontext.Context, ownerstring, repostring, commentIDint64) (*IssueComment, *Response,error)
GetComment fetches the specified issue comment.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/issues/#get-an-issue-comment
func (*IssuesService)GetEvent¶
func (s *IssuesService) GetEvent(ctxcontext.Context, owner, repostring, idint64) (*IssueEvent, *Response,error)
GetEvent returns the specified issue event.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/issues/#get-an-issue-event
func (*IssuesService)GetLabel¶
func (s *IssuesService) GetLabel(ctxcontext.Context, ownerstring, repostring, namestring) (*Label, *Response,error)
GetLabel gets a single label.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/issues/#get-a-label
func (*IssuesService)GetMilestone¶
func (s *IssuesService) GetMilestone(ctxcontext.Context, ownerstring, repostring, numberint) (*Milestone, *Response,error)
GetMilestone gets a single milestone.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/issues/#get-a-milestone
func (*IssuesService)IsAssignee¶
func (s *IssuesService) IsAssignee(ctxcontext.Context, owner, repo, userstring) (bool, *Response,error)
IsAssignee checks if a user is an assignee for the specified repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/issues/#check-if-a-user-can-be-assigned
func (*IssuesService)List¶
func (s *IssuesService) List(ctxcontext.Context, allbool, opts *IssueListOptions) ([]*Issue, *Response,error)
List the issues for the authenticated user. If all is true, list issuesacross all the user's visible repositories including owned, member, andorganization repositories; if false, list only owned and memberrepositories.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/issues/#list-user-account-issues-assigned-to-the-authenticated-userGitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/issues/#list-issues-assigned-to-the-authenticated-user
func (*IssuesService)ListAssignees¶
func (s *IssuesService) ListAssignees(ctxcontext.Context, owner, repostring, opts *ListOptions) ([]*User, *Response,error)
ListAssignees fetches all available assignees (owners and collaborators) towhich issues may be assigned.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/issues/#list-assignees
func (*IssuesService)ListByOrg¶
func (s *IssuesService) ListByOrg(ctxcontext.Context, orgstring, opts *IssueListOptions) ([]*Issue, *Response,error)
ListByOrg fetches the issues in the specified organization for theauthenticated user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/issues/#list-organization-issues-assigned-to-the-authenticated-user
func (*IssuesService)ListByRepo¶
func (s *IssuesService) ListByRepo(ctxcontext.Context, ownerstring, repostring, opts *IssueListByRepoOptions) ([]*Issue, *Response,error)
ListByRepo lists the issues for the specified repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/issues/#list-repository-issues
func (*IssuesService)ListComments¶
func (s *IssuesService) ListComments(ctxcontext.Context, ownerstring, repostring, numberint, opts *IssueListCommentsOptions) ([]*IssueComment, *Response,error)
ListComments lists all comments on the specified issue. Specifying an issuenumber of 0 will return all comments on all issues for the repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/issues/#list-issue-commentsGitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/issues/#list-issue-comments-for-a-repository
func (*IssuesService)ListIssueEvents¶
func (s *IssuesService) ListIssueEvents(ctxcontext.Context, owner, repostring, numberint, opts *ListOptions) ([]*IssueEvent, *Response,error)
ListIssueEvents lists events for the specified issue.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/issues/#list-issue-events
func (*IssuesService)ListIssueTimeline¶
func (s *IssuesService) ListIssueTimeline(ctxcontext.Context, owner, repostring, numberint, opts *ListOptions) ([]*Timeline, *Response,error)
ListIssueTimeline lists events for the specified issue.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/issues/#list-timeline-events-for-an-issue
func (*IssuesService)ListLabels¶
func (s *IssuesService) ListLabels(ctxcontext.Context, ownerstring, repostring, opts *ListOptions) ([]*Label, *Response,error)
ListLabels lists all labels for a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/issues/#list-labels-for-a-repository
func (*IssuesService)ListLabelsByIssue¶
func (s *IssuesService) ListLabelsByIssue(ctxcontext.Context, ownerstring, repostring, numberint, opts *ListOptions) ([]*Label, *Response,error)
ListLabelsByIssue lists all labels for an issue.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/issues/#list-labels-for-an-issue
func (*IssuesService)ListLabelsForMilestone¶
func (s *IssuesService) ListLabelsForMilestone(ctxcontext.Context, ownerstring, repostring, numberint, opts *ListOptions) ([]*Label, *Response,error)
ListLabelsForMilestone lists labels for every issue in a milestone.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/issues/#list-labels-for-issues-in-a-milestone
func (*IssuesService)ListMilestones¶
func (s *IssuesService) ListMilestones(ctxcontext.Context, ownerstring, repostring, opts *MilestoneListOptions) ([]*Milestone, *Response,error)
ListMilestones lists all milestones for a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/issues/#list-milestones
func (*IssuesService)ListRepositoryEvents¶
func (s *IssuesService) ListRepositoryEvents(ctxcontext.Context, owner, repostring, opts *ListOptions) ([]*IssueEvent, *Response,error)
ListRepositoryEvents lists events for the specified repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/issues/#list-issue-events-for-a-repository
func (*IssuesService)Lock¶
func (s *IssuesService) Lock(ctxcontext.Context, ownerstring, repostring, numberint, opts *LockIssueOptions) (*Response,error)
Lock an issue's conversation.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/issues/#lock-an-issue
func (*IssuesService)RemoveAssignees¶
func (s *IssuesService) RemoveAssignees(ctxcontext.Context, owner, repostring, numberint, assignees []string) (*Issue, *Response,error)
RemoveAssignees removes the provided GitHub users as assignees from the issue.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/issues/#remove-assignees-from-an-issue
func (*IssuesService)RemoveLabelForIssue¶
func (s *IssuesService) RemoveLabelForIssue(ctxcontext.Context, ownerstring, repostring, numberint, labelstring) (*Response,error)
RemoveLabelForIssue removes a label for an issue.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/issues/#remove-a-label-from-an-issue
func (*IssuesService)RemoveLabelsForIssue¶
func (s *IssuesService) RemoveLabelsForIssue(ctxcontext.Context, ownerstring, repostring, numberint) (*Response,error)
RemoveLabelsForIssue removes all labels for an issue.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/issues/#remove-all-labels-from-an-issue
func (*IssuesService)RemoveMilestone¶
func (s *IssuesService) RemoveMilestone(ctxcontext.Context, owner, repostring, issueNumberint) (*Issue, *Response,error)
Remove a milestone from an issue.
This is a helper method to explicitly update an issue with a `null` milestone, thereby removing it.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/issues/#update-an-issue
func (*IssuesService)ReplaceLabelsForIssue¶
func (s *IssuesService) ReplaceLabelsForIssue(ctxcontext.Context, ownerstring, repostring, numberint, labels []string) ([]*Label, *Response,error)
ReplaceLabelsForIssue replaces all labels for an issue.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/issues/#set-labels-for-an-issue
typeJobs¶
type Jobs struct {TotalCount *int `json:"total_count,omitempty"`Jobs []*WorkflowJob `json:"jobs,omitempty"`}
Jobs represents a slice of repository action workflow job.
func (*Jobs)GetTotalCount¶
GetTotalCount returns the TotalCount field if it's non-nil, zero value otherwise.
typeKey¶
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"`Verified *bool `json:"verified,omitempty"`CreatedAt *Timestamp `json:"created_at,omitempty"`}
Key represents a public SSH key used to authenticate a user or deploy script.
func (*Key)GetCreatedAt¶
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*Key)GetReadOnly¶
GetReadOnly returns the ReadOnly field if it's non-nil, zero value otherwise.
func (*Key)GetVerified¶
GetVerified returns the Verified field if it's non-nil, zero value otherwise.
typeLabel¶
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 (*Label)GetDefault¶
GetDefault returns the Default field if it's non-nil, zero value otherwise.
func (*Label)GetDescription¶
GetDescription returns the Description field if it's non-nil, zero value otherwise.
typeLabelEvent¶
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://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#label
func (*LabelEvent)GetAction¶
func (l *LabelEvent) GetAction()string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*LabelEvent)GetChanges¶
func (l *LabelEvent) GetChanges() *EditChange
GetChanges returns the Changes field.
func (*LabelEvent)GetInstallation¶
func (l *LabelEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
typeLabelResult¶
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 (*LabelResult)GetColor¶
func (l *LabelResult) GetColor()string
GetColor returns the Color field if it's non-nil, zero value otherwise.
func (*LabelResult)GetDefault¶
func (l *LabelResult) GetDefault()bool
GetDefault returns the Default field if it's non-nil, zero value otherwise.
func (*LabelResult)GetDescription¶
func (l *LabelResult) GetDescription()string
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (*LabelResult)GetID¶
func (l *LabelResult) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*LabelResult)GetName¶
func (l *LabelResult) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*LabelResult)GetScore¶
func (l *LabelResult) GetScore() *float64
GetScore returns the Score field.
func (*LabelResult)GetURL¶
func (l *LabelResult) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (LabelResult)String¶
func (lLabelResult) String()string
typeLabelsSearchResult¶
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 (*LabelsSearchResult)GetIncompleteResults¶
func (l *LabelsSearchResult) GetIncompleteResults()bool
GetIncompleteResults returns the IncompleteResults field if it's non-nil, zero value otherwise.
func (*LabelsSearchResult)GetTotal¶
func (l *LabelsSearchResult) GetTotal()int
GetTotal returns the Total field if it's non-nil, zero value otherwise.
typeLargeFile¶
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://docs.github.com/en/free-pro-team@latest/rest/reference/migration/source_imports/#get-large-files
func (*LargeFile)GetRefName¶
GetRefName returns the RefName field if it's non-nil, zero value otherwise.
typeLicense¶
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 (*License)GetConditions¶
GetConditions returns the Conditions field if it's non-nil, zero value otherwise.
func (*License)GetDescription¶
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (*License)GetFeatured¶
GetFeatured returns the Featured field if it's non-nil, zero value otherwise.
func (*License)GetHTMLURL¶
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*License)GetImplementation¶
GetImplementation returns the Implementation field if it's non-nil, zero value otherwise.
func (*License)GetLimitations¶
GetLimitations returns the Limitations field if it's non-nil, zero value otherwise.
func (*License)GetPermissions¶
GetPermissions returns the Permissions field if it's non-nil, zero value otherwise.
typeLicensesService¶
type LicensesService service
LicensesService handles communication with the license relatedmethods of the GitHub API.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/licenses/
func (*LicensesService)Get¶
Get extended metadata for one license.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/licenses/#get-a-license
func (*LicensesService)List¶
List popular open source licenses.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/licenses/#list-all-licenses
typeListCheckRunsOptions¶
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"AppID *int64 `url:"app_id,omitempty"`// Filters check runs by GitHub App ID.ListOptions}
ListCheckRunsOptions represents parameters to list check runs.
func (*ListCheckRunsOptions)GetAppID¶
func (l *ListCheckRunsOptions) GetAppID()int64
GetAppID returns the AppID field if it's non-nil, zero value otherwise.
func (*ListCheckRunsOptions)GetCheckName¶
func (l *ListCheckRunsOptions) GetCheckName()string
GetCheckName returns the CheckName field if it's non-nil, zero value otherwise.
func (*ListCheckRunsOptions)GetFilter¶
func (l *ListCheckRunsOptions) GetFilter()string
GetFilter returns the Filter field if it's non-nil, zero value otherwise.
func (*ListCheckRunsOptions)GetStatus¶
func (l *ListCheckRunsOptions) GetStatus()string
GetStatus returns the Status field if it's non-nil, zero value otherwise.
typeListCheckRunsResults¶
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 (*ListCheckRunsResults)GetTotal¶
func (l *ListCheckRunsResults) GetTotal()int
GetTotal returns the Total field if it's non-nil, zero value otherwise.
typeListCheckSuiteOptions¶
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 (*ListCheckSuiteOptions)GetAppID¶
func (l *ListCheckSuiteOptions) GetAppID()int
GetAppID returns the AppID field if it's non-nil, zero value otherwise.
func (*ListCheckSuiteOptions)GetCheckName¶
func (l *ListCheckSuiteOptions) GetCheckName()string
GetCheckName returns the CheckName field if it's non-nil, zero value otherwise.
typeListCheckSuiteResults¶
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 (*ListCheckSuiteResults)GetTotal¶
func (l *ListCheckSuiteResults) GetTotal()int
GetTotal returns the Total field if it's non-nil, zero value otherwise.
typeListCollaboratorOptions¶
type ListCollaboratorOptions 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}
ListCollaboratorOptions specifies the optional parameters to theProjectsService.ListProjectCollaborators method.
func (*ListCollaboratorOptions)GetAffiliation¶
func (l *ListCollaboratorOptions) GetAffiliation()string
GetAffiliation returns the Affiliation field if it's non-nil, zero value otherwise.
typeListCollaboratorsOptions¶
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".Affiliationstring `url:"affiliation,omitempty"`ListOptions}
ListCollaboratorsOptions specifies the optional parameters to theRepositoriesService.ListCollaborators method.
typeListCommentReactionOptions¶
type ListCommentReactionOptions struct {// Content restricts the returned comment reactions to only those with the given type.// Omit this parameter to list all reactions to a commit comment.// Possible values are: "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", or "eyes".Contentstring `url:"content,omitempty"`ListOptions}
ListCommentReactionOptions specifies the optional parameters to theReactionsService.ListCommentReactions method.
typeListContributorsOptions¶
type ListContributorsOptions struct {// Include anonymous contributors in results or notAnonstring `url:"anon,omitempty"`ListOptions}
ListContributorsOptions specifies the optional parameters to theRepositoriesService.ListContributors method.
typeListCursorOptions¶
type ListCursorOptions struct {// For paginated result sets, page of results to retrieve.Pagestring `url:"page,omitempty"`// For paginated result sets, the number of results to include per page.PerPageint `url:"per_page,omitempty"`// A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.Afterstring `url:"after,omitempty"`// A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.Beforestring `url:"before,omitempty"`// A cursor, as given in the Link header. If specified, the query continues the search using this cursor.Cursorstring `url:"cursor,omitempty"`}
ListCursorOptions specifies the optional parameters to various List methods thatsupport cursor pagination.
typeListExternalGroupsOptions¶
type ListExternalGroupsOptions struct {DisplayName *string `url:"display_name,omitempty"`ListOptions}
ListExternalGroupsOptions specifies the optional parameters to theTeamsService.ListExternalGroups method.
func (*ListExternalGroupsOptions)GetDisplayName¶
func (l *ListExternalGroupsOptions) GetDisplayName()string
GetDisplayName returns the DisplayName field if it's non-nil, zero value otherwise.
typeListMembersOptions¶
type ListMembersOptions struct {// If true (or if the authenticated user is not an owner of the// organization), list only publicly visible members.PublicOnlybool `url:"-"`// Filter members returned in the list. Possible values are:// 2fa_disabled, all. Default is "all".Filterstring `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".Rolestring `url:"role,omitempty"`ListOptions}
ListMembersOptions specifies optional parameters to theOrganizationsService.ListMembers method.
typeListOptions¶
type ListOptions struct {// For paginated result sets, page of results to retrieve.Pageint `url:"page,omitempty"`// For paginated result sets, the number of results to include per page.PerPageint `url:"per_page,omitempty"`}
ListOptions specifies the optional parameters to various List methods thatsupport offset pagination.
typeListOrgMembershipsOptions¶
type ListOrgMembershipsOptions struct {// Filter memberships to include only those with the specified state.// Possible values are: "active", "pending".Statestring `url:"state,omitempty"`ListOptions}
ListOrgMembershipsOptions specifies optional parameters to theOrganizationsService.ListOrgMemberships method.
typeListOutsideCollaboratorsOptions¶
type ListOutsideCollaboratorsOptions struct {// Filter outside collaborators returned in the list. Possible values are:// 2fa_disabled, all. Default is "all".Filterstring `url:"filter,omitempty"`ListOptions}
ListOutsideCollaboratorsOptions specifies optional parameters to theOrganizationsService.ListOutsideCollaborators method.
typeListRepositories¶
type ListRepositories struct {TotalCount *int `json:"total_count,omitempty"`Repositories []*Repository `json:"repositories"`}
ListRepositories represents the response from the list repos endpoints.
func (*ListRepositories)GetTotalCount¶
func (l *ListRepositories) GetTotalCount()int
GetTotalCount returns the TotalCount field if it's non-nil, zero value otherwise.
typeListSCIMProvisionedIdentitiesOptions¶
type ListSCIMProvisionedIdentitiesOptions struct {StartIndex *int `json:"startIndex,omitempty"`// Used for pagination: the index of the first result to return. (Optional.)Count *int `json:"count,omitempty"`// Used for pagination: the number of results to return. (Optional.)// Filter results using the equals query parameter operator (eq).// You can filter results that are equal to id, userName, emails, and external_id.// For example, to search for an identity with the userName Octocat, you would use this query: ?filter=userName%20eq%20\"Octocat\".// To filter results for the identity with the email octocat@github.com, you would use this query: ?filter=emails%20eq%20\"octocat@github.com\".// (Optional.)Filter *string `json:"filter,omitempty"`}
ListSCIMProvisionedIdentitiesOptions represents options for ListSCIMProvisionedIdentities.
Github API docs:https://docs.github.com/en/rest/reference/scim#list-scim-provisioned-identities--parameters
func (*ListSCIMProvisionedIdentitiesOptions)GetCount¶
func (l *ListSCIMProvisionedIdentitiesOptions) GetCount()int
GetCount returns the Count field if it's non-nil, zero value otherwise.
func (*ListSCIMProvisionedIdentitiesOptions)GetFilter¶
func (l *ListSCIMProvisionedIdentitiesOptions) GetFilter()string
GetFilter returns the Filter field if it's non-nil, zero value otherwise.
func (*ListSCIMProvisionedIdentitiesOptions)GetStartIndex¶
func (l *ListSCIMProvisionedIdentitiesOptions) GetStartIndex()int
GetStartIndex returns the StartIndex field if it's non-nil, zero value otherwise.
typeListWorkflowJobsOptions¶
type ListWorkflowJobsOptions struct {// Filter specifies how jobs should be filtered by their completed_at timestamp.// Possible values are:// latest - Returns jobs from the most recent execution of the workflow run// all - Returns all jobs for a workflow run, including from old executions of the workflow run//// Default value is "latest".Filterstring `url:"filter,omitempty"`ListOptions}
ListWorkflowJobsOptions specifies optional parameters to ListWorkflowJobs.
typeListWorkflowRunsOptions¶
type ListWorkflowRunsOptions struct {Actorstring `url:"actor,omitempty"`Branchstring `url:"branch,omitempty"`Eventstring `url:"event,omitempty"`Statusstring `url:"status,omitempty"`Createdstring `url:"created,omitempty"`ListOptions}
ListWorkflowRunsOptions specifies optional parameters to ListWorkflowRuns.
typeLocation¶
type Location struct {Path *string `json:"path,omitempty"`StartLine *int `json:"start_line,omitempty"`EndLine *int `json:"end_line,omitempty"`StartColumn *int `json:"start_column,omitempty"`EndColumn *int `json:"end_column,omitempty"`}
Location represents the exact location of the GitHub Code Scanning Alert in the scanned project.
func (*Location)GetEndColumn¶
GetEndColumn returns the EndColumn field if it's non-nil, zero value otherwise.
func (*Location)GetEndLine¶
GetEndLine returns the EndLine field if it's non-nil, zero value otherwise.
func (*Location)GetStartColumn¶
GetStartColumn returns the StartColumn field if it's non-nil, zero value otherwise.
func (*Location)GetStartLine¶
GetStartLine returns the StartLine field if it's non-nil, zero value otherwise.
typeLockIssueOptions¶
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".LockReasonstring `json:"lock_reason,omitempty"`}
LockIssueOptions specifies the optional parameters to theIssuesService.Lock method.
typeMarkdownOptions¶
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".Modestring// Context identifies the repository context. Only taken into account// when rendering as "gfm".Contextstring}
MarkdownOptions specifies optional parameters to the Markdown method.
typeMarketplacePendingChange¶
type MarketplacePendingChange struct {EffectiveDate *Timestamp `json:"effective_date,omitempty"`UnitCount *int `json:"unit_count,omitempty"`ID *int64 `json:"id,omitempty"`Plan *MarketplacePlan `json:"plan,omitempty"`}
MarketplacePendingChange represents a pending change to a GitHub Apps Marketplace Plan.
func (*MarketplacePendingChange)GetEffectiveDate¶
func (m *MarketplacePendingChange) GetEffectiveDate()Timestamp
GetEffectiveDate returns the EffectiveDate field if it's non-nil, zero value otherwise.
func (*MarketplacePendingChange)GetID¶
func (m *MarketplacePendingChange) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*MarketplacePendingChange)GetPlan¶
func (m *MarketplacePendingChange) GetPlan() *MarketplacePlan
GetPlan returns the Plan field.
func (*MarketplacePendingChange)GetUnitCount¶
func (m *MarketplacePendingChange) GetUnitCount()int
GetUnitCount returns the UnitCount field if it's non-nil, zero value otherwise.
typeMarketplacePlan¶
type MarketplacePlan struct {URL *string `json:"url,omitempty"`AccountsURL *string `json:"accounts_url,omitempty"`ID *int64 `json:"id,omitempty"`Number *int `json:"number,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"`// The pricing model for this listing. Can be one of "flat-rate", "per-unit", or "free".PriceModel *string `json:"price_model,omitempty"`UnitName *string `json:"unit_name,omitempty"`Bullets *[]string `json:"bullets,omitempty"`// State can be one of the values "draft" or "published".State *string `json:"state,omitempty"`HasFreeTrial *bool `json:"has_free_trial,omitempty"`}
MarketplacePlan represents a GitHub Apps Marketplace Listing Plan.
func (*MarketplacePlan)GetAccountsURL¶
func (m *MarketplacePlan) GetAccountsURL()string
GetAccountsURL returns the AccountsURL field if it's non-nil, zero value otherwise.
func (*MarketplacePlan)GetBullets¶
func (m *MarketplacePlan) GetBullets() []string
GetBullets returns the Bullets field if it's non-nil, zero value otherwise.
func (*MarketplacePlan)GetDescription¶
func (m *MarketplacePlan) GetDescription()string
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (*MarketplacePlan)GetHasFreeTrial¶
func (m *MarketplacePlan) GetHasFreeTrial()bool
GetHasFreeTrial returns the HasFreeTrial field if it's non-nil, zero value otherwise.
func (*MarketplacePlan)GetID¶
func (m *MarketplacePlan) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*MarketplacePlan)GetMonthlyPriceInCents¶
func (m *MarketplacePlan) GetMonthlyPriceInCents()int
GetMonthlyPriceInCents returns the MonthlyPriceInCents field if it's non-nil, zero value otherwise.
func (*MarketplacePlan)GetName¶
func (m *MarketplacePlan) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*MarketplacePlan)GetNumber¶
func (m *MarketplacePlan) GetNumber()int
GetNumber returns the Number field if it's non-nil, zero value otherwise.
func (*MarketplacePlan)GetPriceModel¶
func (m *MarketplacePlan) GetPriceModel()string
GetPriceModel returns the PriceModel field if it's non-nil, zero value otherwise.
func (*MarketplacePlan)GetState¶
func (m *MarketplacePlan) GetState()string
GetState returns the State field if it's non-nil, zero value otherwise.
func (*MarketplacePlan)GetURL¶
func (m *MarketplacePlan) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (*MarketplacePlan)GetUnitName¶
func (m *MarketplacePlan) GetUnitName()string
GetUnitName returns the UnitName field if it's non-nil, zero value otherwise.
func (*MarketplacePlan)GetYearlyPriceInCents¶
func (m *MarketplacePlan) GetYearlyPriceInCents()int
GetYearlyPriceInCents returns the YearlyPriceInCents field if it's non-nil, zero value otherwise.
typeMarketplacePlanAccount¶
type MarketplacePlanAccount struct {URL *string `json:"url,omitempty"`Type *string `json:"type,omitempty"`ID *int64 `json:"id,omitempty"`Login *string `json:"login,omitempty"`OrganizationBillingEmail *string `json:"organization_billing_email,omitempty"`MarketplacePurchase *MarketplacePurchase `json:"marketplace_purchase,omitempty"`MarketplacePendingChange *MarketplacePendingChange `json:"marketplace_pending_change,omitempty"`}
MarketplacePlanAccount represents a GitHub Account (user or organization) on a specific plan.
func (*MarketplacePlanAccount)GetID¶
func (m *MarketplacePlanAccount) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*MarketplacePlanAccount)GetLogin¶
func (m *MarketplacePlanAccount) GetLogin()string
GetLogin returns the Login field if it's non-nil, zero value otherwise.
func (*MarketplacePlanAccount)GetMarketplacePendingChange¶
func (m *MarketplacePlanAccount) GetMarketplacePendingChange() *MarketplacePendingChange
GetMarketplacePendingChange returns the MarketplacePendingChange field.
func (*MarketplacePlanAccount)GetMarketplacePurchase¶
func (m *MarketplacePlanAccount) GetMarketplacePurchase() *MarketplacePurchase
GetMarketplacePurchase returns the MarketplacePurchase field.
func (*MarketplacePlanAccount)GetOrganizationBillingEmail¶
func (m *MarketplacePlanAccount) GetOrganizationBillingEmail()string
GetOrganizationBillingEmail returns the OrganizationBillingEmail field if it's non-nil, zero value otherwise.
func (*MarketplacePlanAccount)GetType¶
func (m *MarketplacePlanAccount) GetType()string
GetType returns the Type field if it's non-nil, zero value otherwise.
func (*MarketplacePlanAccount)GetURL¶
func (m *MarketplacePlanAccount) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
typeMarketplacePurchase¶
type MarketplacePurchase struct {// BillingCycle can be one of the values "yearly", "monthly" or nil.BillingCycle *string `json:"billing_cycle,omitempty"`NextBillingDate *Timestamp `json:"next_billing_date,omitempty"`UnitCount *int `json:"unit_count,omitempty"`Plan *MarketplacePlan `json:"plan,omitempty"`OnFreeTrial *bool `json:"on_free_trial,omitempty"`FreeTrialEndsOn *Timestamp `json:"free_trial_ends_on,omitempty"`UpdatedAt *Timestamp `json:"updated_at,omitempty"`}
MarketplacePurchase represents a GitHub Apps Marketplace Purchase.
func (*MarketplacePurchase)GetBillingCycle¶
func (m *MarketplacePurchase) GetBillingCycle()string
GetBillingCycle returns the BillingCycle field if it's non-nil, zero value otherwise.
func (*MarketplacePurchase)GetFreeTrialEndsOn¶
func (m *MarketplacePurchase) GetFreeTrialEndsOn()Timestamp
GetFreeTrialEndsOn returns the FreeTrialEndsOn field if it's non-nil, zero value otherwise.
func (*MarketplacePurchase)GetNextBillingDate¶
func (m *MarketplacePurchase) GetNextBillingDate()Timestamp
GetNextBillingDate returns the NextBillingDate field if it's non-nil, zero value otherwise.
func (*MarketplacePurchase)GetOnFreeTrial¶
func (m *MarketplacePurchase) GetOnFreeTrial()bool
GetOnFreeTrial returns the OnFreeTrial field if it's non-nil, zero value otherwise.
func (*MarketplacePurchase)GetPlan¶
func (m *MarketplacePurchase) GetPlan() *MarketplacePlan
GetPlan returns the Plan field.
func (*MarketplacePurchase)GetUnitCount¶
func (m *MarketplacePurchase) GetUnitCount()int
GetUnitCount returns the UnitCount field if it's non-nil, zero value otherwise.
func (*MarketplacePurchase)GetUpdatedAt¶
func (m *MarketplacePurchase) GetUpdatedAt()Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
typeMarketplacePurchaseEvent¶
type MarketplacePurchaseEvent struct {// Action is the action that was performed. Possible values are:// "purchased", "cancelled", "pending_change", "pending_change_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 changestheir GitHub Marketplace plan.Webhook event name "marketplace_purchase".
GitHub API docs:https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#marketplace_purchase
func (*MarketplacePurchaseEvent)GetAction¶
func (m *MarketplacePurchaseEvent) GetAction()string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*MarketplacePurchaseEvent)GetEffectiveDate¶
func (m *MarketplacePurchaseEvent) GetEffectiveDate()Timestamp
GetEffectiveDate returns the EffectiveDate field if it's non-nil, zero value otherwise.
func (*MarketplacePurchaseEvent)GetInstallation¶
func (m *MarketplacePurchaseEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*MarketplacePurchaseEvent)GetMarketplacePurchase¶
func (m *MarketplacePurchaseEvent) GetMarketplacePurchase() *MarketplacePurchase
GetMarketplacePurchase returns the MarketplacePurchase field.
func (*MarketplacePurchaseEvent)GetPreviousMarketplacePurchase¶
func (m *MarketplacePurchaseEvent) GetPreviousMarketplacePurchase() *MarketplacePurchase
GetPreviousMarketplacePurchase returns the PreviousMarketplacePurchase field.
func (*MarketplacePurchaseEvent)GetSender¶
func (m *MarketplacePurchaseEvent) GetSender() *User
GetSender returns the Sender field.
typeMarketplaceService¶
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://docs.github.com/en/free-pro-team@latest/rest/reference/apps#testing-with-stubbed-endpointsStubbedbool// contains filtered or unexported fields}
MarketplaceService handles communication with the marketplace relatedmethods of the GitHub API.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/apps#marketplace
func (*MarketplaceService)GetPlanAccountForAccount¶
func (s *MarketplaceService) GetPlanAccountForAccount(ctxcontext.Context, accountIDint64) (*MarketplacePlanAccount, *Response,error)
GetPlanAccountForAccount get GitHub account (user or organization) associated with an account.
GitHub API docs:https://docs.github.com/en/rest/reference/apps#get-a-subscription-plan-for-an-account
func (*MarketplaceService)ListMarketplacePurchasesForUser¶
func (s *MarketplaceService) ListMarketplacePurchasesForUser(ctxcontext.Context, opts *ListOptions) ([]*MarketplacePurchase, *Response,error)
ListMarketplacePurchasesForUser lists all GitHub marketplace purchases made by a user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/apps/#list-subscriptions-for-the-authenticated-user-stubbedGitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/apps/#list-subscriptions-for-the-authenticated-user
func (*MarketplaceService)ListPlanAccountsForPlan¶
func (s *MarketplaceService) ListPlanAccountsForPlan(ctxcontext.Context, planIDint64, opts *ListOptions) ([]*MarketplacePlanAccount, *Response,error)
ListPlanAccountsForPlan lists all GitHub accounts (user or organization) on a specific plan.
GitHub API docs:https://docs.github.com/en/rest/reference/apps#list-accounts-for-a-plan
func (*MarketplaceService)ListPlans¶
func (s *MarketplaceService) ListPlans(ctxcontext.Context, opts *ListOptions) ([]*MarketplacePlan, *Response,error)
ListPlans lists all plans for your Marketplace listing.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/apps#list-plans
typeMemberEvent¶
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://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#member
func (*MemberEvent)GetAction¶
func (m *MemberEvent) GetAction()string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*MemberEvent)GetInstallation¶
func (m *MemberEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*MemberEvent)GetMember¶
func (m *MemberEvent) GetMember() *User
GetMember returns the Member field.
func (*MemberEvent)GetRepo¶
func (m *MemberEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (*MemberEvent)GetSender¶
func (m *MemberEvent) GetSender() *User
GetSender returns the Sender field.
typeMembership¶
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 descriptionRole *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 (*Membership)GetOrganization¶
func (m *Membership) GetOrganization() *Organization
GetOrganization returns the Organization field.
func (*Membership)GetOrganizationURL¶
func (m *Membership) GetOrganizationURL()string
GetOrganizationURL returns the OrganizationURL field if it's non-nil, zero value otherwise.
func (*Membership)GetRole¶
func (m *Membership) GetRole()string
GetRole returns the Role field if it's non-nil, zero value otherwise.
func (*Membership)GetState¶
func (m *Membership) GetState()string
GetState returns the State field if it's non-nil, zero value otherwise.
func (*Membership)GetURL¶
func (m *Membership) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (Membership)String¶
func (mMembership) String()string
typeMembershipEvent¶
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 totrigger organization webhooks.
GitHub API docs:https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#membership
func (*MembershipEvent)GetAction¶
func (m *MembershipEvent) GetAction()string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*MembershipEvent)GetInstallation¶
func (m *MembershipEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*MembershipEvent)GetMember¶
func (m *MembershipEvent) GetMember() *User
GetMember returns the Member field.
func (*MembershipEvent)GetOrg¶
func (m *MembershipEvent) GetOrg() *Organization
GetOrg returns the Org field.
func (*MembershipEvent)GetScope¶
func (m *MembershipEvent) GetScope()string
GetScope returns the Scope field if it's non-nil, zero value otherwise.
func (*MembershipEvent)GetSender¶
func (m *MembershipEvent) GetSender() *User
GetSender returns the Sender field.
func (*MembershipEvent)GetTeam¶
func (m *MembershipEvent) GetTeam() *Team
GetTeam returns the Team field.
typeMessage¶
type Message struct {Text *string `json:"text,omitempty"`}
Message is a part of MostRecentInstance struct which provides the appropriate message when any action is performed on the analysis object.
typeMetaEvent¶
type MetaEvent struct {// Action is the action that was performed. Possible value is: "deleted".Action *string `json:"action,omitempty"`// The ID of the modified webhook.HookID *int64 `json:"hook_id,omitempty"`// The modified webhook.// This will contain different keys based on the type of webhook it is: repository,// organization, business, app, or GitHub Marketplace.Hook *Hook `json:"hook,omitempty"`// The following fields are only populated by Webhook events.Installation *Installation `json:"installation,omitempty"`}
MetaEvent is triggered when the webhook that this event is configured on is deleted.This event will only listen for changes to the particular hook the event is installed on.Therefore, it must be selected for each hook that you'd like to receive meta events for.The Webhook event name is "meta".
GitHub API docs:https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#meta
func (*MetaEvent)GetAction¶
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*MetaEvent)GetHookID¶
GetHookID returns the HookID field if it's non-nil, zero value otherwise.
func (*MetaEvent)GetInstallation¶
func (m *MetaEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
typeMetric¶
type Metric struct {Name *string `json:"name"`Key *string `json:"key"`SPDXID *string `json:"spdx_id"`URL *string `json:"url"`HTMLURL *string `json:"html_url"`NodeID *string `json:"node_id"`}
Metric represents the different fields for one file in community health files.
func (*Metric)GetHTMLURL¶
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
typeMigration¶
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 (*Migration)GetCreatedAt¶
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*Migration)GetExcludeAttachments¶
GetExcludeAttachments returns the ExcludeAttachments field if it's non-nil, zero value otherwise.
func (*Migration)GetLockRepositories¶
GetLockRepositories returns the LockRepositories field if it's non-nil, zero value otherwise.
func (*Migration)GetUpdatedAt¶
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
typeMigrationOptions¶
type MigrationOptions struct {// LockRepositories indicates whether repositories should be locked (to prevent// manipulation) while migrating data.LockRepositoriesbool// ExcludeAttachments indicates whether attachments should be excluded from// the migration (to reduce migration archive file size).ExcludeAttachmentsbool}
MigrationOptions specifies the optional parameters to Migration methods.
typeMigrationService¶
type MigrationService service
MigrationService provides access to the migration related functionsin the GitHub API.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/migration/
func (*MigrationService)CancelImport¶
CancelImport stops an import for a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/migrations/#cancel-an-import
func (*MigrationService)CommitAuthors¶
func (s *MigrationService) CommitAuthors(ctxcontext.Context, owner, repostring) ([]*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 willmake the author information valid, but the author might not be correct. Forexample, it will change the bare Subversion username "hubot" into somethinglike "hubot <hubot@12341234-abab-fefe-8787-fedcba987654>".
This method and MapCommitAuthor allow you to provide correct Git authorinformation.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/migrations/#get-commit-authors
func (*MigrationService)DeleteMigration¶
func (s *MigrationService) DeleteMigration(ctxcontext.Context, orgstring, idint64) (*Response,error)
DeleteMigration deletes a previous migration archive.id is the migration ID.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/migrations/#delete-an-organization-migration-archive
func (*MigrationService)DeleteUserMigration¶
DeleteUserMigration will delete a previous migration archive.id is the migration ID.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/migrations/#delete-a-user-migration-archive
func (*MigrationService)ImportProgress¶
func (s *MigrationService) ImportProgress(ctxcontext.Context, owner, repostring) (*Import, *Response,error)
ImportProgress queries for the status and progress of an ongoing repository import.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/migrations/#get-an-import-status
func (*MigrationService)LargeFiles¶
func (s *MigrationService) LargeFiles(ctxcontext.Context, owner, repostring) ([]*LargeFile, *Response,error)
LargeFiles lists files larger than 100MB found during the import.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/migrations/#get-large-files
func (*MigrationService)ListMigrations¶
func (s *MigrationService) ListMigrations(ctxcontext.Context, orgstring, opts *ListOptions) ([]*Migration, *Response,error)
ListMigrations lists the most recent migrations.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/migrations/#list-organization-migrations
func (*MigrationService)ListUserMigrations¶
func (s *MigrationService) ListUserMigrations(ctxcontext.Context) ([]*UserMigration, *Response,error)
ListUserMigrations lists the most recent migrations.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/migrations/#list-user-migrations
func (*MigrationService)MapCommitAuthor¶
func (s *MigrationService) MapCommitAuthor(ctxcontext.Context, owner, repostring, idint64, author *SourceImportAuthor) (*SourceImportAuthor, *Response,error)
MapCommitAuthor updates an author's identity for the import. Yourapplication can continue updating authors any time before you push newcommits to the repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/migrations/#map-a-commit-author
func (*MigrationService)MigrationArchiveURL¶
func (s *MigrationService) MigrationArchiveURL(ctxcontext.Context, orgstring, idint64) (urlstring, errerror)
MigrationArchiveURL fetches a migration archive URL.id is the migration ID.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/migrations/#download-an-organization-migration-archive
func (*MigrationService)MigrationStatus¶
func (s *MigrationService) MigrationStatus(ctxcontext.Context, orgstring, idint64) (*Migration, *Response,error)
MigrationStatus gets the status of a specific migration archive.id is the migration ID.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/migrations/#get-an-organization-migration-status
func (*MigrationService)SetLFSPreference¶
func (s *MigrationService) SetLFSPreference(ctxcontext.Context, owner, repostring, in *Import) (*Import, *Response,error)
SetLFSPreference sets whether imported repositories should use Git LFS forfiles larger than 100MB. Only the UseLFS field on the provided Import isused.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/migrations/#update-git-lfs-preference
func (*MigrationService)StartImport¶
func (s *MigrationService) StartImport(ctxcontext.Context, owner, repostring, in *Import) (*Import, *Response,error)
StartImport initiates a repository import.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/migrations/#start-an-import
func (*MigrationService)StartMigration¶
func (s *MigrationService) StartMigration(ctxcontext.Context, orgstring, repos []string, opts *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://docs.github.com/en/free-pro-team@latest/rest/reference/migrations/#start-an-organization-migration
func (*MigrationService)StartUserMigration¶
func (s *MigrationService) StartUserMigration(ctxcontext.Context, repos []string, opts *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://docs.github.com/en/free-pro-team@latest/rest/reference/migrations/#start-a-user-migration
func (*MigrationService)UnlockRepo¶
func (s *MigrationService) UnlockRepo(ctxcontext.Context, orgstring, idint64, repostring) (*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 migrationis complete and you no longer need the source data.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/migrations/#unlock-an-organization-repository
func (*MigrationService)UnlockUserRepo¶
func (s *MigrationService) UnlockUserRepo(ctxcontext.Context, idint64, repostring) (*Response,error)
UnlockUserRepo will unlock a repo that was locked for migration.id is migration ID.You should unlock each migrated repository and delete them when the migrationis complete and you no longer need the source data.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/migrations/#unlock-a-user-repository
func (*MigrationService)UpdateImport¶
func (s *MigrationService) UpdateImport(ctxcontext.Context, owner, repostring, in *Import) (*Import, *Response,error)
UpdateImport initiates a repository import.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/migrations/#update-an-import
func (*MigrationService)UserMigrationArchiveURL¶
UserMigrationArchiveURL gets the URL for a specific migration archive.id is the migration ID.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/migrations/#download-a-user-migration-archive
func (*MigrationService)UserMigrationStatus¶
func (s *MigrationService) UserMigrationStatus(ctxcontext.Context, idint64) (*UserMigration, *Response,error)
UserMigrationStatus gets the status of a specific migration archive.id is the migration ID.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/migrations/#get-a-user-migration-status
typeMilestone¶
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 (*Milestone)GetClosedAt¶
GetClosedAt returns the ClosedAt field if it's non-nil, zero value otherwise.
func (*Milestone)GetClosedIssues¶
GetClosedIssues returns the ClosedIssues field if it's non-nil, zero value otherwise.
func (*Milestone)GetCreatedAt¶
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*Milestone)GetCreator¶
GetCreator returns the Creator field.
func (*Milestone)GetDescription¶
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (*Milestone)GetHTMLURL¶
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*Milestone)GetLabelsURL¶
GetLabelsURL returns the LabelsURL field if it's non-nil, zero value otherwise.
func (*Milestone)GetNodeID¶
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (*Milestone)GetNumber¶
GetNumber returns the Number field if it's non-nil, zero value otherwise.
func (*Milestone)GetOpenIssues¶
GetOpenIssues returns the OpenIssues field if it's non-nil, zero value otherwise.
func (*Milestone)GetUpdatedAt¶
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
typeMilestoneEvent¶
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://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#milestone
func (*MilestoneEvent)GetAction¶
func (m *MilestoneEvent) GetAction()string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*MilestoneEvent)GetChanges¶
func (m *MilestoneEvent) GetChanges() *EditChange
GetChanges returns the Changes field.
func (*MilestoneEvent)GetInstallation¶
func (m *MilestoneEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*MilestoneEvent)GetMilestone¶
func (m *MilestoneEvent) GetMilestone() *Milestone
GetMilestone returns the Milestone field.
func (*MilestoneEvent)GetOrg¶
func (m *MilestoneEvent) GetOrg() *Organization
GetOrg returns the Org field.
func (*MilestoneEvent)GetRepo¶
func (m *MilestoneEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (*MilestoneEvent)GetSender¶
func (m *MilestoneEvent) GetSender() *User
GetSender returns the Sender field.
typeMilestoneListOptions¶
type MilestoneListOptions struct {// State filters milestones based on their state. Possible values are:// open, closed, all. Default is "open".Statestring `url:"state,omitempty"`// Sort specifies how to sort milestones. Possible values are: due_on, completeness.// Default value is "due_on".Sortstring `url:"sort,omitempty"`// Direction in which to sort milestones. Possible values are: asc, desc.// Default is "asc".Directionstring `url:"direction,omitempty"`ListOptions}
MilestoneListOptions specifies the optional parameters to theIssuesService.ListMilestones method.
typeMilestoneStats¶
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 (*MilestoneStats)GetClosedMilestones¶
func (m *MilestoneStats) GetClosedMilestones()int
GetClosedMilestones returns the ClosedMilestones field if it's non-nil, zero value otherwise.
func (*MilestoneStats)GetOpenMilestones¶
func (m *MilestoneStats) GetOpenMilestones()int
GetOpenMilestones returns the OpenMilestones field if it's non-nil, zero value otherwise.
func (*MilestoneStats)GetTotalMilestones¶
func (m *MilestoneStats) GetTotalMilestones()int
GetTotalMilestones returns the TotalMilestones field if it's non-nil, zero value otherwise.
func (MilestoneStats)String¶
func (sMilestoneStats) String()string
typeMostRecentInstance¶
type MostRecentInstance struct {Ref *string `json:"ref,omitempty"`AnalysisKey *string `json:"analysis_key,omitempty"`Environment *string `json:"environment,omitempty"`State *string `json:"state,omitempty"`CommitSHA *string `json:"commit_sha,omitempty"`Message *Message `json:"message,omitempty"`Location *Location `json:"location,omitempty"`Classifications []string `json:"classifications,omitempty"`}
MostRecentInstance provides details of the most recent instance of this alert for the default branch or for the specified Git reference.
func (*MostRecentInstance)GetAnalysisKey¶
func (m *MostRecentInstance) GetAnalysisKey()string
GetAnalysisKey returns the AnalysisKey field if it's non-nil, zero value otherwise.
func (*MostRecentInstance)GetCommitSHA¶
func (m *MostRecentInstance) GetCommitSHA()string
GetCommitSHA returns the CommitSHA field if it's non-nil, zero value otherwise.
func (*MostRecentInstance)GetEnvironment¶
func (m *MostRecentInstance) GetEnvironment()string
GetEnvironment returns the Environment field if it's non-nil, zero value otherwise.
func (*MostRecentInstance)GetLocation¶
func (m *MostRecentInstance) GetLocation() *Location
GetLocation returns the Location field.
func (*MostRecentInstance)GetMessage¶
func (m *MostRecentInstance) GetMessage() *Message
GetMessage returns the Message field.
func (*MostRecentInstance)GetRef¶
func (m *MostRecentInstance) GetRef()string
GetRef returns the Ref field if it's non-nil, zero value otherwise.
func (*MostRecentInstance)GetState¶
func (m *MostRecentInstance) GetState()string
GetState returns the State field if it's non-nil, zero value otherwise.
typeNewPullRequest¶
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"`Draft *bool `json:"draft,omitempty"`}
NewPullRequest represents a new pull request to be created.
func (*NewPullRequest)GetBase¶
func (n *NewPullRequest) GetBase()string
GetBase returns the Base field if it's non-nil, zero value otherwise.
func (*NewPullRequest)GetBody¶
func (n *NewPullRequest) GetBody()string
GetBody returns the Body field if it's non-nil, zero value otherwise.
func (*NewPullRequest)GetDraft¶
func (n *NewPullRequest) GetDraft()bool
GetDraft returns the Draft field if it's non-nil, zero value otherwise.
func (*NewPullRequest)GetHead¶
func (n *NewPullRequest) GetHead()string
GetHead returns the Head field if it's non-nil, zero value otherwise.
func (*NewPullRequest)GetIssue¶
func (n *NewPullRequest) GetIssue()int
GetIssue returns the Issue field if it's non-nil, zero value otherwise.
func (*NewPullRequest)GetMaintainerCanModify¶
func (n *NewPullRequest) GetMaintainerCanModify()bool
GetMaintainerCanModify returns the MaintainerCanModify field if it's non-nil, zero value otherwise.
func (*NewPullRequest)GetTitle¶
func (n *NewPullRequest) GetTitle()string
GetTitle returns the Title field if it's non-nil, zero value otherwise.
typeNewTeam¶
type NewTeam struct {Namestring `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 (*NewTeam)GetDescription¶
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (*NewTeam)GetParentTeamID¶
GetParentTeamID returns the ParentTeamID field if it's non-nil, zero value otherwise.
func (*NewTeam)GetPermission¶
GetPermission returns the Permission field if it's non-nil, zero value otherwise.
func (*NewTeam)GetPrivacy¶
GetPrivacy returns the Privacy field if it's non-nil, zero value otherwise.
typeNotification¶
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://docs.github.com/en/free-pro-team@latest/rest/reference/activity#notification-reasonsReason *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 (*Notification)GetID¶
func (n *Notification) GetID()string
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*Notification)GetLastReadAt¶
func (n *Notification) GetLastReadAt()time.Time
GetLastReadAt returns the LastReadAt field if it's non-nil, zero value otherwise.
func (*Notification)GetReason¶
func (n *Notification) GetReason()string
GetReason returns the Reason field if it's non-nil, zero value otherwise.
func (*Notification)GetRepository¶
func (n *Notification) GetRepository() *Repository
GetRepository returns the Repository field.
func (*Notification)GetSubject¶
func (n *Notification) GetSubject() *NotificationSubject
GetSubject returns the Subject field.
func (*Notification)GetURL¶
func (n *Notification) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (*Notification)GetUnread¶
func (n *Notification) GetUnread()bool
GetUnread returns the Unread field if it's non-nil, zero value otherwise.
func (*Notification)GetUpdatedAt¶
func (n *Notification) GetUpdatedAt()time.Time
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
typeNotificationListOptions¶
type NotificationListOptions struct {Allbool `url:"all,omitempty"`Participatingbool `url:"participating,omitempty"`Sincetime.Time `url:"since,omitempty"`Beforetime.Time `url:"before,omitempty"`ListOptions}
NotificationListOptions specifies the optional parameters to theActivityService.ListNotifications method.
typeNotificationSubject¶
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 (*NotificationSubject)GetLatestCommentURL¶
func (n *NotificationSubject) GetLatestCommentURL()string
GetLatestCommentURL returns the LatestCommentURL field if it's non-nil, zero value otherwise.
func (*NotificationSubject)GetTitle¶
func (n *NotificationSubject) GetTitle()string
GetTitle returns the Title field if it's non-nil, zero value otherwise.
func (*NotificationSubject)GetType¶
func (n *NotificationSubject) GetType()string
GetType returns the Type field if it's non-nil, zero value otherwise.
func (*NotificationSubject)GetURL¶
func (n *NotificationSubject) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
typeOAuthAPP¶
type OAuthAPP struct {URL *string `json:"url,omitempty"`Name *string `json:"name,omitempty"`ClientID *string `json:"client_id,omitempty"`}
OAuthAPP represents the GitHub Site Administrator OAuth app.
func (*OAuthAPP)GetClientID¶
GetClientID returns the ClientID field if it's non-nil, zero value otherwise.
typeOrgBlockEvent¶
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://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#org_block
func (*OrgBlockEvent)GetAction¶
func (o *OrgBlockEvent) GetAction()string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*OrgBlockEvent)GetBlockedUser¶
func (o *OrgBlockEvent) GetBlockedUser() *User
GetBlockedUser returns the BlockedUser field.
func (*OrgBlockEvent)GetInstallation¶
func (o *OrgBlockEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*OrgBlockEvent)GetOrganization¶
func (o *OrgBlockEvent) GetOrganization() *Organization
GetOrganization returns the Organization field.
func (*OrgBlockEvent)GetSender¶
func (o *OrgBlockEvent) GetSender() *User
GetSender returns the Sender field.
typeOrgStats¶
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 teamand team member count.
func (*OrgStats)GetDisabledOrgs¶
GetDisabledOrgs returns the DisabledOrgs field if it's non-nil, zero value otherwise.
func (*OrgStats)GetTotalOrgs¶
GetTotalOrgs returns the TotalOrgs field if it's non-nil, zero value otherwise.
func (*OrgStats)GetTotalTeamMembers¶
GetTotalTeamMembers returns the TotalTeamMembers field if it's non-nil, zero value otherwise.
func (*OrgStats)GetTotalTeams¶
GetTotalTeams returns the TotalTeams field if it's non-nil, zero value otherwise.
typeOrganization¶
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"`TwitterUsername *string `json:"twitter_username,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"`TwoFactorRequirementEnabled *bool `json:"two_factor_requirement_enabled,omitempty"`IsVerified *bool `json:"is_verified,omitempty"`HasOrganizationProjects *bool `json:"has_organization_projects,omitempty"`HasRepositoryProjects *bool `json:"has_repository_projects,omitempty"`// DefaultRepoPermission can be one of: "read", "write", "admin", or "none". (Default: "read").// It is only used in OrganizationsService.Edit.DefaultRepoPermission *string `json:"default_repository_permission,omitempty"`// DefaultRepoSettings can be one of: "read", "write", "admin", or "none". (Default: "read").// It is only used in OrganizationsService.Get.DefaultRepoSettings *string `json:"default_repository_settings,omitempty"`// MembersCanCreateRepos default value is true and is only used in Organizations.Edit.MembersCanCreateRepos *bool `json:"members_can_create_repositories,omitempty"`//https://developer.github.com/changes/2019-12-03-internal-visibility-changes/#rest-v3-apiMembersCanCreatePublicRepos *bool `json:"members_can_create_public_repositories,omitempty"`MembersCanCreatePrivateRepos *bool `json:"members_can_create_private_repositories,omitempty"`MembersCanCreateInternalRepos *bool `json:"members_can_create_internal_repositories,omitempty"`// MembersAllowedRepositoryCreationType denotes if organization members can create repositories// and the type of repositories they can create. Possible values are: "all", "private", or "none".//// Deprecated: Use MembersCanCreatePublicRepos, MembersCanCreatePrivateRepos, MembersCanCreateInternalRepos// instead. The new fields overrides the existing MembersAllowedRepositoryCreationType during 'edit'// operation and does not consider 'internal' repositories during 'get' operationMembersAllowedRepositoryCreationType *string `json:"members_allowed_repository_creation_type,omitempty"`// MembersCanCreatePages toggles whether organization members can create GitHub Pages sites.MembersCanCreatePages *bool `json:"members_can_create_pages,omitempty"`// MembersCanCreatePublicPages toggles whether organization members can create public GitHub Pages sites.MembersCanCreatePublicPages *bool `json:"members_can_create_public_pages,omitempty"`// MembersCanCreatePrivatePages toggles whether organization members can create private GitHub Pages sites.MembersCanCreatePrivatePages *bool `json:"members_can_create_private_pages,omitempty"`// API URLsURL *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 (*Organization)GetAvatarURL¶
func (o *Organization) GetAvatarURL()string
GetAvatarURL returns the AvatarURL field if it's non-nil, zero value otherwise.
func (*Organization)GetBillingEmail¶
func (o *Organization) GetBillingEmail()string
GetBillingEmail returns the BillingEmail field if it's non-nil, zero value otherwise.
func (*Organization)GetBlog¶
func (o *Organization) GetBlog()string
GetBlog returns the Blog field if it's non-nil, zero value otherwise.
func (*Organization)GetCollaborators¶
func (o *Organization) GetCollaborators()int
GetCollaborators returns the Collaborators field if it's non-nil, zero value otherwise.
func (*Organization)GetCompany¶
func (o *Organization) GetCompany()string
GetCompany returns the Company field if it's non-nil, zero value otherwise.
func (*Organization)GetCreatedAt¶
func (o *Organization) GetCreatedAt()time.Time
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*Organization)GetDefaultRepoPermission¶
func (o *Organization) GetDefaultRepoPermission()string
GetDefaultRepoPermission returns the DefaultRepoPermission field if it's non-nil, zero value otherwise.
func (*Organization)GetDefaultRepoSettings¶
func (o *Organization) GetDefaultRepoSettings()string
GetDefaultRepoSettings returns the DefaultRepoSettings field if it's non-nil, zero value otherwise.
func (*Organization)GetDescription¶
func (o *Organization) GetDescription()string
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (*Organization)GetDiskUsage¶
func (o *Organization) GetDiskUsage()int
GetDiskUsage returns the DiskUsage field if it's non-nil, zero value otherwise.
func (*Organization)GetEmail¶
func (o *Organization) GetEmail()string
GetEmail returns the Email field if it's non-nil, zero value otherwise.
func (*Organization)GetEventsURL¶
func (o *Organization) GetEventsURL()string
GetEventsURL returns the EventsURL field if it's non-nil, zero value otherwise.
func (*Organization)GetFollowers¶
func (o *Organization) GetFollowers()int
GetFollowers returns the Followers field if it's non-nil, zero value otherwise.
func (*Organization)GetFollowing¶
func (o *Organization) GetFollowing()int
GetFollowing returns the Following field if it's non-nil, zero value otherwise.
func (*Organization)GetHTMLURL¶
func (o *Organization) GetHTMLURL()string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*Organization)GetHasOrganizationProjects¶
func (o *Organization) GetHasOrganizationProjects()bool
GetHasOrganizationProjects returns the HasOrganizationProjects field if it's non-nil, zero value otherwise.
func (*Organization)GetHasRepositoryProjects¶
func (o *Organization) GetHasRepositoryProjects()bool
GetHasRepositoryProjects returns the HasRepositoryProjects field if it's non-nil, zero value otherwise.
func (*Organization)GetHooksURL¶
func (o *Organization) GetHooksURL()string
GetHooksURL returns the HooksURL field if it's non-nil, zero value otherwise.
func (*Organization)GetID¶
func (o *Organization) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*Organization)GetIsVerified¶
func (o *Organization) GetIsVerified()bool
GetIsVerified returns the IsVerified field if it's non-nil, zero value otherwise.
func (*Organization)GetIssuesURL¶
func (o *Organization) GetIssuesURL()string
GetIssuesURL returns the IssuesURL field if it's non-nil, zero value otherwise.
func (*Organization)GetLocation¶
func (o *Organization) GetLocation()string
GetLocation returns the Location field if it's non-nil, zero value otherwise.
func (*Organization)GetLogin¶
func (o *Organization) GetLogin()string
GetLogin returns the Login field if it's non-nil, zero value otherwise.
func (*Organization)GetMembersAllowedRepositoryCreationType¶
func (o *Organization) GetMembersAllowedRepositoryCreationType()string
GetMembersAllowedRepositoryCreationType returns the MembersAllowedRepositoryCreationType field if it's non-nil, zero value otherwise.
func (*Organization)GetMembersCanCreateInternalRepos¶
func (o *Organization) GetMembersCanCreateInternalRepos()bool
GetMembersCanCreateInternalRepos returns the MembersCanCreateInternalRepos field if it's non-nil, zero value otherwise.
func (*Organization)GetMembersCanCreatePages¶
func (o *Organization) GetMembersCanCreatePages()bool
GetMembersCanCreatePages returns the MembersCanCreatePages field if it's non-nil, zero value otherwise.
func (*Organization)GetMembersCanCreatePrivatePages¶
func (o *Organization) GetMembersCanCreatePrivatePages()bool
GetMembersCanCreatePrivatePages returns the MembersCanCreatePrivatePages field if it's non-nil, zero value otherwise.
func (*Organization)GetMembersCanCreatePrivateRepos¶
func (o *Organization) GetMembersCanCreatePrivateRepos()bool
GetMembersCanCreatePrivateRepos returns the MembersCanCreatePrivateRepos field if it's non-nil, zero value otherwise.
func (*Organization)GetMembersCanCreatePublicPages¶
func (o *Organization) GetMembersCanCreatePublicPages()bool
GetMembersCanCreatePublicPages returns the MembersCanCreatePublicPages field if it's non-nil, zero value otherwise.
func (*Organization)GetMembersCanCreatePublicRepos¶
func (o *Organization) GetMembersCanCreatePublicRepos()bool
GetMembersCanCreatePublicRepos returns the MembersCanCreatePublicRepos field if it's non-nil, zero value otherwise.
func (*Organization)GetMembersCanCreateRepos¶
func (o *Organization) GetMembersCanCreateRepos()bool
GetMembersCanCreateRepos returns the MembersCanCreateRepos field if it's non-nil, zero value otherwise.
func (*Organization)GetMembersURL¶
func (o *Organization) GetMembersURL()string
GetMembersURL returns the MembersURL field if it's non-nil, zero value otherwise.
func (*Organization)GetName¶
func (o *Organization) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*Organization)GetNodeID¶
func (o *Organization) GetNodeID()string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (*Organization)GetOwnedPrivateRepos¶
func (o *Organization) GetOwnedPrivateRepos()int
GetOwnedPrivateRepos returns the OwnedPrivateRepos field if it's non-nil, zero value otherwise.
func (*Organization)GetPrivateGists¶
func (o *Organization) GetPrivateGists()int
GetPrivateGists returns the PrivateGists field if it's non-nil, zero value otherwise.
func (*Organization)GetPublicGists¶
func (o *Organization) GetPublicGists()int
GetPublicGists returns the PublicGists field if it's non-nil, zero value otherwise.
func (*Organization)GetPublicMembersURL¶
func (o *Organization) GetPublicMembersURL()string
GetPublicMembersURL returns the PublicMembersURL field if it's non-nil, zero value otherwise.
func (*Organization)GetPublicRepos¶
func (o *Organization) GetPublicRepos()int
GetPublicRepos returns the PublicRepos field if it's non-nil, zero value otherwise.
func (*Organization)GetReposURL¶
func (o *Organization) GetReposURL()string
GetReposURL returns the ReposURL field if it's non-nil, zero value otherwise.
func (*Organization)GetTotalPrivateRepos¶
func (o *Organization) GetTotalPrivateRepos()int
GetTotalPrivateRepos returns the TotalPrivateRepos field if it's non-nil, zero value otherwise.
func (*Organization)GetTwitterUsername¶
func (o *Organization) GetTwitterUsername()string
GetTwitterUsername returns the TwitterUsername field if it's non-nil, zero value otherwise.
func (*Organization)GetTwoFactorRequirementEnabled¶
func (o *Organization) GetTwoFactorRequirementEnabled()bool
GetTwoFactorRequirementEnabled returns the TwoFactorRequirementEnabled field if it's non-nil, zero value otherwise.
func (*Organization)GetType¶
func (o *Organization) GetType()string
GetType returns the Type field if it's non-nil, zero value otherwise.
func (*Organization)GetURL¶
func (o *Organization) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (*Organization)GetUpdatedAt¶
func (o *Organization) GetUpdatedAt()time.Time
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (Organization)String¶
func (oOrganization) String()string
typeOrganizationEvent¶
type OrganizationEvent struct {// Action is the action that was performed.// Possible values are: "deleted", "renamed", "member_added", "member_removed", or "member_invited".Action *string `json:"action,omitempty"`// Invitation 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 an organization is deleted and renamed, and 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://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#organization
func (*OrganizationEvent)GetAction¶
func (o *OrganizationEvent) GetAction()string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*OrganizationEvent)GetInstallation¶
func (o *OrganizationEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*OrganizationEvent)GetInvitation¶
func (o *OrganizationEvent) GetInvitation() *Invitation
GetInvitation returns the Invitation field.
func (*OrganizationEvent)GetMembership¶
func (o *OrganizationEvent) GetMembership() *Membership
GetMembership returns the Membership field.
func (*OrganizationEvent)GetOrganization¶
func (o *OrganizationEvent) GetOrganization() *Organization
GetOrganization returns the Organization field.
func (*OrganizationEvent)GetSender¶
func (o *OrganizationEvent) GetSender() *User
GetSender returns the Sender field.
typeOrganizationInstallations¶
type OrganizationInstallations struct {TotalCount *int `json:"total_count,omitempty"`Installations []*Installation `json:"installations,omitempty"`}
OrganizationInstallations represents GitHub app installations for an organization.
func (*OrganizationInstallations)GetTotalCount¶
func (o *OrganizationInstallations) GetTotalCount()int
GetTotalCount returns the TotalCount field if it's non-nil, zero value otherwise.
typeOrganizationsListOptions¶
type OrganizationsListOptions struct {// Since filters Organizations by ID.Sinceint64 `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 theOrganizationsService.ListAll method.
typeOrganizationsService¶
type OrganizationsService service
OrganizationsService provides access to the organization related functionsin the GitHub API.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/orgs/
func (*OrganizationsService)BlockUser¶
func (s *OrganizationsService) BlockUser(ctxcontext.Context, orgstring, userstring) (*Response,error)
BlockUser blocks specified user from an organization.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/orgs/#block-a-user-from-an-organization
func (*OrganizationsService)ConcealMembership¶
func (s *OrganizationsService) ConcealMembership(ctxcontext.Context, org, userstring) (*Response,error)
ConcealMembership conceals a user's membership in an organization.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/orgs/#remove-public-organization-membership-for-the-authenticated-user
func (*OrganizationsService)ConvertMemberToOutsideCollaborator¶
func (s *OrganizationsService) ConvertMemberToOutsideCollaborator(ctxcontext.Context, orgstring, userstring) (*Response,error)
ConvertMemberToOutsideCollaborator reduces the permission level of a member of theorganization to that of an outside collaborator. Therefore, they will onlyhave access to the repositories that their current team membership allows.Responses for converting a non-member or the last owner to an outside collaboratorare listed in GitHub API docs.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/orgs/#convert-an-organization-member-to-outside-collaborator
func (*OrganizationsService)CreateHook¶
func (s *OrganizationsService) CreateHook(ctxcontext.Context, orgstring, hook *Hook) (*Hook, *Response,error)
CreateHook creates a Hook for the specified org.Config is a required field.
Note that only a subset of the hook fields are used and hook mustnot be nil.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/orgs/#create-an-organization-webhook
func (*OrganizationsService)CreateOrgInvitation¶
func (s *OrganizationsService) CreateOrgInvitation(ctxcontext.Context, orgstring, opts *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.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/orgs/#create-an-organization-invitation
func (*OrganizationsService)CreateProject¶
func (s *OrganizationsService) CreateProject(ctxcontext.Context, orgstring, opts *ProjectOptions) (*Project, *Response,error)
CreateProject creates a GitHub Project for the specified organization.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/projects/#create-an-organization-project
func (*OrganizationsService)DeleteHook¶
DeleteHook deletes a specified Hook.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/orgs/#delete-an-organization-webhook
func (*OrganizationsService)DeletePackage¶
func (s *OrganizationsService) DeletePackage(ctxcontext.Context, org, packageType, packageNamestring) (*Response,error)
Delete a package from an organization.
GitHub API docs:https://docs.github.com/en/rest/reference/packages#delete-a-package-for-an-organization
func (*OrganizationsService)Edit¶
func (s *OrganizationsService) Edit(ctxcontext.Context, namestring, org *Organization) (*Organization, *Response,error)
Edit an organization.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/orgs/#update-an-organization
func (*OrganizationsService)EditActionsAllowed¶
func (s *OrganizationsService) EditActionsAllowed(ctxcontext.Context, orgstring, actionsAllowedActionsAllowed) (*ActionsAllowed, *Response,error)
EditActionsAllowed sets the actions that are allowed in an organization.
GitHub API docs:https://docs.github.com/en/rest/reference/actions#set-allowed-actions-for-an-organization
func (*OrganizationsService)EditActionsPermissions¶
func (s *OrganizationsService) EditActionsPermissions(ctxcontext.Context, orgstring, actionsPermissionsActionsPermissions) (*ActionsPermissions, *Response,error)
EditActionsPermissions sets the permissions policy for repositories and allowed actions in an organization.
GitHub API docs:https://docs.github.com/en/rest/reference/actions#set-github-actions-permissions-for-an-organization
func (*OrganizationsService)EditHook¶
func (s *OrganizationsService) EditHook(ctxcontext.Context, orgstring, idint64, hook *Hook) (*Hook, *Response,error)
EditHook updates a specified Hook.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/orgs/#update-an-organization-webhook
func (*OrganizationsService)EditOrgMembership¶
func (s *OrganizationsService) EditOrgMembership(ctxcontext.Context, user, orgstring, 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 theauthenticated user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/orgs/#update-an-organization-membership-for-the-authenticated-userGitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/orgs/#set-organization-membership-for-a-user
func (*OrganizationsService)Get¶
func (s *OrganizationsService) Get(ctxcontext.Context, orgstring) (*Organization, *Response,error)
Get fetches an organization by name.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/orgs/#get-an-organization
func (*OrganizationsService)GetActionsAllowed¶
func (s *OrganizationsService) GetActionsAllowed(ctxcontext.Context, orgstring) (*ActionsAllowed, *Response,error)
GetActionsAllowed gets the actions that are allowed in an organization.
GitHub API docs:https://docs.github.com/en/rest/reference/actions#get-allowed-actions-for-an-organization
func (*OrganizationsService)GetActionsPermissions¶
func (s *OrganizationsService) GetActionsPermissions(ctxcontext.Context, orgstring) (*ActionsPermissions, *Response,error)
GetActionsPermissions gets the GitHub Actions permissions policy for repositories and allowed actions in an organization.
GitHub API docs:https://docs.github.com/en/rest/reference/actions#get-github-actions-permissions-for-an-organization
func (*OrganizationsService)GetAuditLog¶
func (s *OrganizationsService) GetAuditLog(ctxcontext.Context, orgstring, opts *GetAuditLogOptions) ([]*AuditEntry, *Response,error)
GetAuditLog gets the audit-log entries for an organization.
GitHub API docs:https://docs.github.com/en/rest/reference/orgs#get-the-audit-log-for-an-organization
func (*OrganizationsService)GetByID¶
func (s *OrganizationsService) GetByID(ctxcontext.Context, idint64) (*Organization, *Response,error)
GetByID fetches an organization.
Note: GetByID uses the undocumented GitHub API endpoint /organizations/:id.
func (*OrganizationsService)GetHook¶
func (s *OrganizationsService) GetHook(ctxcontext.Context, orgstring, idint64) (*Hook, *Response,error)
GetHook returns a single specified Hook.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/orgs/#get-an-organization-webhook
func (*OrganizationsService)GetHookDelivery¶
func (s *OrganizationsService) GetHookDelivery(ctxcontext.Context, ownerstring, hookID, deliveryIDint64) (*HookDelivery, *Response,error)
GetHookDelivery returns a delivery for a webhook configured in an organization.
GitHub API docs:https://docs.github.com/en/rest/reference/orgs#get-a-webhook-delivery-for-an-organization-webhook
func (*OrganizationsService)GetOrgMembership¶
func (s *OrganizationsService) GetOrgMembership(ctxcontext.Context, user, orgstring) (*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 theauthenticated user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/orgs/#get-an-organization-membership-for-the-authenticated-userGitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/orgs/#get-organization-membership-for-a-user
func (*OrganizationsService)GetPackage¶
func (s *OrganizationsService) GetPackage(ctxcontext.Context, org, packageType, packageNamestring) (*Package, *Response,error)
Get a package by name from an organization.
GitHub API docs:https://docs.github.com/en/rest/reference/packages#get-a-package-for-an-organization
func (*OrganizationsService)IsBlocked¶
func (s *OrganizationsService) IsBlocked(ctxcontext.Context, orgstring, userstring) (bool, *Response,error)
IsBlocked reports whether specified user is blocked from an organization.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/orgs/#check-if-a-user-is-blocked-by-an-organization
func (*OrganizationsService)IsMember¶
func (s *OrganizationsService) IsMember(ctxcontext.Context, org, userstring) (bool, *Response,error)
IsMember checks if a user is a member of an organization.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/orgs/#check-organization-membership-for-a-user
func (*OrganizationsService)IsPublicMember¶
func (s *OrganizationsService) IsPublicMember(ctxcontext.Context, org, userstring) (bool, *Response,error)
IsPublicMember checks if a user is a public member of an organization.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/orgs/#check-public-organization-membership-for-a-user
func (*OrganizationsService)List¶
func (s *OrganizationsService) List(ctxcontext.Context, userstring, opts *ListOptions) ([]*Organization, *Response,error)
List the organizations for a user. Passing the empty string will listorganizations for the authenticated user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/orgs/#list-organizations-for-the-authenticated-userGitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/orgs/#list-organizations-for-a-user
func (*OrganizationsService)ListAll¶
func (s *OrganizationsService) ListAll(ctxcontext.Context, opts *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 continuelisting the next set of organizations, use the ID of the last-returned organizationas the opts.Since parameter for the next call.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/orgs/#list-organizations
func (*OrganizationsService)ListBlockedUsers¶
func (s *OrganizationsService) ListBlockedUsers(ctxcontext.Context, orgstring, opts *ListOptions) ([]*User, *Response,error)
ListBlockedUsers lists all the users blocked by an organization.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/orgs/#list-users-blocked-by-an-organization
func (*OrganizationsService)ListFailedOrgInvitations¶
func (s *OrganizationsService) ListFailedOrgInvitations(ctxcontext.Context, orgstring, opts *ListOptions) ([]*Invitation, *Response,error)
ListFailedOrgInvitations returns a list of failed inviatations.
GitHub API docs:https://docs.github.com/en/rest/reference/orgs#list-failed-organization-invitations
func (*OrganizationsService)ListHookDeliveries¶
func (s *OrganizationsService) ListHookDeliveries(ctxcontext.Context, orgstring, idint64, opts *ListCursorOptions) ([]*HookDelivery, *Response,error)
ListHookDeliveries lists webhook deliveries for a webhook configured in an organization.
GitHub API docs:https://docs.github.com/en/rest/reference/orgs#list-deliveries-for-an-organization-webhook
func (*OrganizationsService)ListHooks¶
func (s *OrganizationsService) ListHooks(ctxcontext.Context, orgstring, opts *ListOptions) ([]*Hook, *Response,error)
ListHooks lists all Hooks for the specified organization.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/orgs/#list-organization-webhooks
func (*OrganizationsService)ListInstallations¶
func (s *OrganizationsService) ListInstallations(ctxcontext.Context, orgstring, opts *ListOptions) (*OrganizationInstallations, *Response,error)
ListInstallations lists installations for an organization.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/orgs/#list-app-installations-for-an-organization
func (*OrganizationsService)ListMembers¶
func (s *OrganizationsService) ListMembers(ctxcontext.Context, orgstring, opts *ListMembersOptions) ([]*User, *Response,error)
ListMembers lists the members for an organization. If the authenticateduser is an owner of the organization, this will return both concealed andpublic members, otherwise it will only return public members.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/orgs/#list-organization-membersGitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/orgs/#list-public-organization-members
func (*OrganizationsService)ListOrgInvitationTeams¶
func (s *OrganizationsService) ListOrgInvitationTeams(ctxcontext.Context, org, invitationIDstring, opts *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://docs.github.com/en/free-pro-team@latest/rest/reference/orgs/#list-organization-invitation-teams
func (*OrganizationsService)ListOrgMemberships¶
func (s *OrganizationsService) ListOrgMemberships(ctxcontext.Context, opts *ListOrgMembershipsOptions) ([]*Membership, *Response,error)
ListOrgMemberships lists the organization memberships for the authenticated user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/orgs/#list-organization-memberships-for-the-authenticated-user
func (*OrganizationsService)ListOutsideCollaborators¶
func (s *OrganizationsService) ListOutsideCollaborators(ctxcontext.Context, orgstring, opts *ListOutsideCollaboratorsOptions) ([]*User, *Response,error)
ListOutsideCollaborators lists outside collaborators of organization's repositories.This will only work if the authenticateduser 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://docs.github.com/en/free-pro-team@latest/rest/reference/orgs/#list-outside-collaborators-for-an-organization
func (*OrganizationsService)ListPackages¶
func (s *OrganizationsService) ListPackages(ctxcontext.Context, orgstring, opts *PackageListOptions) ([]*Package, *Response,error)
List the packages for an organization.
GitHub API docs:https://docs.github.com/en/rest/reference/packages#list-packages-for-an-organization
func (*OrganizationsService)ListPendingOrgInvitations¶
func (s *OrganizationsService) ListPendingOrgInvitations(ctxcontext.Context, orgstring, opts *ListOptions) ([]*Invitation, *Response,error)
ListPendingOrgInvitations returns a list of pending invitations.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/orgs/#list-pending-organization-invitations
func (*OrganizationsService)ListProjects¶
func (s *OrganizationsService) ListProjects(ctxcontext.Context, orgstring, opts *ProjectListOptions) ([]*Project, *Response,error)
ListProjects lists the projects for an organization.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/projects/#list-organization-projects
func (*OrganizationsService)PackageDeleteVersion¶
func (s *OrganizationsService) PackageDeleteVersion(ctxcontext.Context, org, packageType, packageNamestring, packageVersionIDint64) (*Response,error)
Delete a package version from an organization.
GitHub API docs:https://docs.github.com/en/rest/reference/packages#delete-package-version-for-an-organization
func (*OrganizationsService)PackageGetAllVersions¶
func (s *OrganizationsService) PackageGetAllVersions(ctxcontext.Context, org, packageType, packageNamestring, opts *PackageListOptions) ([]*PackageVersion, *Response,error)
Get all versions of a package in an organization.
GitHub API docs:https://docs.github.com/en/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-an-organization
func (*OrganizationsService)PackageGetVersion¶
func (s *OrganizationsService) PackageGetVersion(ctxcontext.Context, org, packageType, packageNamestring, packageVersionIDint64) (*PackageVersion, *Response,error)
Get a specific version of a package in an organization.
GitHub API docs:https://docs.github.com/en/rest/reference/packages#get-a-package-version-for-an-organization
func (*OrganizationsService)PackageRestoreVersion¶
func (s *OrganizationsService) PackageRestoreVersion(ctxcontext.Context, org, packageType, packageNamestring, packageVersionIDint64) (*Response,error)
Restore a package version to an organization.
GitHub API docs:https://docs.github.com/en/rest/reference/packages#restore-package-version-for-an-organization
func (*OrganizationsService)PingHook¶
PingHook triggers a 'ping' event to be sent to the Hook.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/orgs/#ping-an-organization-webhook
func (*OrganizationsService)PublicizeMembership¶
func (s *OrganizationsService) PublicizeMembership(ctxcontext.Context, org, userstring) (*Response,error)
PublicizeMembership publicizes a user's membership in an organization. (Auser cannot publicize the membership for another user.)
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/orgs/#set-public-organization-membership-for-the-authenticated-user
func (*OrganizationsService)RedeliverHookDelivery¶
func (s *OrganizationsService) RedeliverHookDelivery(ctxcontext.Context, ownerstring, hookID, deliveryIDint64) (*HookDelivery, *Response,error)
RedeliverHookDelivery redelivers a delivery for a webhook configured in an organization.
GitHub API docs:https://docs.github.com/en/rest/reference/orgs#redeliver-a-delivery-for-an-organization-webhook
func (*OrganizationsService)RemoveMember¶
RemoveMember removes a user from all teams of an organization.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/orgs/#remove-an-organization-member
func (*OrganizationsService)RemoveOrgMembership¶
func (s *OrganizationsService) RemoveOrgMembership(ctxcontext.Context, user, orgstring) (*Response,error)
RemoveOrgMembership removes user from the specified organization. If theuser has been invited to the organization, this will cancel their invitation.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/orgs/#remove-organization-membership-for-a-user
func (*OrganizationsService)RemoveOutsideCollaborator¶
func (s *OrganizationsService) RemoveOutsideCollaborator(ctxcontext.Context, orgstring, userstring) (*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://docs.github.com/en/free-pro-team@latest/rest/reference/orgs/#remove-outside-collaborator-from-an-organization
func (*OrganizationsService)RestorePackage¶
func (s *OrganizationsService) RestorePackage(ctxcontext.Context, org, packageType, packageNamestring) (*Response,error)
Restore a package to an organization.
GitHub API docs:https://docs.github.com/en/rest/reference/packages#restore-a-package-for-an-organization
func (*OrganizationsService)UnblockUser¶
func (s *OrganizationsService) UnblockUser(ctxcontext.Context, orgstring, userstring) (*Response,error)
UnblockUser unblocks specified user from an organization.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/orgs/#unblock-a-user-from-an-organization
typePRLink¶
type PRLink struct {HRef *string `json:"href,omitempty"`}
PRLink represents a single link object from GitHub pull request _links.
typePRLinks¶
type PRLinks struct {Self *PRLink `json:"self,omitempty"`HTML *PRLink `json:"html,omitempty"`Issue *PRLink `json:"issue,omitempty"`Comments *PRLink `json:"comments,omitempty"`ReviewComments *PRLink `json:"review_comments,omitempty"`ReviewComment *PRLink `json:"review_comment,omitempty"`Commits *PRLink `json:"commits,omitempty"`Statuses *PRLink `json:"statuses,omitempty"`}
PRLinks represents the "_links" object in a GitHub pull request.
func (*PRLinks)GetComments¶
GetComments returns the Comments field.
func (*PRLinks)GetCommits¶
GetCommits returns the Commits field.
func (*PRLinks)GetReviewComment¶
GetReviewComment returns the ReviewComment field.
func (*PRLinks)GetReviewComments¶
GetReviewComments returns the ReviewComments field.
func (*PRLinks)GetStatuses¶
GetStatuses returns the Statuses field.
typePackage¶
type Package struct {ID *int64 `json:"id,omitempty"`Name *string `json:"name,omitempty"`PackageType *string `json:"package_type,omitempty"`HTMLURL *string `json:"html_url,omitempty"`CreatedAt *Timestamp `json:"created_at,omitempty"`UpdatedAt *Timestamp `json:"updated_at,omitempty"`Owner *User `json:"owner,omitempty"`PackageVersion *PackageVersion `json:"package_version,omitempty"`Registry *PackageRegistry `json:"registry,omitempty"`URL *string `json:"url,omitempty"`VersionCount *int64 `json:"version_count,omitempty"`Visibility *string `json:"visibility,omitempty"`Repository *Repository `json:"repository,omitempty"`}
Package represents a GitHub package.
func (*Package)GetCreatedAt¶
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*Package)GetHTMLURL¶
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*Package)GetPackageType¶
GetPackageType returns the PackageType field if it's non-nil, zero value otherwise.
func (*Package)GetPackageVersion¶
func (p *Package) GetPackageVersion() *PackageVersion
GetPackageVersion returns the PackageVersion field.
func (*Package)GetRegistry¶
func (p *Package) GetRegistry() *PackageRegistry
GetRegistry returns the Registry field.
func (*Package)GetRepository¶
func (p *Package) GetRepository() *Repository
GetRepository returns the Repository field.
func (*Package)GetUpdatedAt¶
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (*Package)GetVersionCount¶
GetVersionCount returns the VersionCount field if it's non-nil, zero value otherwise.
func (*Package)GetVisibility¶
GetVisibility returns the Visibility field if it's non-nil, zero value otherwise.
typePackageBilling¶
type PackageBilling struct {TotalGigabytesBandwidthUsedint `json:"total_gigabytes_bandwidth_used"`TotalPaidGigabytesBandwidthUsedint `json:"total_paid_gigabytes_bandwidth_used"`IncludedGigabytesBandwidthint `json:"included_gigabytes_bandwidth"`}
PackageBilling represents a GitHub Package billing.
typePackageContainerMetadata¶
type PackageContainerMetadata struct {Tags []string `json:"tags,omitempty"`}
PackageContainerMetadata represents container metadata for docker container packages.
func (PackageContainerMetadata)String¶
func (rPackageContainerMetadata) String()string
typePackageEvent¶
type PackageEvent struct {// Action is the action that was performed.// Can be "published" or "updated".Action *string `json:"action,omitempty"`Package *Package `json:"package,omitempty"`Repo *Repository `json:"repository,omitempty"`Org *Organization `json:"organization,omitempty"`Sender *User `json:"sender,omitempty"`// The following fields are only populated by Webhook events.Installation *Installation `json:"installation,omitempty"`}
PackageEvent represents activity related to GitHub Packages.The Webhook event name is "package".
This event is triggered when a GitHub Package is published or updated.
GitHub API docs:https://developer.github.com/webhooks/event-payloads/#package
func (*PackageEvent)GetAction¶
func (p *PackageEvent) GetAction()string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*PackageEvent)GetInstallation¶
func (p *PackageEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*PackageEvent)GetOrg¶
func (p *PackageEvent) GetOrg() *Organization
GetOrg returns the Org field.
func (*PackageEvent)GetPackage¶
func (p *PackageEvent) GetPackage() *Package
GetPackage returns the Package field.
func (*PackageEvent)GetRepo¶
func (p *PackageEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (*PackageEvent)GetSender¶
func (p *PackageEvent) GetSender() *User
GetSender returns the Sender field.
typePackageFile¶
type PackageFile struct {DownloadURL *string `json:"download_url,omitempty"`ID *int64 `json:"id,omitempty"`Name *string `json:"name,omitempty"`SHA256 *string `json:"sha256,omitempty"`SHA1 *string `json:"sha1,omitempty"`MD5 *string `json:"md5,omitempty"`ContentType *string `json:"content_type,omitempty"`State *string `json:"state,omitempty"`Author *User `json:"author,omitempty"`Size *int64 `json:"size,omitempty"`CreatedAt *Timestamp `json:"created_at,omitempty"`UpdatedAt *Timestamp `json:"updated_at,omitempty"`}
PackageFile represents a GitHub package version release file.
func (*PackageFile)GetAuthor¶
func (p *PackageFile) GetAuthor() *User
GetAuthor returns the Author field.
func (*PackageFile)GetContentType¶
func (p *PackageFile) GetContentType()string
GetContentType returns the ContentType field if it's non-nil, zero value otherwise.
func (*PackageFile)GetCreatedAt¶
func (p *PackageFile) GetCreatedAt()Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*PackageFile)GetDownloadURL¶
func (p *PackageFile) GetDownloadURL()string
GetDownloadURL returns the DownloadURL field if it's non-nil, zero value otherwise.
func (*PackageFile)GetID¶
func (p *PackageFile) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*PackageFile)GetMD5¶
func (p *PackageFile) GetMD5()string
GetMD5 returns the MD5 field if it's non-nil, zero value otherwise.
func (*PackageFile)GetName¶
func (p *PackageFile) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*PackageFile)GetSHA1¶
func (p *PackageFile) GetSHA1()string
GetSHA1 returns the SHA1 field if it's non-nil, zero value otherwise.
func (*PackageFile)GetSHA256¶
func (p *PackageFile) GetSHA256()string
GetSHA256 returns the SHA256 field if it's non-nil, zero value otherwise.
func (*PackageFile)GetSize¶
func (p *PackageFile) GetSize()int64
GetSize returns the Size field if it's non-nil, zero value otherwise.
func (*PackageFile)GetState¶
func (p *PackageFile) GetState()string
GetState returns the State field if it's non-nil, zero value otherwise.
func (*PackageFile)GetUpdatedAt¶
func (p *PackageFile) GetUpdatedAt()Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (PackageFile)String¶
func (pfPackageFile) String()string
typePackageListOptions¶
type PackageListOptions struct {// Visibility of packages "public", "internal" or "private".Visibility *string `url:"visibility,omitempty"`// PackageType represents the type of package.// It can be one of "npm", "maven", "rubygems", "nuget", "docker", or "container".PackageType *string `url:"package_type,omitempty"`// State of package either "active" or "deleted".State *string `url:"state,omitempty"`ListOptions}
PackageListOptions represents the optional list options for a package.
func (*PackageListOptions)GetPackageType¶
func (p *PackageListOptions) GetPackageType()string
GetPackageType returns the PackageType field if it's non-nil, zero value otherwise.
func (*PackageListOptions)GetState¶
func (p *PackageListOptions) GetState()string
GetState returns the State field if it's non-nil, zero value otherwise.
func (*PackageListOptions)GetVisibility¶
func (p *PackageListOptions) GetVisibility()string
GetVisibility returns the Visibility field if it's non-nil, zero value otherwise.
typePackageMetadata¶
type PackageMetadata struct {PackageType *string `json:"package_type,omitempty"`Container *PackageContainerMetadata `json:"container,omitempty"`}
PackageMetadata represents metadata from a package.
func (*PackageMetadata)GetContainer¶
func (p *PackageMetadata) GetContainer() *PackageContainerMetadata
GetContainer returns the Container field.
func (*PackageMetadata)GetPackageType¶
func (p *PackageMetadata) GetPackageType()string
GetPackageType returns the PackageType field if it's non-nil, zero value otherwise.
func (PackageMetadata)String¶
func (rPackageMetadata) String()string
typePackageRegistry¶
type PackageRegistry struct {AboutURL *string `json:"about_url,omitempty"`Name *string `json:"name,omitempty"`Type *string `json:"type,omitempty"`URL *string `json:"url,omitempty"`Vendor *string `json:"vendor,omitempty"`}
PackageRegistry represents a GitHub package registry.
func (*PackageRegistry)GetAboutURL¶
func (p *PackageRegistry) GetAboutURL()string
GetAboutURL returns the AboutURL field if it's non-nil, zero value otherwise.
func (*PackageRegistry)GetName¶
func (p *PackageRegistry) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*PackageRegistry)GetType¶
func (p *PackageRegistry) GetType()string
GetType returns the Type field if it's non-nil, zero value otherwise.
func (*PackageRegistry)GetURL¶
func (p *PackageRegistry) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (*PackageRegistry)GetVendor¶
func (p *PackageRegistry) GetVendor()string
GetVendor returns the Vendor field if it's non-nil, zero value otherwise.
func (PackageRegistry)String¶
func (rPackageRegistry) String()string
typePackageRelease¶
type PackageRelease struct {URL *string `json:"url,omitempty"`HTMLURL *string `json:"html_url,omitempty"`ID *int64 `json:"id,omitempty"`TagName *string `json:"tag_name,omitempty"`TargetCommitish *string `json:"target_commitish,omitempty"`Name *string `json:"name,omitempty"`Draft *bool `json:"draft,omitempty"`Author *User `json:"author,omitempty"`Prerelease *bool `json:"prerelease,omitempty"`CreatedAt *Timestamp `json:"created_at,omitempty"`PublishedAt *Timestamp `json:"published_at,omitempty"`}
PackageRelease represents a GitHub package version release.
func (*PackageRelease)GetAuthor¶
func (p *PackageRelease) GetAuthor() *User
GetAuthor returns the Author field.
func (*PackageRelease)GetCreatedAt¶
func (p *PackageRelease) GetCreatedAt()Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*PackageRelease)GetDraft¶
func (p *PackageRelease) GetDraft()bool
GetDraft returns the Draft field if it's non-nil, zero value otherwise.
func (*PackageRelease)GetHTMLURL¶
func (p *PackageRelease) GetHTMLURL()string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*PackageRelease)GetID¶
func (p *PackageRelease) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*PackageRelease)GetName¶
func (p *PackageRelease) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*PackageRelease)GetPrerelease¶
func (p *PackageRelease) GetPrerelease()bool
GetPrerelease returns the Prerelease field if it's non-nil, zero value otherwise.
func (*PackageRelease)GetPublishedAt¶
func (p *PackageRelease) GetPublishedAt()Timestamp
GetPublishedAt returns the PublishedAt field if it's non-nil, zero value otherwise.
func (*PackageRelease)GetTagName¶
func (p *PackageRelease) GetTagName()string
GetTagName returns the TagName field if it's non-nil, zero value otherwise.
func (*PackageRelease)GetTargetCommitish¶
func (p *PackageRelease) GetTargetCommitish()string
GetTargetCommitish returns the TargetCommitish field if it's non-nil, zero value otherwise.
func (*PackageRelease)GetURL¶
func (p *PackageRelease) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (PackageRelease)String¶
func (rPackageRelease) String()string
typePackageVersion¶
type PackageVersion struct {ID *int64 `json:"id,omitempty"`Version *string `json:"version,omitempty"`Summary *string `json:"summary,omitempty"`Body *string `json:"body,omitempty"`BodyHTML *string `json:"body_html,omitempty"`Release *PackageRelease `json:"release,omitempty"`Manifest *string `json:"manifest,omitempty"`HTMLURL *string `json:"html_url,omitempty"`TagName *string `json:"tag_name,omitempty"`TargetCommitish *string `json:"target_commitish,omitempty"`TargetOID *string `json:"target_oid,omitempty"`Draft *bool `json:"draft,omitempty"`Prerelease *bool `json:"prerelease,omitempty"`CreatedAt *Timestamp `json:"created_at,omitempty"`UpdatedAt *Timestamp `json:"updated_at,omitempty"`PackageFiles []*PackageFile `json:"package_files,omitempty"`Author *User `json:"author,omitempty"`InstallationCommand *string `json:"installation_command,omitempty"`Metadata *PackageMetadata `json:"metadata,omitempty"`PackageHTMLURL *string `json:"package_html_url,omitempty"`Name *string `json:"name,omitempty"`URL *string `json:"url,omitempty"`}
PackageVersion represents a GitHub package version.
func (*PackageVersion)GetAuthor¶
func (p *PackageVersion) GetAuthor() *User
GetAuthor returns the Author field.
func (*PackageVersion)GetBody¶
func (p *PackageVersion) GetBody()string
GetBody returns the Body field if it's non-nil, zero value otherwise.
func (*PackageVersion)GetBodyHTML¶
func (p *PackageVersion) GetBodyHTML()string
GetBodyHTML returns the BodyHTML field if it's non-nil, zero value otherwise.
func (*PackageVersion)GetCreatedAt¶
func (p *PackageVersion) GetCreatedAt()Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*PackageVersion)GetDraft¶
func (p *PackageVersion) GetDraft()bool
GetDraft returns the Draft field if it's non-nil, zero value otherwise.
func (*PackageVersion)GetHTMLURL¶
func (p *PackageVersion) GetHTMLURL()string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*PackageVersion)GetID¶
func (p *PackageVersion) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*PackageVersion)GetInstallationCommand¶
func (p *PackageVersion) GetInstallationCommand()string
GetInstallationCommand returns the InstallationCommand field if it's non-nil, zero value otherwise.
func (*PackageVersion)GetManifest¶
func (p *PackageVersion) GetManifest()string
GetManifest returns the Manifest field if it's non-nil, zero value otherwise.
func (*PackageVersion)GetMetadata¶
func (p *PackageVersion) GetMetadata() *PackageMetadata
GetMetadata returns the Metadata field.
func (*PackageVersion)GetName¶
func (p *PackageVersion) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*PackageVersion)GetPackageHTMLURL¶
func (p *PackageVersion) GetPackageHTMLURL()string
GetPackageHTMLURL returns the PackageHTMLURL field if it's non-nil, zero value otherwise.
func (*PackageVersion)GetPrerelease¶
func (p *PackageVersion) GetPrerelease()bool
GetPrerelease returns the Prerelease field if it's non-nil, zero value otherwise.
func (*PackageVersion)GetRelease¶
func (p *PackageVersion) GetRelease() *PackageRelease
GetRelease returns the Release field.
func (*PackageVersion)GetSummary¶
func (p *PackageVersion) GetSummary()string
GetSummary returns the Summary field if it's non-nil, zero value otherwise.
func (*PackageVersion)GetTagName¶
func (p *PackageVersion) GetTagName()string
GetTagName returns the TagName field if it's non-nil, zero value otherwise.
func (*PackageVersion)GetTargetCommitish¶
func (p *PackageVersion) GetTargetCommitish()string
GetTargetCommitish returns the TargetCommitish field if it's non-nil, zero value otherwise.
func (*PackageVersion)GetTargetOID¶
func (p *PackageVersion) GetTargetOID()string
GetTargetOID returns the TargetOID field if it's non-nil, zero value otherwise.
func (*PackageVersion)GetURL¶
func (p *PackageVersion) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (*PackageVersion)GetUpdatedAt¶
func (p *PackageVersion) GetUpdatedAt()Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (*PackageVersion)GetVersion¶
func (p *PackageVersion) GetVersion()string
GetVersion returns the Version field if it's non-nil, zero value otherwise.
func (PackageVersion)String¶
func (pvPackageVersion) String()string
typePage¶
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 (*Page)GetHTMLURL¶
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*Page)GetPageName¶
GetPageName returns the PageName field if it's non-nil, zero value otherwise.
func (*Page)GetSummary¶
GetSummary returns the Summary field if it's non-nil, zero value otherwise.
typePageBuildEvent¶
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, whethersuccessful or not.The Webhook event name is "page_build".
This event is triggered on push to a GitHub Pages enabled branch (gh-pagesfor 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://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#page_build
func (*PageBuildEvent)GetBuild¶
func (p *PageBuildEvent) GetBuild() *PagesBuild
GetBuild returns the Build field.
func (*PageBuildEvent)GetID¶
func (p *PageBuildEvent) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*PageBuildEvent)GetInstallation¶
func (p *PageBuildEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*PageBuildEvent)GetRepo¶
func (p *PageBuildEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (*PageBuildEvent)GetSender¶
func (p *PageBuildEvent) GetSender() *User
GetSender returns the Sender field.
typePageStats¶
type PageStats struct {TotalPages *int `json:"total_pages,omitempty"`}
PageStats represents the total number of github pages.
func (*PageStats)GetTotalPages¶
GetTotalPages returns the TotalPages field if it's non-nil, zero value otherwise.
typePages¶
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"`Source *PagesSource `json:"source,omitempty"`Public *bool `json:"public,omitempty"`HTTPSCertificate *PagesHTTPSCertificate `json:"https_certificate,omitempty"`HTTPSEnforced *bool `json:"https_enforced,omitempty"`}
Pages represents a GitHub Pages site configuration.
func (*Pages)GetCustom404¶
GetCustom404 returns the Custom404 field if it's non-nil, zero value otherwise.
func (*Pages)GetHTMLURL¶
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*Pages)GetHTTPSCertificate¶
func (p *Pages) GetHTTPSCertificate() *PagesHTTPSCertificate
GetHTTPSCertificate returns the HTTPSCertificate field.
func (*Pages)GetHTTPSEnforced¶
GetHTTPSEnforced returns the HTTPSEnforced field if it's non-nil, zero value otherwise.
typePagesBuild¶
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 (*PagesBuild)GetCommit¶
func (p *PagesBuild) GetCommit()string
GetCommit returns the Commit field if it's non-nil, zero value otherwise.
func (*PagesBuild)GetCreatedAt¶
func (p *PagesBuild) GetCreatedAt()Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*PagesBuild)GetDuration¶
func (p *PagesBuild) GetDuration()int
GetDuration returns the Duration field if it's non-nil, zero value otherwise.
func (*PagesBuild)GetError¶
func (p *PagesBuild) GetError() *PagesError
GetError returns the Error field.
func (*PagesBuild)GetPusher¶
func (p *PagesBuild) GetPusher() *User
GetPusher returns the Pusher field.
func (*PagesBuild)GetStatus¶
func (p *PagesBuild) GetStatus()string
GetStatus returns the Status field if it's non-nil, zero value otherwise.
func (*PagesBuild)GetURL¶
func (p *PagesBuild) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (*PagesBuild)GetUpdatedAt¶
func (p *PagesBuild) GetUpdatedAt()Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
typePagesError¶
type PagesError struct {Message *string `json:"message,omitempty"`}
PagesError represents a build error for a GitHub Pages site.
func (*PagesError)GetMessage¶
func (p *PagesError) GetMessage()string
GetMessage returns the Message field if it's non-nil, zero value otherwise.
typePagesHTTPSCertificate¶
type PagesHTTPSCertificate struct {State *string `json:"state,omitempty"`Description *string `json:"description,omitempty"`Domains []string `json:"domains,omitempty"`// GitHub's API doesn't return a standard Timestamp, rather it returns a YYYY-MM-DD string.ExpiresAt *string `json:"expires_at,omitempty"`}
PagesHTTPSCertificate represents the HTTPS Certificate information for a GitHub Pages site.
func (*PagesHTTPSCertificate)GetDescription¶
func (p *PagesHTTPSCertificate) GetDescription()string
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (*PagesHTTPSCertificate)GetExpiresAt¶
func (p *PagesHTTPSCertificate) GetExpiresAt()string
GetExpiresAt returns the ExpiresAt field if it's non-nil, zero value otherwise.
func (*PagesHTTPSCertificate)GetState¶
func (p *PagesHTTPSCertificate) GetState()string
GetState returns the State field if it's non-nil, zero value otherwise.
typePagesSource¶
type PagesSource struct {Branch *string `json:"branch,omitempty"`Path *string `json:"path,omitempty"`}
PagesSource represents a GitHub page's source.
func (*PagesSource)GetBranch¶
func (p *PagesSource) GetBranch()string
GetBranch returns the Branch field if it's non-nil, zero value otherwise.
func (*PagesSource)GetPath¶
func (p *PagesSource) GetPath()string
GetPath returns the Path field if it's non-nil, zero value otherwise.
typePagesUpdate¶
type PagesUpdate struct {// CNAME represents a custom domain for the repository.// Leaving CNAME empty will remove the custom domain.CNAME *string `json:"cname"`// Source must include the branch name, and may optionally specify the subdirectory "/docs".// Possible values are: "gh-pages", "master", and "master /docs".Source *string `json:"source,omitempty"`// Public configures access controls for the site.// If "true", the site will be accessible to anyone on the internet. If "false",// the site will be accessible to anyone with read access to the repository that// published the site.Public *bool `json:"public,omitempty"`// HTTPSEnforced specifies whether HTTPS should be enforced for the repository.HTTPSEnforced *bool `json:"https_enforced,omitempty"`}
PagesUpdate sets up parameters needed to update a GitHub Pages site.
func (*PagesUpdate)GetCNAME¶
func (p *PagesUpdate) GetCNAME()string
GetCNAME returns the CNAME field if it's non-nil, zero value otherwise.
func (*PagesUpdate)GetHTTPSEnforced¶
func (p *PagesUpdate) GetHTTPSEnforced()bool
GetHTTPSEnforced returns the HTTPSEnforced field if it's non-nil, zero value otherwise.
func (*PagesUpdate)GetPublic¶
func (p *PagesUpdate) GetPublic()bool
GetPublic returns the Public field if it's non-nil, zero value otherwise.
func (*PagesUpdate)GetSource¶
func (p *PagesUpdate) GetSource()string
GetSource returns the Source field if it's non-nil, zero value otherwise.
typePingEvent¶
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 (*PingEvent)GetHookID¶
GetHookID returns the HookID field if it's non-nil, zero value otherwise.
func (*PingEvent)GetInstallation¶
func (p *PingEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
typePlan¶
type Plan struct {Name *string `json:"name,omitempty"`Space *int `json:"space,omitempty"`Collaborators *int `json:"collaborators,omitempty"`PrivateRepos *int `json:"private_repos,omitempty"`FilledSeats *int `json:"filled_seats,omitempty"`Seats *int `json:"seats,omitempty"`}
Plan represents the payment plan for an account. See plans athttps://github.com/plans.
func (*Plan)GetCollaborators¶
GetCollaborators returns the Collaborators field if it's non-nil, zero value otherwise.
func (*Plan)GetFilledSeats¶
GetFilledSeats returns the FilledSeats field if it's non-nil, zero value otherwise.
func (*Plan)GetPrivateRepos¶
GetPrivateRepos returns the PrivateRepos field if it's non-nil, zero value otherwise.
typePreReceiveHook¶
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 (*PreReceiveHook)GetConfigURL¶
func (p *PreReceiveHook) GetConfigURL()string
GetConfigURL returns the ConfigURL field if it's non-nil, zero value otherwise.
func (*PreReceiveHook)GetEnforcement¶
func (p *PreReceiveHook) GetEnforcement()string
GetEnforcement returns the Enforcement field if it's non-nil, zero value otherwise.
func (*PreReceiveHook)GetID¶
func (p *PreReceiveHook) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*PreReceiveHook)GetName¶
func (p *PreReceiveHook) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (PreReceiveHook)String¶
func (pPreReceiveHook) String()string
typePreferenceList¶
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
typeProject¶
type Project struct {ID *int64 `json:"id,omitempty"`URL *string `json:"url,omitempty"`HTMLURL *string `json:"html_url,omitempty"`ColumnsURL *string `json:"columns_url,omitempty"`OwnerURL *string `json:"owner_url,omitempty"`Name *string `json:"name,omitempty"`Body *string `json:"body,omitempty"`Number *int `json:"number,omitempty"`State *string `json:"state,omitempty"`CreatedAt *Timestamp `json:"created_at,omitempty"`UpdatedAt *Timestamp `json:"updated_at,omitempty"`NodeID *string `json:"node_id,omitempty"`OrganizationPermission *string `json:"organization_permission,omitempty"`Private *bool `json:"private,omitempty"`// The User object that generated the project.Creator *User `json:"creator,omitempty"`}
Project represents a GitHub Project.
func (*Project)GetColumnsURL¶
GetColumnsURL returns the ColumnsURL field if it's non-nil, zero value otherwise.
func (*Project)GetCreatedAt¶
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*Project)GetHTMLURL¶
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*Project)GetOrganizationPermission¶
GetOrganizationPermission returns the OrganizationPermission field if it's non-nil, zero value otherwise.
func (*Project)GetOwnerURL¶
GetOwnerURL returns the OwnerURL field if it's non-nil, zero value otherwise.
func (*Project)GetPrivate¶
GetPrivate returns the Private field if it's non-nil, zero value otherwise.
func (*Project)GetUpdatedAt¶
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
typeProjectBody¶
type ProjectBody struct {From *string `json:"from,omitempty"`}
ProjectBody represents a project body change.
func (*ProjectBody)GetFrom¶
func (p *ProjectBody) GetFrom()string
GetFrom returns the From field if it's non-nil, zero value otherwise.
typeProjectCard¶
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"`// The following fields are only populated by Events API.ProjectID *int64 `json:"project_id,omitempty"`ProjectURL *string `json:"project_url,omitempty"`ColumnName *string `json:"column_name,omitempty"`PreviousColumnName *string `json:"previous_column_name,omitempty"`// Populated in "moved_columns_in_project" event deliveries.}
ProjectCard represents a card in a column of a GitHub Project.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/projects/cards/#get-a-project-card
func (*ProjectCard)GetArchived¶
func (p *ProjectCard) GetArchived()bool
GetArchived returns the Archived field if it's non-nil, zero value otherwise.
func (*ProjectCard)GetColumnID¶
func (p *ProjectCard) GetColumnID()int64
GetColumnID returns the ColumnID field if it's non-nil, zero value otherwise.
func (*ProjectCard)GetColumnName¶
func (p *ProjectCard) GetColumnName()string
GetColumnName returns the ColumnName field if it's non-nil, zero value otherwise.
func (*ProjectCard)GetColumnURL¶
func (p *ProjectCard) GetColumnURL()string
GetColumnURL returns the ColumnURL field if it's non-nil, zero value otherwise.
func (*ProjectCard)GetContentURL¶
func (p *ProjectCard) GetContentURL()string
GetContentURL returns the ContentURL field if it's non-nil, zero value otherwise.
func (*ProjectCard)GetCreatedAt¶
func (p *ProjectCard) GetCreatedAt()Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*ProjectCard)GetCreator¶
func (p *ProjectCard) GetCreator() *User
GetCreator returns the Creator field.
func (*ProjectCard)GetID¶
func (p *ProjectCard) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*ProjectCard)GetNodeID¶
func (p *ProjectCard) GetNodeID()string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (*ProjectCard)GetNote¶
func (p *ProjectCard) GetNote()string
GetNote returns the Note field if it's non-nil, zero value otherwise.
func (*ProjectCard)GetPreviousColumnName¶
func (p *ProjectCard) GetPreviousColumnName()string
GetPreviousColumnName returns the PreviousColumnName field if it's non-nil, zero value otherwise.
func (*ProjectCard)GetProjectID¶
func (p *ProjectCard) GetProjectID()int64
GetProjectID returns the ProjectID field if it's non-nil, zero value otherwise.
func (*ProjectCard)GetProjectURL¶
func (p *ProjectCard) GetProjectURL()string
GetProjectURL returns the ProjectURL field if it's non-nil, zero value otherwise.
func (*ProjectCard)GetURL¶
func (p *ProjectCard) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (*ProjectCard)GetUpdatedAt¶
func (p *ProjectCard) GetUpdatedAt()Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
typeProjectCardChange¶
type ProjectCardChange struct {Note *ProjectCardNote `json:"note,omitempty"`}
ProjectCardChange represents the changes when a project card has been edited.
func (*ProjectCardChange)GetNote¶
func (p *ProjectCardChange) GetNote() *ProjectCardNote
GetNote returns the Note field.
typeProjectCardEvent¶
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://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#project_card
func (*ProjectCardEvent)GetAction¶
func (p *ProjectCardEvent) GetAction()string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*ProjectCardEvent)GetAfterID¶
func (p *ProjectCardEvent) GetAfterID()int64
GetAfterID returns the AfterID field if it's non-nil, zero value otherwise.
func (*ProjectCardEvent)GetChanges¶
func (p *ProjectCardEvent) GetChanges() *ProjectCardChange
GetChanges returns the Changes field.
func (*ProjectCardEvent)GetInstallation¶
func (p *ProjectCardEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*ProjectCardEvent)GetOrg¶
func (p *ProjectCardEvent) GetOrg() *Organization
GetOrg returns the Org field.
func (*ProjectCardEvent)GetProjectCard¶
func (p *ProjectCardEvent) GetProjectCard() *ProjectCard
GetProjectCard returns the ProjectCard field.
func (*ProjectCardEvent)GetRepo¶
func (p *ProjectCardEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (*ProjectCardEvent)GetSender¶
func (p *ProjectCardEvent) GetSender() *User
GetSender returns the Sender field.
typeProjectCardListOptions¶
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 theProjectsService.ListProjectCards method.
func (*ProjectCardListOptions)GetArchivedState¶
func (p *ProjectCardListOptions) GetArchivedState()string
GetArchivedState returns the ArchivedState field if it's non-nil, zero value otherwise.
typeProjectCardMoveOptions¶
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.Positionstring `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.ColumnIDint64 `json:"column_id,omitempty"`}
ProjectCardMoveOptions specifies the parameters to theProjectsService.MoveProjectCard method.
typeProjectCardNote¶
type ProjectCardNote struct {From *string `json:"from,omitempty"`}
ProjectCardNote represents a change of a note of a project card.
func (*ProjectCardNote)GetFrom¶
func (p *ProjectCardNote) GetFrom()string
GetFrom returns the From field if it's non-nil, zero value otherwise.
typeProjectCardOptions¶
type ProjectCardOptions struct {// The note of the card. Note and ContentID are mutually exclusive.Notestring `json:"note,omitempty"`// The ID (not Number) of the Issue to associate with this card.// Note and ContentID are mutually exclusive.ContentIDint64 `json:"content_id,omitempty"`// The type of content to associate with this card. Possible values are: "Issue" and "PullRequest".ContentTypestring `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 theProjectsService.CreateProjectCard andProjectsService.UpdateProjectCard methods.
func (*ProjectCardOptions)GetArchived¶
func (p *ProjectCardOptions) GetArchived()bool
GetArchived returns the Archived field if it's non-nil, zero value otherwise.
typeProjectChange¶
type ProjectChange struct {Name *ProjectName `json:"name,omitempty"`Body *ProjectBody `json:"body,omitempty"`}
ProjectChange represents the changes when a project has been edited.
func (*ProjectChange)GetBody¶
func (p *ProjectChange) GetBody() *ProjectBody
GetBody returns the Body field.
func (*ProjectChange)GetName¶
func (p *ProjectChange) GetName() *ProjectName
GetName returns the Name field.
typeProjectCollaboratorOptions¶
type ProjectCollaboratorOptions struct {// Permission specifies the permission to grant to the collaborator.// Possible values are:// "read" - can read, but not write to or administer this project.// "write" - can read and write, but not administer this project.// "admin" - can read, write and administer this project.//// Default value is "write"Permission *string `json:"permission,omitempty"`}
ProjectCollaboratorOptions specifies the optional parameters to theProjectsService.AddProjectCollaborator method.
func (*ProjectCollaboratorOptions)GetPermission¶
func (p *ProjectCollaboratorOptions) GetPermission()string
GetPermission returns the Permission field if it's non-nil, zero value otherwise.
typeProjectColumn¶
type ProjectColumn struct {ID *int64 `json:"id,omitempty"`Name *string `json:"name,omitempty"`URL *string `json:"url,omitempty"`ProjectURL *string `json:"project_url,omitempty"`CardsURL *string `json:"cards_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://docs.github.com/en/free-pro-team@latest/rest/reference/repos/projects/
func (*ProjectColumn)GetCardsURL¶
func (p *ProjectColumn) GetCardsURL()string
GetCardsURL returns the CardsURL field if it's non-nil, zero value otherwise.
func (*ProjectColumn)GetCreatedAt¶
func (p *ProjectColumn) GetCreatedAt()Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*ProjectColumn)GetID¶
func (p *ProjectColumn) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*ProjectColumn)GetName¶
func (p *ProjectColumn) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*ProjectColumn)GetNodeID¶
func (p *ProjectColumn) GetNodeID()string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (*ProjectColumn)GetProjectURL¶
func (p *ProjectColumn) GetProjectURL()string
GetProjectURL returns the ProjectURL field if it's non-nil, zero value otherwise.
func (*ProjectColumn)GetURL¶
func (p *ProjectColumn) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (*ProjectColumn)GetUpdatedAt¶
func (p *ProjectColumn) GetUpdatedAt()Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
typeProjectColumnChange¶
type ProjectColumnChange struct {Name *ProjectColumnName `json:"name,omitempty"`}
ProjectColumnChange represents the changes when a project column has been edited.
func (*ProjectColumnChange)GetName¶
func (p *ProjectColumnChange) GetName() *ProjectColumnName
GetName returns the Name field.
typeProjectColumnEvent¶
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://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#project_column
func (*ProjectColumnEvent)GetAction¶
func (p *ProjectColumnEvent) GetAction()string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*ProjectColumnEvent)GetAfterID¶
func (p *ProjectColumnEvent) GetAfterID()int64
GetAfterID returns the AfterID field if it's non-nil, zero value otherwise.
func (*ProjectColumnEvent)GetChanges¶
func (p *ProjectColumnEvent) GetChanges() *ProjectColumnChange
GetChanges returns the Changes field.
func (*ProjectColumnEvent)GetInstallation¶
func (p *ProjectColumnEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*ProjectColumnEvent)GetOrg¶
func (p *ProjectColumnEvent) GetOrg() *Organization
GetOrg returns the Org field.
func (*ProjectColumnEvent)GetProjectColumn¶
func (p *ProjectColumnEvent) GetProjectColumn() *ProjectColumn
GetProjectColumn returns the ProjectColumn field.
func (*ProjectColumnEvent)GetRepo¶
func (p *ProjectColumnEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (*ProjectColumnEvent)GetSender¶
func (p *ProjectColumnEvent) GetSender() *User
GetSender returns the Sender field.
typeProjectColumnMoveOptions¶
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.)Positionstring `json:"position"`}
ProjectColumnMoveOptions specifies the parameters to theProjectsService.MoveProjectColumn method.
typeProjectColumnName¶
type ProjectColumnName struct {From *string `json:"from,omitempty"`}
ProjectColumnName represents a project column name change.
func (*ProjectColumnName)GetFrom¶
func (p *ProjectColumnName) GetFrom()string
GetFrom returns the From field if it's non-nil, zero value otherwise.
typeProjectColumnOptions¶
type ProjectColumnOptions struct {// The name of the project column. (Required for creation and update.)Namestring `json:"name"`}
ProjectColumnOptions specifies the parameters to theProjectsService.CreateProjectColumn andProjectsService.UpdateProjectColumn methods.
typeProjectEvent¶
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://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#project
func (*ProjectEvent)GetAction¶
func (p *ProjectEvent) GetAction()string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*ProjectEvent)GetChanges¶
func (p *ProjectEvent) GetChanges() *ProjectChange
GetChanges returns the Changes field.
func (*ProjectEvent)GetInstallation¶
func (p *ProjectEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*ProjectEvent)GetOrg¶
func (p *ProjectEvent) GetOrg() *Organization
GetOrg returns the Org field.
func (*ProjectEvent)GetProject¶
func (p *ProjectEvent) GetProject() *Project
GetProject returns the Project field.
func (*ProjectEvent)GetRepo¶
func (p *ProjectEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (*ProjectEvent)GetSender¶
func (p *ProjectEvent) GetSender() *User
GetSender returns the Sender field.
typeProjectListOptions¶
type ProjectListOptions struct {// Indicates the state of the projects to return. Can be either open, closed, or all. Default: openStatestring `url:"state,omitempty"`ListOptions}
ProjectListOptions specifies the optional parameters to theOrganizationsService.ListProjects and RepositoriesService.ListProjects methods.
typeProjectName¶
type ProjectName struct {From *string `json:"from,omitempty"`}
ProjectName represents a project name change.
func (*ProjectName)GetFrom¶
func (p *ProjectName) GetFrom()string
GetFrom returns the From field if it's non-nil, zero value otherwise.
typeProjectOptions¶
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"`// The permission level that all members of the project's organization// will have on this project.// Setting the organization permission is only available// for organization projects. (Optional.)OrganizationPermission *string `json:"organization_permission,omitempty"`// Sets visibility of the project within the organization.// Setting visibility is only available// for organization projects.(Optional.)Private *bool `json:"private,omitempty"`}
ProjectOptions specifies the parameters to theRepositoriesService.CreateProject andProjectsService.UpdateProject methods.
func (*ProjectOptions)GetBody¶
func (p *ProjectOptions) GetBody()string
GetBody returns the Body field if it's non-nil, zero value otherwise.
func (*ProjectOptions)GetName¶
func (p *ProjectOptions) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*ProjectOptions)GetOrganizationPermission¶
func (p *ProjectOptions) GetOrganizationPermission()string
GetOrganizationPermission returns the OrganizationPermission field if it's non-nil, zero value otherwise.
func (*ProjectOptions)GetPrivate¶
func (p *ProjectOptions) GetPrivate()bool
GetPrivate returns the Private field if it's non-nil, zero value otherwise.
func (*ProjectOptions)GetState¶
func (p *ProjectOptions) GetState()string
GetState returns the State field if it's non-nil, zero value otherwise.
typeProjectPermissionLevel¶
type ProjectPermissionLevel struct {// Possible values: "admin", "write", "read", "none"Permission *string `json:"permission,omitempty"`User *User `json:"user,omitempty"`}
ProjectPermissionLevel represents the permission level an organizationmember has for a given project.
func (*ProjectPermissionLevel)GetPermission¶
func (p *ProjectPermissionLevel) GetPermission()string
GetPermission returns the Permission field if it's non-nil, zero value otherwise.
func (*ProjectPermissionLevel)GetUser¶
func (p *ProjectPermissionLevel) GetUser() *User
GetUser returns the User field.
typeProjectsService¶
type ProjectsService service
ProjectsService provides access to the projects functions in theGitHub API.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/projects/
func (*ProjectsService)AddProjectCollaborator¶
func (s *ProjectsService) AddProjectCollaborator(ctxcontext.Context, idint64, usernamestring, opts *ProjectCollaboratorOptions) (*Response,error)
AddProjectCollaborator adds a collaborator to an organization project and setstheir permission level. You must be an organization owner or a project admin to add a collaborator.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/projects/#add-project-collaborator
func (*ProjectsService)CreateProjectCard¶
func (s *ProjectsService) CreateProjectCard(ctxcontext.Context, columnIDint64, opts *ProjectCardOptions) (*ProjectCard, *Response,error)
CreateProjectCard creates a card in the specified column of a GitHub Project.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/projects/#create-a-project-card
func (*ProjectsService)CreateProjectColumn¶
func (s *ProjectsService) CreateProjectColumn(ctxcontext.Context, projectIDint64, opts *ProjectColumnOptions) (*ProjectColumn, *Response,error)
CreateProjectColumn creates a column for the specified (by number) project.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/projects/#create-a-project-column
func (*ProjectsService)DeleteProject¶
DeleteProject deletes a GitHub Project from a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/projects/#delete-a-project
func (*ProjectsService)DeleteProjectCard¶
DeleteProjectCard deletes a card from a GitHub Project.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/projects/#delete-a-project-card
func (*ProjectsService)DeleteProjectColumn¶
DeleteProjectColumn deletes a column from a GitHub Project.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/projects/#delete-a-project-column
func (*ProjectsService)GetProject¶
GetProject gets a GitHub Project for a repo.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/projects/#get-a-project
func (*ProjectsService)GetProjectCard¶
func (s *ProjectsService) GetProjectCard(ctxcontext.Context, cardIDint64) (*ProjectCard, *Response,error)
GetProjectCard gets a card in a column of a GitHub Project.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/projects/#get-a-project-card
func (*ProjectsService)GetProjectColumn¶
func (s *ProjectsService) GetProjectColumn(ctxcontext.Context, idint64) (*ProjectColumn, *Response,error)
GetProjectColumn gets a column of a GitHub Project for a repo.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/projects/#get-a-project-column
func (*ProjectsService)ListProjectCards¶
func (s *ProjectsService) ListProjectCards(ctxcontext.Context, columnIDint64, opts *ProjectCardListOptions) ([]*ProjectCard, *Response,error)
ListProjectCards lists the cards in a column of a GitHub Project.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/projects/#list-project-cards
func (*ProjectsService)ListProjectCollaborators¶
func (s *ProjectsService) ListProjectCollaborators(ctxcontext.Context, idint64, opts *ListCollaboratorOptions) ([]*User, *Response,error)
ListProjectCollaborators lists the collaborators for an organization project. For a project,the list of collaborators includes outside collaborators, organization members that are directcollaborators, organization members with access through team memberships, organization memberswith access through default organization permissions, and organization owners. You must be anorganization owner or a project admin to list collaborators.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/projects/#list-project-collaborators
func (*ProjectsService)ListProjectColumns¶
func (s *ProjectsService) ListProjectColumns(ctxcontext.Context, projectIDint64, opts *ListOptions) ([]*ProjectColumn, *Response,error)
ListProjectColumns lists the columns of a GitHub Project for a repo.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/projects/#list-project-columns
func (*ProjectsService)MoveProjectCard¶
func (s *ProjectsService) MoveProjectCard(ctxcontext.Context, cardIDint64, opts *ProjectCardMoveOptions) (*Response,error)
MoveProjectCard moves a card within a GitHub Project.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/projects/#move-a-project-card
func (*ProjectsService)MoveProjectColumn¶
func (s *ProjectsService) MoveProjectColumn(ctxcontext.Context, columnIDint64, opts *ProjectColumnMoveOptions) (*Response,error)
MoveProjectColumn moves a column within a GitHub Project.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/projects/#move-a-project-column
func (*ProjectsService)RemoveProjectCollaborator¶
func (s *ProjectsService) RemoveProjectCollaborator(ctxcontext.Context, idint64, usernamestring) (*Response,error)
RemoveProjectCollaborator removes a collaborator from an organization project.You must be an organization owner or a project admin to remove a collaborator.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/projects/#remove-user-as-a-collaborator
func (*ProjectsService)ReviewProjectCollaboratorPermission¶
func (s *ProjectsService) ReviewProjectCollaboratorPermission(ctxcontext.Context, idint64, usernamestring) (*ProjectPermissionLevel, *Response,error)
ReviewProjectCollaboratorPermission returns the collaborator's permission level for an organizationproject. Possible values for the permission key: "admin", "write", "read", "none".You must be an organization owner or a project admin to review a user's permission level.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/projects/#get-project-permission-for-a-user
func (*ProjectsService)UpdateProject¶
func (s *ProjectsService) UpdateProject(ctxcontext.Context, idint64, opts *ProjectOptions) (*Project, *Response,error)
UpdateProject updates a repository project.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/projects/#update-a-project
func (*ProjectsService)UpdateProjectCard¶
func (s *ProjectsService) UpdateProjectCard(ctxcontext.Context, cardIDint64, opts *ProjectCardOptions) (*ProjectCard, *Response,error)
UpdateProjectCard updates a card of a GitHub Project.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/projects/#update-an-existing-project-card
func (*ProjectsService)UpdateProjectColumn¶
func (s *ProjectsService) UpdateProjectColumn(ctxcontext.Context, columnIDint64, opts *ProjectColumnOptions) (*ProjectColumn, *Response,error)
UpdateProjectColumn updates a column of a GitHub Project.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/projects/#update-an-existing-project-column
typeProtection¶
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"`RequireLinearHistory *RequireLinearHistory `json:"required_linear_history"`AllowForcePushes *AllowForcePushes `json:"allow_force_pushes"`AllowDeletions *AllowDeletions `json:"allow_deletions"`RequiredConversationResolution *RequiredConversationResolution `json:"required_conversation_resolution"`}
Protection represents a repository branch's protection.
func (*Protection)GetAllowDeletions¶
func (p *Protection) GetAllowDeletions() *AllowDeletions
GetAllowDeletions returns the AllowDeletions field.
func (*Protection)GetAllowForcePushes¶
func (p *Protection) GetAllowForcePushes() *AllowForcePushes
GetAllowForcePushes returns the AllowForcePushes field.
func (*Protection)GetEnforceAdmins¶
func (p *Protection) GetEnforceAdmins() *AdminEnforcement
GetEnforceAdmins returns the EnforceAdmins field.
func (*Protection)GetRequireLinearHistory¶
func (p *Protection) GetRequireLinearHistory() *RequireLinearHistory
GetRequireLinearHistory returns the RequireLinearHistory field.
func (*Protection)GetRequiredConversationResolution¶
func (p *Protection) GetRequiredConversationResolution() *RequiredConversationResolution
GetRequiredConversationResolution returns the RequiredConversationResolution field.
func (*Protection)GetRequiredPullRequestReviews¶
func (p *Protection) GetRequiredPullRequestReviews() *PullRequestReviewsEnforcement
GetRequiredPullRequestReviews returns the RequiredPullRequestReviews field.
func (*Protection)GetRequiredStatusChecks¶
func (p *Protection) GetRequiredStatusChecks() *RequiredStatusChecks
GetRequiredStatusChecks returns the RequiredStatusChecks field.
func (*Protection)GetRestrictions¶
func (p *Protection) GetRestrictions() *BranchRestrictions
GetRestrictions returns the Restrictions field.
typeProtectionChanges¶
type ProtectionChanges struct {AuthorizedActorsOnly *AuthorizedActorsOnly `json:"authorized_actors_only,omitempty"`AuthorizedActorNames *AuthorizedActorNames `json:"authorized_actor_names,omitempty"`}
ProtectionChanges represents the changes to the rule if the BranchProtection was edited.
func (*ProtectionChanges)GetAuthorizedActorNames¶
func (p *ProtectionChanges) GetAuthorizedActorNames() *AuthorizedActorNames
GetAuthorizedActorNames returns the AuthorizedActorNames field.
func (*ProtectionChanges)GetAuthorizedActorsOnly¶
func (p *ProtectionChanges) GetAuthorizedActorsOnly() *AuthorizedActorsOnly
GetAuthorizedActorsOnly returns the AuthorizedActorsOnly field.
typeProtectionRequest¶
type ProtectionRequest struct {RequiredStatusChecks *RequiredStatusChecks `json:"required_status_checks"`RequiredPullRequestReviews *PullRequestReviewsEnforcementRequest `json:"required_pull_request_reviews"`EnforceAdminsbool `json:"enforce_admins"`Restrictions *BranchRestrictionsRequest `json:"restrictions"`// Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch.RequireLinearHistory *bool `json:"required_linear_history,omitempty"`// Permits force pushes to the protected branch by anyone with write access to the repository.AllowForcePushes *bool `json:"allow_force_pushes,omitempty"`// Allows deletion of the protected branch by anyone with write access to the repository.AllowDeletions *bool `json:"allow_deletions,omitempty"`// RequiredConversationResolution, if set to true, requires all comments// on the pull request to be resolved before it can be merged to a protected branch.RequiredConversationResolution *bool `json:"required_conversation_resolution,omitempty"`}
ProtectionRequest represents a request to create/edit a branch's protection.
func (*ProtectionRequest)GetAllowDeletions¶
func (p *ProtectionRequest) GetAllowDeletions()bool
GetAllowDeletions returns the AllowDeletions field if it's non-nil, zero value otherwise.
func (*ProtectionRequest)GetAllowForcePushes¶
func (p *ProtectionRequest) GetAllowForcePushes()bool
GetAllowForcePushes returns the AllowForcePushes field if it's non-nil, zero value otherwise.
func (*ProtectionRequest)GetRequireLinearHistory¶
func (p *ProtectionRequest) GetRequireLinearHistory()bool
GetRequireLinearHistory returns the RequireLinearHistory field if it's non-nil, zero value otherwise.
func (*ProtectionRequest)GetRequiredConversationResolution¶
func (p *ProtectionRequest) GetRequiredConversationResolution()bool
GetRequiredConversationResolution returns the RequiredConversationResolution field if it's non-nil, zero value otherwise.
func (*ProtectionRequest)GetRequiredPullRequestReviews¶
func (p *ProtectionRequest) GetRequiredPullRequestReviews() *PullRequestReviewsEnforcementRequest
GetRequiredPullRequestReviews returns the RequiredPullRequestReviews field.
func (*ProtectionRequest)GetRequiredStatusChecks¶
func (p *ProtectionRequest) GetRequiredStatusChecks() *RequiredStatusChecks
GetRequiredStatusChecks returns the RequiredStatusChecks field.
func (*ProtectionRequest)GetRestrictions¶
func (p *ProtectionRequest) GetRestrictions() *BranchRestrictionsRequest
GetRestrictions returns the Restrictions field.
typeProtectionRule¶
type ProtectionRule struct {ID *int64 `json:"id,omitempty"`NodeID *string `json:"node_id,omitempty"`Type *string `json:"type,omitempty"`WaitTimer *int `json:"wait_timer,omitempty"`Reviewers []*RequiredReviewer `json:"reviewers,omitempty"`}
ProtectionRule represents a single protection rule applied to the environment.
func (*ProtectionRule)GetID¶
func (p *ProtectionRule) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*ProtectionRule)GetNodeID¶
func (p *ProtectionRule) GetNodeID()string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (*ProtectionRule)GetType¶
func (p *ProtectionRule) GetType()string
GetType returns the Type field if it's non-nil, zero value otherwise.
func (*ProtectionRule)GetWaitTimer¶
func (p *ProtectionRule) GetWaitTimer()int
GetWaitTimer returns the WaitTimer field if it's non-nil, zero value otherwise.
typePublicEvent¶
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://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#public
func (*PublicEvent)GetInstallation¶
func (p *PublicEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*PublicEvent)GetRepo¶
func (p *PublicEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (*PublicEvent)GetSender¶
func (p *PublicEvent) GetSender() *User
GetSender returns the Sender field.
typePublicKey¶
PublicKey represents the public key that should be used to encrypt secrets.
func (*PublicKey)UnmarshalJSON¶
UnmarshalJSON implements the json.Unmarshaler interface.This ensures GitHub Enterprise versions which return a numeric key iddo not error out when unmarshaling.
typePullRequest¶
type PullRequest 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"`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"`Draft *bool `json:"draft,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"`Rebaseable *bool `json:"rebaseable,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"`ReviewComments *int `json:"review_comments,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"`AutoMerge *PullRequestAutoMerge `json:"auto_merge,omitempty"`// RequestedTeams is populated as part of the PullRequestEvent.// See,https://docs.github.com/en/developers/webhooks-and-events/github-event-types#pullrequestevent for an example.RequestedTeams []*Team `json:"requested_teams,omitempty"`Links *PRLinks `json:"_links,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 (*PullRequest)GetActiveLockReason¶
func (p *PullRequest) GetActiveLockReason()string
GetActiveLockReason returns the ActiveLockReason field if it's non-nil, zero value otherwise.
func (*PullRequest)GetAdditions¶
func (p *PullRequest) GetAdditions()int
GetAdditions returns the Additions field if it's non-nil, zero value otherwise.
func (*PullRequest)GetAssignee¶
func (p *PullRequest) GetAssignee() *User
GetAssignee returns the Assignee field.
func (*PullRequest)GetAuthorAssociation¶
func (p *PullRequest) GetAuthorAssociation()string
GetAuthorAssociation returns the AuthorAssociation field if it's non-nil, zero value otherwise.
func (*PullRequest)GetAutoMerge¶
func (p *PullRequest) GetAutoMerge() *PullRequestAutoMerge
GetAutoMerge returns the AutoMerge field.
func (*PullRequest)GetBase¶
func (p *PullRequest) GetBase() *PullRequestBranch
GetBase returns the Base field.
func (*PullRequest)GetBody¶
func (p *PullRequest) GetBody()string
GetBody returns the Body field if it's non-nil, zero value otherwise.
func (*PullRequest)GetChangedFiles¶
func (p *PullRequest) GetChangedFiles()int
GetChangedFiles returns the ChangedFiles field if it's non-nil, zero value otherwise.
func (*PullRequest)GetClosedAt¶
func (p *PullRequest) GetClosedAt()time.Time
GetClosedAt returns the ClosedAt field if it's non-nil, zero value otherwise.
func (*PullRequest)GetComments¶
func (p *PullRequest) GetComments()int
GetComments returns the Comments field if it's non-nil, zero value otherwise.
func (*PullRequest)GetCommentsURL¶
func (p *PullRequest) GetCommentsURL()string
GetCommentsURL returns the CommentsURL field if it's non-nil, zero value otherwise.
func (*PullRequest)GetCommits¶
func (p *PullRequest) GetCommits()int
GetCommits returns the Commits field if it's non-nil, zero value otherwise.
func (*PullRequest)GetCommitsURL¶
func (p *PullRequest) GetCommitsURL()string
GetCommitsURL returns the CommitsURL field if it's non-nil, zero value otherwise.
func (*PullRequest)GetCreatedAt¶
func (p *PullRequest) GetCreatedAt()time.Time
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*PullRequest)GetDeletions¶
func (p *PullRequest) GetDeletions()int
GetDeletions returns the Deletions field if it's non-nil, zero value otherwise.
func (*PullRequest)GetDiffURL¶
func (p *PullRequest) GetDiffURL()string
GetDiffURL returns the DiffURL field if it's non-nil, zero value otherwise.
func (*PullRequest)GetDraft¶
func (p *PullRequest) GetDraft()bool
GetDraft returns the Draft field if it's non-nil, zero value otherwise.
func (*PullRequest)GetHTMLURL¶
func (p *PullRequest) GetHTMLURL()string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*PullRequest)GetHead¶
func (p *PullRequest) GetHead() *PullRequestBranch
GetHead returns the Head field.
func (*PullRequest)GetID¶
func (p *PullRequest) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*PullRequest)GetIssueURL¶
func (p *PullRequest) GetIssueURL()string
GetIssueURL returns the IssueURL field if it's non-nil, zero value otherwise.
func (*PullRequest)GetLinks¶
func (p *PullRequest) GetLinks() *PRLinks
GetLinks returns the Links field.
func (*PullRequest)GetLocked¶
func (p *PullRequest) GetLocked()bool
GetLocked returns the Locked field if it's non-nil, zero value otherwise.
func (*PullRequest)GetMaintainerCanModify¶
func (p *PullRequest) GetMaintainerCanModify()bool
GetMaintainerCanModify returns the MaintainerCanModify field if it's non-nil, zero value otherwise.
func (*PullRequest)GetMergeCommitSHA¶
func (p *PullRequest) GetMergeCommitSHA()string
GetMergeCommitSHA returns the MergeCommitSHA field if it's non-nil, zero value otherwise.
func (*PullRequest)GetMergeable¶
func (p *PullRequest) GetMergeable()bool
GetMergeable returns the Mergeable field if it's non-nil, zero value otherwise.
func (*PullRequest)GetMergeableState¶
func (p *PullRequest) GetMergeableState()string
GetMergeableState returns the MergeableState field if it's non-nil, zero value otherwise.
func (*PullRequest)GetMerged¶
func (p *PullRequest) GetMerged()bool
GetMerged returns the Merged field if it's non-nil, zero value otherwise.
func (*PullRequest)GetMergedAt¶
func (p *PullRequest) GetMergedAt()time.Time
GetMergedAt returns the MergedAt field if it's non-nil, zero value otherwise.
func (*PullRequest)GetMergedBy¶
func (p *PullRequest) GetMergedBy() *User
GetMergedBy returns the MergedBy field.
func (*PullRequest)GetMilestone¶
func (p *PullRequest) GetMilestone() *Milestone
GetMilestone returns the Milestone field.
func (*PullRequest)GetNodeID¶
func (p *PullRequest) GetNodeID()string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (*PullRequest)GetNumber¶
func (p *PullRequest) GetNumber()int
GetNumber returns the Number field if it's non-nil, zero value otherwise.
func (*PullRequest)GetPatchURL¶
func (p *PullRequest) GetPatchURL()string
GetPatchURL returns the PatchURL field if it's non-nil, zero value otherwise.
func (*PullRequest)GetRebaseable¶
func (p *PullRequest) GetRebaseable()bool
GetRebaseable returns the Rebaseable field if it's non-nil, zero value otherwise.
func (*PullRequest)GetReviewCommentURL¶
func (p *PullRequest) GetReviewCommentURL()string
GetReviewCommentURL returns the ReviewCommentURL field if it's non-nil, zero value otherwise.
func (*PullRequest)GetReviewComments¶
func (p *PullRequest) GetReviewComments()int
GetReviewComments returns the ReviewComments field if it's non-nil, zero value otherwise.
func (*PullRequest)GetReviewCommentsURL¶
func (p *PullRequest) GetReviewCommentsURL()string
GetReviewCommentsURL returns the ReviewCommentsURL field if it's non-nil, zero value otherwise.
func (*PullRequest)GetState¶
func (p *PullRequest) GetState()string
GetState returns the State field if it's non-nil, zero value otherwise.
func (*PullRequest)GetStatusesURL¶
func (p *PullRequest) GetStatusesURL()string
GetStatusesURL returns the StatusesURL field if it's non-nil, zero value otherwise.
func (*PullRequest)GetTitle¶
func (p *PullRequest) GetTitle()string
GetTitle returns the Title field if it's non-nil, zero value otherwise.
func (*PullRequest)GetURL¶
func (p *PullRequest) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (*PullRequest)GetUpdatedAt¶
func (p *PullRequest) GetUpdatedAt()time.Time
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (PullRequest)String¶
func (pPullRequest) String()string
typePullRequestAutoMerge¶
type PullRequestAutoMerge struct {EnabledBy *User `json:"enabled_by,omitempty"`MergeMethod *string `json:"merge_method,omitempty"`CommitTitle *string `json:"commit_title,omitempty"`CommitMessage *string `json:"commit_message,omitempty"`}
PullRequestAutoMerge represents the "auto_merge" response for a PullRequest.
func (*PullRequestAutoMerge)GetCommitMessage¶
func (p *PullRequestAutoMerge) GetCommitMessage()string
GetCommitMessage returns the CommitMessage field if it's non-nil, zero value otherwise.
func (*PullRequestAutoMerge)GetCommitTitle¶
func (p *PullRequestAutoMerge) GetCommitTitle()string
GetCommitTitle returns the CommitTitle field if it's non-nil, zero value otherwise.
func (*PullRequestAutoMerge)GetEnabledBy¶
func (p *PullRequestAutoMerge) GetEnabledBy() *User
GetEnabledBy returns the EnabledBy field.
func (*PullRequestAutoMerge)GetMergeMethod¶
func (p *PullRequestAutoMerge) GetMergeMethod()string
GetMergeMethod returns the MergeMethod field if it's non-nil, zero value otherwise.
typePullRequestBranch¶
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 (*PullRequestBranch)GetLabel¶
func (p *PullRequestBranch) GetLabel()string
GetLabel returns the Label field if it's non-nil, zero value otherwise.
func (*PullRequestBranch)GetRef¶
func (p *PullRequestBranch) GetRef()string
GetRef returns the Ref field if it's non-nil, zero value otherwise.
func (*PullRequestBranch)GetRepo¶
func (p *PullRequestBranch) GetRepo() *Repository
GetRepo returns the Repo field.
func (*PullRequestBranch)GetSHA¶
func (p *PullRequestBranch) GetSHA()string
GetSHA returns the SHA field if it's non-nil, zero value otherwise.
func (*PullRequestBranch)GetUser¶
func (p *PullRequestBranch) GetUser() *User
GetUser returns the User field.
typePullRequestBranchUpdateOptions¶
type PullRequestBranchUpdateOptions struct {// ExpectedHeadSHA specifies the most recent commit on the pull request's branch.// Default value is the SHA of the pull request's current HEAD ref.ExpectedHeadSHA *string `json:"expected_head_sha,omitempty"`}
PullRequestBranchUpdateOptions specifies the optional parameters to thePullRequestsService.UpdateBranch method.
func (*PullRequestBranchUpdateOptions)GetExpectedHeadSHA¶
func (p *PullRequestBranchUpdateOptions) GetExpectedHeadSHA()string
GetExpectedHeadSHA returns the ExpectedHeadSHA field if it's non-nil, zero value otherwise.
typePullRequestBranchUpdateResponse¶
type PullRequestBranchUpdateResponse struct {Message *string `json:"message,omitempty"`URL *string `json:"url,omitempty"`}
PullRequestBranchUpdateResponse specifies the response of pull request branch update.
func (*PullRequestBranchUpdateResponse)GetMessage¶
func (p *PullRequestBranchUpdateResponse) GetMessage()string
GetMessage returns the Message field if it's non-nil, zero value otherwise.
func (*PullRequestBranchUpdateResponse)GetURL¶
func (p *PullRequestBranchUpdateResponse) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
typePullRequestComment¶
type PullRequestComment struct {ID *int64 `json:"id,omitempty"`NodeID *string `json:"node_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"`StartLine *int `json:"start_line,omitempty"`Line *int `json:"line,omitempty"`OriginalLine *int `json:"original_line,omitempty"`OriginalStartLine *int `json:"original_start_line,omitempty"`Side *string `json:"side,omitempty"`StartSide *string `json:"start_side,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 (*PullRequestComment)GetAuthorAssociation¶
func (p *PullRequestComment) GetAuthorAssociation()string
GetAuthorAssociation returns the AuthorAssociation field if it's non-nil, zero value otherwise.
func (*PullRequestComment)GetBody¶
func (p *PullRequestComment) GetBody()string
GetBody returns the Body field if it's non-nil, zero value otherwise.
func (*PullRequestComment)GetCommitID¶
func (p *PullRequestComment) GetCommitID()string
GetCommitID returns the CommitID field if it's non-nil, zero value otherwise.
func (*PullRequestComment)GetCreatedAt¶
func (p *PullRequestComment) GetCreatedAt()time.Time
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*PullRequestComment)GetDiffHunk¶
func (p *PullRequestComment) GetDiffHunk()string
GetDiffHunk returns the DiffHunk field if it's non-nil, zero value otherwise.
func (*PullRequestComment)GetHTMLURL¶
func (p *PullRequestComment) GetHTMLURL()string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*PullRequestComment)GetID¶
func (p *PullRequestComment) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*PullRequestComment)GetInReplyTo¶
func (p *PullRequestComment) GetInReplyTo()int64
GetInReplyTo returns the InReplyTo field if it's non-nil, zero value otherwise.
func (*PullRequestComment)GetLine¶
func (p *PullRequestComment) GetLine()int
GetLine returns the Line field if it's non-nil, zero value otherwise.
func (*PullRequestComment)GetNodeID¶
func (p *PullRequestComment) GetNodeID()string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (*PullRequestComment)GetOriginalCommitID¶
func (p *PullRequestComment) GetOriginalCommitID()string
GetOriginalCommitID returns the OriginalCommitID field if it's non-nil, zero value otherwise.
func (*PullRequestComment)GetOriginalLine¶
func (p *PullRequestComment) GetOriginalLine()int
GetOriginalLine returns the OriginalLine field if it's non-nil, zero value otherwise.
func (*PullRequestComment)GetOriginalPosition¶
func (p *PullRequestComment) GetOriginalPosition()int
GetOriginalPosition returns the OriginalPosition field if it's non-nil, zero value otherwise.
func (*PullRequestComment)GetOriginalStartLine¶
func (p *PullRequestComment) GetOriginalStartLine()int
GetOriginalStartLine returns the OriginalStartLine field if it's non-nil, zero value otherwise.
func (*PullRequestComment)GetPath¶
func (p *PullRequestComment) GetPath()string
GetPath returns the Path field if it's non-nil, zero value otherwise.
func (*PullRequestComment)GetPosition¶
func (p *PullRequestComment) GetPosition()int
GetPosition returns the Position field if it's non-nil, zero value otherwise.
func (*PullRequestComment)GetPullRequestReviewID¶
func (p *PullRequestComment) GetPullRequestReviewID()int64
GetPullRequestReviewID returns the PullRequestReviewID field if it's non-nil, zero value otherwise.
func (*PullRequestComment)GetPullRequestURL¶
func (p *PullRequestComment) GetPullRequestURL()string
GetPullRequestURL returns the PullRequestURL field if it's non-nil, zero value otherwise.
func (*PullRequestComment)GetReactions¶
func (p *PullRequestComment) GetReactions() *Reactions
GetReactions returns the Reactions field.
func (*PullRequestComment)GetSide¶
func (p *PullRequestComment) GetSide()string
GetSide returns the Side field if it's non-nil, zero value otherwise.
func (*PullRequestComment)GetStartLine¶
func (p *PullRequestComment) GetStartLine()int
GetStartLine returns the StartLine field if it's non-nil, zero value otherwise.
func (*PullRequestComment)GetStartSide¶
func (p *PullRequestComment) GetStartSide()string
GetStartSide returns the StartSide field if it's non-nil, zero value otherwise.
func (*PullRequestComment)GetURL¶
func (p *PullRequestComment) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (*PullRequestComment)GetUpdatedAt¶
func (p *PullRequestComment) GetUpdatedAt()time.Time
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (*PullRequestComment)GetUser¶
func (p *PullRequestComment) GetUser() *User
GetUser returns the User field.
func (PullRequestComment)String¶
func (pPullRequestComment) String()string
typePullRequestEvent¶
type PullRequestEvent struct {// Action is the action that was performed. Possible values are:// "assigned", "unassigned", "review_requested", "review_request_removed", "labeled", "unlabeled",// "opened", "edited", "closed", "ready_for_review", "locked", "unlocked", or "reopened".// 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.// While webhooks are also triggered when a pull request is synchronized, Events API timelines// don't include pull request events with the "synchronize" action.Action *string `json:"action,omitempty"`Assignee *User `json:"assignee,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"`// In the event that a team is requested instead of a user, "requested_team" gets sent in place of// "requested_user" with the same delivery behavior.RequestedTeam *Team `json:"requested_team,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.// The following field is only present when the webhook is triggered on// a repository belonging to an organization.Organization *Organization `json:"organization,omitempty"`// The following fields are only populated when the Action is "synchronize".Before *string `json:"before,omitempty"`After *string `json:"after,omitempty"`}
PullRequestEvent is triggered when a pull request is assigned, unassigned, labeled,unlabeled, opened, edited, closed, reopened, synchronize, ready_for_review,locked, unlocked, a pull request review is requested, or a review request is removed.The Webhook event name is "pull_request".
GitHub API docs:https://docs.github.com/en/developers/webhooks-and-events/github-event-types#pullrequestevent
func (*PullRequestEvent)GetAction¶
func (p *PullRequestEvent) GetAction()string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*PullRequestEvent)GetAfter¶
func (p *PullRequestEvent) GetAfter()string
GetAfter returns the After field if it's non-nil, zero value otherwise.
func (*PullRequestEvent)GetAssignee¶
func (p *PullRequestEvent) GetAssignee() *User
GetAssignee returns the Assignee field.
func (*PullRequestEvent)GetBefore¶
func (p *PullRequestEvent) GetBefore()string
GetBefore returns the Before field if it's non-nil, zero value otherwise.
func (*PullRequestEvent)GetChanges¶
func (p *PullRequestEvent) GetChanges() *EditChange
GetChanges returns the Changes field.
func (*PullRequestEvent)GetInstallation¶
func (p *PullRequestEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*PullRequestEvent)GetLabel¶
func (p *PullRequestEvent) GetLabel() *Label
GetLabel returns the Label field.
func (*PullRequestEvent)GetNumber¶
func (p *PullRequestEvent) GetNumber()int
GetNumber returns the Number field if it's non-nil, zero value otherwise.
func (*PullRequestEvent)GetOrganization¶
func (p *PullRequestEvent) GetOrganization() *Organization
GetOrganization returns the Organization field.
func (*PullRequestEvent)GetPullRequest¶
func (p *PullRequestEvent) GetPullRequest() *PullRequest
GetPullRequest returns the PullRequest field.
func (*PullRequestEvent)GetRepo¶
func (p *PullRequestEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (*PullRequestEvent)GetRequestedReviewer¶
func (p *PullRequestEvent) GetRequestedReviewer() *User
GetRequestedReviewer returns the RequestedReviewer field.
func (*PullRequestEvent)GetRequestedTeam¶
func (p *PullRequestEvent) GetRequestedTeam() *Team
GetRequestedTeam returns the RequestedTeam field.
func (*PullRequestEvent)GetSender¶
func (p *PullRequestEvent) GetSender() *User
GetSender returns the Sender field.
typePullRequestLinks¶
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 includedin the IssueCommentEvent webhook payload, if the webhook is fired by a comment on a PR.
func (*PullRequestLinks)GetDiffURL¶
func (p *PullRequestLinks) GetDiffURL()string
GetDiffURL returns the DiffURL field if it's non-nil, zero value otherwise.
func (*PullRequestLinks)GetHTMLURL¶
func (p *PullRequestLinks) GetHTMLURL()string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*PullRequestLinks)GetPatchURL¶
func (p *PullRequestLinks) GetPatchURL()string
GetPatchURL returns the PatchURL field if it's non-nil, zero value otherwise.
func (*PullRequestLinks)GetURL¶
func (p *PullRequestLinks) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
typePullRequestListCommentsOptions¶
type PullRequestListCommentsOptions struct {// Sort specifies how to sort comments. Possible values are: created, updated.Sortstring `url:"sort,omitempty"`// Direction in which to sort comments. Possible values are: asc, desc.Directionstring `url:"direction,omitempty"`// Since filters comments by time.Sincetime.Time `url:"since,omitempty"`ListOptions}
PullRequestListCommentsOptions specifies the optional parameters to thePullRequestsService.ListComments method.
typePullRequestListOptions¶
type PullRequestListOptions struct {// State filters pull requests based on their state. Possible values are:// open, closed, all. Default is "open".Statestring `url:"state,omitempty"`// Head filters pull requests by head user and branch name in the format of:// "user:ref-name".Headstring `url:"head,omitempty"`// Base filters pull requests by base branch name.Basestring `url:"base,omitempty"`// Sort specifies how to sort pull requests. Possible values are: created,// updated, popularity, long-running. Default is "created".Sortstring `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"Directionstring `url:"direction,omitempty"`ListOptions}
PullRequestListOptions specifies the optional parameters to thePullRequestsService.List method.
typePullRequestMergeResult¶
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 (*PullRequestMergeResult)GetMerged¶
func (p *PullRequestMergeResult) GetMerged()bool
GetMerged returns the Merged field if it's non-nil, zero value otherwise.
func (*PullRequestMergeResult)GetMessage¶
func (p *PullRequestMergeResult) GetMessage()string
GetMessage returns the Message field if it's non-nil, zero value otherwise.
func (*PullRequestMergeResult)GetSHA¶
func (p *PullRequestMergeResult) GetSHA()string
GetSHA returns the SHA field if it's non-nil, zero value otherwise.
typePullRequestOptions¶
type PullRequestOptions struct {CommitTitlestring// Title for the automatic commit message. (Optional.)SHAstring// 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.)MergeMethodstring// If false, an empty string commit message will use the default commit message. If true, an empty string commit message will be used.DontDefaultIfBlankbool}
PullRequestOptions lets you define how a pull request will be merged.
typePullRequestReview¶
type PullRequestReview struct {ID *int64 `json:"id,omitempty"`NodeID *string `json:"node_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"`// 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"`}
PullRequestReview represents a review of a pull request.
func (*PullRequestReview)GetAuthorAssociation¶
func (p *PullRequestReview) GetAuthorAssociation()string
GetAuthorAssociation returns the AuthorAssociation field if it's non-nil, zero value otherwise.
func (*PullRequestReview)GetBody¶
func (p *PullRequestReview) GetBody()string
GetBody returns the Body field if it's non-nil, zero value otherwise.
func (*PullRequestReview)GetCommitID¶
func (p *PullRequestReview) GetCommitID()string
GetCommitID returns the CommitID field if it's non-nil, zero value otherwise.
func (*PullRequestReview)GetHTMLURL¶
func (p *PullRequestReview) GetHTMLURL()string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*PullRequestReview)GetID¶
func (p *PullRequestReview) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*PullRequestReview)GetNodeID¶
func (p *PullRequestReview) GetNodeID()string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (*PullRequestReview)GetPullRequestURL¶
func (p *PullRequestReview) GetPullRequestURL()string
GetPullRequestURL returns the PullRequestURL field if it's non-nil, zero value otherwise.
func (*PullRequestReview)GetState¶
func (p *PullRequestReview) GetState()string
GetState returns the State field if it's non-nil, zero value otherwise.
func (*PullRequestReview)GetSubmittedAt¶
func (p *PullRequestReview) GetSubmittedAt()time.Time
GetSubmittedAt returns the SubmittedAt field if it's non-nil, zero value otherwise.
func (*PullRequestReview)GetUser¶
func (p *PullRequestReview) GetUser() *User
GetUser returns the User field.
func (PullRequestReview)String¶
func (pPullRequestReview) String()string
typePullRequestReviewCommentEvent¶
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 aportion of the unified diff of a pull request.The Webhook event name is "pull_request_review_comment".
GitHub API docs:https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#pull_request_review_comment
func (*PullRequestReviewCommentEvent)GetAction¶
func (p *PullRequestReviewCommentEvent) GetAction()string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*PullRequestReviewCommentEvent)GetChanges¶
func (p *PullRequestReviewCommentEvent) GetChanges() *EditChange
GetChanges returns the Changes field.
func (*PullRequestReviewCommentEvent)GetComment¶
func (p *PullRequestReviewCommentEvent) GetComment() *PullRequestComment
GetComment returns the Comment field.
func (*PullRequestReviewCommentEvent)GetInstallation¶
func (p *PullRequestReviewCommentEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*PullRequestReviewCommentEvent)GetPullRequest¶
func (p *PullRequestReviewCommentEvent) GetPullRequest() *PullRequest
GetPullRequest returns the PullRequest field.
func (*PullRequestReviewCommentEvent)GetRepo¶
func (p *PullRequestReviewCommentEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (*PullRequestReviewCommentEvent)GetSender¶
func (p *PullRequestReviewCommentEvent) GetSender() *User
GetSender returns the Sender field.
typePullRequestReviewDismissalRequest¶
type PullRequestReviewDismissalRequest struct {Message *string `json:"message,omitempty"`}
PullRequestReviewDismissalRequest represents a request to dismiss a review.
func (*PullRequestReviewDismissalRequest)GetMessage¶
func (p *PullRequestReviewDismissalRequest) GetMessage()string
GetMessage returns the Message field if it's non-nil, zero value otherwise.
func (PullRequestReviewDismissalRequest)String¶
func (rPullRequestReviewDismissalRequest) String()string
typePullRequestReviewEvent¶
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 pullrequest.The Webhook event name is "pull_request_review".
GitHub API docs:https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#pull_request_review
func (*PullRequestReviewEvent)GetAction¶
func (p *PullRequestReviewEvent) GetAction()string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*PullRequestReviewEvent)GetInstallation¶
func (p *PullRequestReviewEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*PullRequestReviewEvent)GetOrganization¶
func (p *PullRequestReviewEvent) GetOrganization() *Organization
GetOrganization returns the Organization field.
func (*PullRequestReviewEvent)GetPullRequest¶
func (p *PullRequestReviewEvent) GetPullRequest() *PullRequest
GetPullRequest returns the PullRequest field.
func (*PullRequestReviewEvent)GetRepo¶
func (p *PullRequestReviewEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (*PullRequestReviewEvent)GetReview¶
func (p *PullRequestReviewEvent) GetReview() *PullRequestReview
GetReview returns the Review field.
func (*PullRequestReviewEvent)GetSender¶
func (p *PullRequestReviewEvent) GetSender() *User
GetSender returns the Sender field.
typePullRequestReviewRequest¶
type PullRequestReviewRequest struct {NodeID *string `json:"node_id,omitempty"`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 (*PullRequestReviewRequest)GetBody¶
func (p *PullRequestReviewRequest) GetBody()string
GetBody returns the Body field if it's non-nil, zero value otherwise.
func (*PullRequestReviewRequest)GetCommitID¶
func (p *PullRequestReviewRequest) GetCommitID()string
GetCommitID returns the CommitID field if it's non-nil, zero value otherwise.
func (*PullRequestReviewRequest)GetEvent¶
func (p *PullRequestReviewRequest) GetEvent()string
GetEvent returns the Event field if it's non-nil, zero value otherwise.
func (*PullRequestReviewRequest)GetNodeID¶
func (p *PullRequestReviewRequest) GetNodeID()string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (PullRequestReviewRequest)String¶
func (rPullRequestReviewRequest) String()string
typePullRequestReviewsEnforcement¶
type PullRequestReviewsEnforcement struct {// Specifies which users and teams can dismiss pull request reviews.DismissalRestrictions *DismissalRestrictions `json:"dismissal_restrictions,omitempty"`// Specifies if approved reviews are dismissed automatically, when a new commit is pushed.DismissStaleReviewsbool `json:"dismiss_stale_reviews"`// RequireCodeOwnerReviews specifies if an approved review is required in pull requests including files with a designated code owner.RequireCodeOwnerReviewsbool `json:"require_code_owner_reviews"`// RequiredApprovingReviewCount specifies the number of approvals required before the pull request can be merged.// Valid values are 1-6.RequiredApprovingReviewCountint `json:"required_approving_review_count"`}
PullRequestReviewsEnforcement represents the pull request reviews enforcement of a protected branch.
func (*PullRequestReviewsEnforcement)GetDismissalRestrictions¶
func (p *PullRequestReviewsEnforcement) GetDismissalRestrictions() *DismissalRestrictions
GetDismissalRestrictions returns the DismissalRestrictions field.
typePullRequestReviewsEnforcementRequest¶
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)DismissStaleReviewsbool `json:"dismiss_stale_reviews"`// RequireCodeOwnerReviews specifies if an approved review is required in pull requests including files with a designated code owner.RequireCodeOwnerReviewsbool `json:"require_code_owner_reviews"`// RequiredApprovingReviewCount specifies the number of approvals required before the pull request can be merged.// Valid values are 1-6.RequiredApprovingReviewCountint `json:"required_approving_review_count"`}
PullRequestReviewsEnforcementRequest represents request to set the pull request reviewenforcement of a protected branch. It is separate from PullRequestReviewsEnforcement abovebecause the request structure is different from the response structure.
func (*PullRequestReviewsEnforcementRequest)GetDismissalRestrictionsRequest¶
func (p *PullRequestReviewsEnforcementRequest) GetDismissalRestrictionsRequest() *DismissalRestrictionsRequest
GetDismissalRestrictionsRequest returns the DismissalRestrictionsRequest field.
typePullRequestReviewsEnforcementUpdate¶
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 merging pull requests is blocked until code owners have reviewed.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 or 0 to not require reviewers.RequiredApprovingReviewCountint `json:"required_approving_review_count"`}
PullRequestReviewsEnforcementUpdate represents request to patch the pull request reviewenforcement of a protected branch. It is separate from PullRequestReviewsEnforcementRequest abovebecause the patch request does not require all fields to be initialized.
func (*PullRequestReviewsEnforcementUpdate)GetDismissStaleReviews¶
func (p *PullRequestReviewsEnforcementUpdate) GetDismissStaleReviews()bool
GetDismissStaleReviews returns the DismissStaleReviews field if it's non-nil, zero value otherwise.
func (*PullRequestReviewsEnforcementUpdate)GetDismissalRestrictionsRequest¶
func (p *PullRequestReviewsEnforcementUpdate) GetDismissalRestrictionsRequest() *DismissalRestrictionsRequest
GetDismissalRestrictionsRequest returns the DismissalRestrictionsRequest field.
func (*PullRequestReviewsEnforcementUpdate)GetRequireCodeOwnerReviews¶
func (p *PullRequestReviewsEnforcementUpdate) GetRequireCodeOwnerReviews()bool
GetRequireCodeOwnerReviews returns the RequireCodeOwnerReviews field if it's non-nil, zero value otherwise.
typePullRequestTargetEvent¶
type PullRequestTargetEvent struct {// Action is the action that was performed. Possible values are:// "assigned", "unassigned", "labeled", "unlabeled", "opened", "edited", "closed", "reopened",// "ready_for_review", "locked", "unlocked", "review_requested" or "review_request_removed".// 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.// While webhooks are also triggered when a pull request is synchronized, Events API timelines// don't include pull request events with the "synchronize" action.Action *string `json:"action,omitempty"`Assignee *User `json:"assignee,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"`// In the event that a team is requested instead of a user, "requested_team" gets sent in place of// "requested_user" with the same delivery behavior.RequestedTeam *Team `json:"requested_team,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.// The following field is only present when the webhook is triggered on// a repository belonging to an organization.Organization *Organization `json:"organization,omitempty"`// The following fields are only populated when the Action is "synchronize".Before *string `json:"before,omitempty"`After *string `json:"after,omitempty"`}
PullRequestTargetEvent is triggered when a pull request is assigned, unassigned, labeled,unlabeled, opened, edited, closed, reopened, synchronize, ready_for_review,locked, unlocked, a pull request review is requested, or a review request is removed.The Webhook event name is "pull_request_target".
GitHub API docs:https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request_target
func (*PullRequestTargetEvent)GetAction¶
func (p *PullRequestTargetEvent) GetAction()string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*PullRequestTargetEvent)GetAfter¶
func (p *PullRequestTargetEvent) GetAfter()string
GetAfter returns the After field if it's non-nil, zero value otherwise.
func (*PullRequestTargetEvent)GetAssignee¶
func (p *PullRequestTargetEvent) GetAssignee() *User
GetAssignee returns the Assignee field.
func (*PullRequestTargetEvent)GetBefore¶
func (p *PullRequestTargetEvent) GetBefore()string
GetBefore returns the Before field if it's non-nil, zero value otherwise.
func (*PullRequestTargetEvent)GetChanges¶
func (p *PullRequestTargetEvent) GetChanges() *EditChange
GetChanges returns the Changes field.
func (*PullRequestTargetEvent)GetInstallation¶
func (p *PullRequestTargetEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*PullRequestTargetEvent)GetLabel¶
func (p *PullRequestTargetEvent) GetLabel() *Label
GetLabel returns the Label field.
func (*PullRequestTargetEvent)GetNumber¶
func (p *PullRequestTargetEvent) GetNumber()int
GetNumber returns the Number field if it's non-nil, zero value otherwise.
func (*PullRequestTargetEvent)GetOrganization¶
func (p *PullRequestTargetEvent) GetOrganization() *Organization
GetOrganization returns the Organization field.
func (*PullRequestTargetEvent)GetPullRequest¶
func (p *PullRequestTargetEvent) GetPullRequest() *PullRequest
GetPullRequest returns the PullRequest field.
func (*PullRequestTargetEvent)GetRepo¶
func (p *PullRequestTargetEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (*PullRequestTargetEvent)GetRequestedReviewer¶
func (p *PullRequestTargetEvent) GetRequestedReviewer() *User
GetRequestedReviewer returns the RequestedReviewer field.
func (*PullRequestTargetEvent)GetRequestedTeam¶
func (p *PullRequestTargetEvent) GetRequestedTeam() *Team
GetRequestedTeam returns the RequestedTeam field.
func (*PullRequestTargetEvent)GetSender¶
func (p *PullRequestTargetEvent) GetSender() *User
GetSender returns the Sender field.
typePullRequestsService¶
type PullRequestsService service
PullRequestsService handles communication with the pull request relatedmethods of the GitHub API.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/pulls/
func (*PullRequestsService)Create¶
func (s *PullRequestsService) Create(ctxcontext.Context, ownerstring, repostring, pull *NewPullRequest) (*PullRequest, *Response,error)
Create a new pull request on the specified repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/pulls/#create-a-pull-request
Example¶
package mainimport ("context""fmt""github.com/google/go-github/v43/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-Authenticationclient := 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),}ctx := context.Background()pr, _, err := client.PullRequests.Create(ctx, "myOrganization", "myRepository", newPR)if err != nil {fmt.Println(err)return}fmt.Printf("PR created: %s\n", pr.GetHTMLURL())}
func (*PullRequestsService)CreateComment¶
func (s *PullRequestsService) CreateComment(ctxcontext.Context, owner, repostring, numberint, comment *PullRequestComment) (*PullRequestComment, *Response,error)
CreateComment creates a new comment on the specified pull request.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/pulls/#create-a-review-comment-for-a-pull-request
func (*PullRequestsService)CreateCommentInReplyTo¶
func (s *PullRequestsService) CreateCommentInReplyTo(ctxcontext.Context, owner, repostring, numberint, bodystring, commentIDint64) (*PullRequestComment, *Response,error)
CreateCommentInReplyTo creates a new comment as a reply to an existing pull request comment.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/pulls/#create-a-review-comment-for-a-pull-request
func (*PullRequestsService)CreateReview¶
func (s *PullRequestsService) CreateReview(ctxcontext.Context, owner, repostring, numberint, review *PullRequestReviewRequest) (*PullRequestReview, *Response,error)
CreateReview creates a new review on the specified pull request.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/pulls/#create-a-review-for-a-pull-request
In order to use multi-line comments, you must use the "comfort fade" preview.This replaces the use of the "Position" field in comments with 4 new fields:
[Start]Side, and [Start]Line.
These new fields must be used for ALL comments (including single-line),with the following restrictions (empirically observed, so subject to change).
For single-line "comfort fade" comments, you must use:
Path: &path, // as beforeBody: &body, // as beforeSide: &"RIGHT" (or "LEFT")Line: &123, // NOT THE SAME AS POSITION, this is an actual line number.
If StartSide or StartLine is used with single-line comments, a 422 is returned.
For multi-line "comfort fade" comments, you must use:
Path: &path, // as beforeBody: &body, // as beforeStartSide: &"RIGHT" (or "LEFT")Side: &"RIGHT" (or "LEFT")StartLine: &120,Line: &125,
Suggested edits are made by commenting on the lines to replace, and including thesuggested edit in a block like this (it may be surrounded in non-suggestion markdown):
```suggestionUse this instead.It is waaaaaay better.```
func (*PullRequestsService)DeleteComment¶
func (s *PullRequestsService) DeleteComment(ctxcontext.Context, owner, repostring, commentIDint64) (*Response,error)
DeleteComment deletes a pull request comment.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/pulls/#delete-a-review-comment-for-a-pull-request
func (*PullRequestsService)DeletePendingReview¶
func (s *PullRequestsService) DeletePendingReview(ctxcontext.Context, owner, repostring, numberint, reviewIDint64) (*PullRequestReview, *Response,error)
DeletePendingReview deletes the specified pull request pending review.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/pulls/#delete-a-pending-review-for-a-pull-request
func (*PullRequestsService)DismissReview¶
func (s *PullRequestsService) DismissReview(ctxcontext.Context, owner, repostring, numberint, reviewIDint64, review *PullRequestReviewDismissalRequest) (*PullRequestReview, *Response,error)
DismissReview dismisses a specified review on the specified pull request.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/pulls/#dismiss-a-review-for-a-pull-request
func (*PullRequestsService)Edit¶
func (s *PullRequestsService) Edit(ctxcontext.Context, ownerstring, repostring, numberint, 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://docs.github.com/en/free-pro-team@latest/rest/reference/pulls/#update-a-pull-request
func (*PullRequestsService)EditComment¶
func (s *PullRequestsService) EditComment(ctxcontext.Context, owner, repostring, commentIDint64, 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://docs.github.com/en/free-pro-team@latest/rest/reference/pulls/#update-a-review-comment-for-a-pull-request
func (*PullRequestsService)Get¶
func (s *PullRequestsService) Get(ctxcontext.Context, ownerstring, repostring, numberint) (*PullRequest, *Response,error)
Get a single pull request.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/pulls/#get-a-pull-request
func (*PullRequestsService)GetComment¶
func (s *PullRequestsService) GetComment(ctxcontext.Context, owner, repostring, commentIDint64) (*PullRequestComment, *Response,error)
GetComment fetches the specified pull request comment.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/pulls/#get-a-review-comment-for-a-pull-request
func (*PullRequestsService)GetRaw¶
func (s *PullRequestsService) GetRaw(ctxcontext.Context, ownerstring, repostring, numberint, optsRawOptions) (string, *Response,error)
GetRaw gets a single pull request in raw (diff or patch) format.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/pulls/#get-a-pull-request
func (*PullRequestsService)GetReview¶
func (s *PullRequestsService) GetReview(ctxcontext.Context, owner, repostring, numberint, reviewIDint64) (*PullRequestReview, *Response,error)
GetReview fetches the specified pull request review.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/pulls/#get-a-review-for-a-pull-request
func (*PullRequestsService)IsMerged¶
func (s *PullRequestsService) IsMerged(ctxcontext.Context, ownerstring, repostring, numberint) (bool, *Response,error)
IsMerged checks if a pull request has been merged.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/pulls/#check-if-a-pull-request-has-been-merged
func (*PullRequestsService)List¶
func (s *PullRequestsService) List(ctxcontext.Context, ownerstring, repostring, opts *PullRequestListOptions) ([]*PullRequest, *Response,error)
List the pull requests for the specified repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/pulls/#list-pull-requests
func (*PullRequestsService)ListComments¶
func (s *PullRequestsService) ListComments(ctxcontext.Context, owner, repostring, numberint, opts *PullRequestListCommentsOptions) ([]*PullRequestComment, *Response,error)
ListComments lists all comments on the specified pull request. Specifying apull request number of 0 will return all comments on all pull requests forthe repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/pulls/#list-review-comments-on-a-pull-requestGitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/pulls/#list-review-comments-in-a-repository
func (*PullRequestsService)ListCommits¶
func (s *PullRequestsService) ListCommits(ctxcontext.Context, ownerstring, repostring, numberint, opts *ListOptions) ([]*RepositoryCommit, *Response,error)
ListCommits lists the commits in a pull request.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/pulls/#list-commits-on-a-pull-request
func (*PullRequestsService)ListFiles¶
func (s *PullRequestsService) ListFiles(ctxcontext.Context, ownerstring, repostring, numberint, opts *ListOptions) ([]*CommitFile, *Response,error)
ListFiles lists the files in a pull request.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/pulls/#list-pull-requests-files
func (*PullRequestsService)ListPullRequestsWithCommit¶
func (s *PullRequestsService) ListPullRequestsWithCommit(ctxcontext.Context, owner, repo, shastring, opts *PullRequestListOptions) ([]*PullRequest, *Response,error)
ListPullRequestsWithCommit returns pull requests associated with a commit SHA.
The results may include open and closed pull requests.By default, the PullRequestListOptions State filters for "open".
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/commits/#list-pull-requests-associated-with-a-commit
func (*PullRequestsService)ListReviewComments¶
func (s *PullRequestsService) ListReviewComments(ctxcontext.Context, owner, repostring, numberint, reviewIDint64, opts *ListOptions) ([]*PullRequestComment, *Response,error)
ListReviewComments lists all the comments for the specified review.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/pulls/#list-comments-for-a-pull-request-review
func (*PullRequestsService)ListReviewers¶
func (s *PullRequestsService) ListReviewers(ctxcontext.Context, owner, repostring, numberint, opts *ListOptions) (*Reviewers, *Response,error)
ListReviewers lists reviewers whose reviews have been requested on the specified pull request.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/pulls/#list-requested-reviewers-for-a-pull-request
func (*PullRequestsService)ListReviews¶
func (s *PullRequestsService) ListReviews(ctxcontext.Context, owner, repostring, numberint, opts *ListOptions) ([]*PullRequestReview, *Response,error)
ListReviews lists all reviews on the specified pull request.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/pulls/#list-reviews-for-a-pull-request
func (*PullRequestsService)Merge¶
func (s *PullRequestsService) Merge(ctxcontext.Context, ownerstring, repostring, numberint, commitMessagestring, options *PullRequestOptions) (*PullRequestMergeResult, *Response,error)
Merge a pull request.commitMessage is an extra detail to append to automatic commit message.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/pulls/#merge-a-pull-request
func (*PullRequestsService)RemoveReviewers¶
func (s *PullRequestsService) RemoveReviewers(ctxcontext.Context, owner, repostring, numberint, reviewersReviewersRequest) (*Response,error)
RemoveReviewers removes the review request for the provided reviewers for the specified pull request.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/pulls/#remove-requested-reviewers-from-a-pull-request
func (*PullRequestsService)RequestReviewers¶
func (s *PullRequestsService) RequestReviewers(ctxcontext.Context, owner, repostring, numberint, reviewersReviewersRequest) (*PullRequest, *Response,error)
RequestReviewers creates a review request for the provided reviewers for the specified pull request.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/pulls/#request-reviewers-for-a-pull-request
func (*PullRequestsService)SubmitReview¶
func (s *PullRequestsService) SubmitReview(ctxcontext.Context, owner, repostring, numberint, reviewIDint64, review *PullRequestReviewRequest) (*PullRequestReview, *Response,error)
SubmitReview submits a specified review on the specified pull request.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/pulls/#submit-a-review-for-a-pull-request
func (*PullRequestsService)UpdateBranch¶
func (s *PullRequestsService) UpdateBranch(ctxcontext.Context, owner, repostring, numberint, opts *PullRequestBranchUpdateOptions) (*PullRequestBranchUpdateResponse, *Response,error)
UpdateBranch updates the pull request branch with latest upstream changes.
This method might return an AcceptedError and a status code of202. This is because this is the status that GitHub returns to signify thatit has now scheduled the update of the pull request branch in a background task.A follow up request, after a delay of a second or so, should resultin a successful request.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/pulls/#update-a-pull-request-branch
func (*PullRequestsService)UpdateReview¶
func (s *PullRequestsService) UpdateReview(ctxcontext.Context, owner, repostring, numberint, reviewIDint64, bodystring) (*PullRequestReview, *Response,error)
UpdateReview updates the review summary on the specified pull request.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/pulls/#update-a-review-for-a-pull-request
typePullStats¶
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 unmergeablepull-requests.
func (*PullStats)GetMergablePulls¶
GetMergablePulls returns the MergablePulls field if it's non-nil, zero value otherwise.
func (*PullStats)GetMergedPulls¶
GetMergedPulls returns the MergedPulls field if it's non-nil, zero value otherwise.
func (*PullStats)GetTotalPulls¶
GetTotalPulls returns the TotalPulls field if it's non-nil, zero value otherwise.
func (*PullStats)GetUnmergablePulls¶
GetUnmergablePulls returns the UnmergablePulls field if it's non-nil, zero value otherwise.
typePunchCard¶
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 aday of the week.
func (*PunchCard)GetCommits¶
GetCommits returns the Commits field if it's non-nil, zero value otherwise.
typePushEvent¶
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 []*HeadCommit `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 *HeadCommit `json:"head_commit,omitempty"`Pusher *User `json:"pusher,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"`}
PushEvent represents a git push to a GitHub repository.
GitHub API docs:https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#push
func (*PushEvent)GetBaseRef¶
GetBaseRef returns the BaseRef field if it's non-nil, zero value otherwise.
func (*PushEvent)GetBefore¶
GetBefore returns the Before field if it's non-nil, zero value otherwise.
func (*PushEvent)GetCompare¶
GetCompare returns the Compare field if it's non-nil, zero value otherwise.
func (*PushEvent)GetCreated¶
GetCreated returns the Created field if it's non-nil, zero value otherwise.
func (*PushEvent)GetDeleted¶
GetDeleted returns the Deleted field if it's non-nil, zero value otherwise.
func (*PushEvent)GetDistinctSize¶
GetDistinctSize returns the DistinctSize field if it's non-nil, zero value otherwise.
func (*PushEvent)GetForced¶
GetForced returns the Forced field if it's non-nil, zero value otherwise.
func (*PushEvent)GetHeadCommit¶
func (p *PushEvent) GetHeadCommit() *HeadCommit
GetHeadCommit returns the HeadCommit field.
func (*PushEvent)GetInstallation¶
func (p *PushEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*PushEvent)GetOrganization¶
func (p *PushEvent) GetOrganization() *Organization
GetOrganization returns the Organization field.
func (*PushEvent)GetPushID¶
GetPushID returns the PushID field if it's non-nil, zero value otherwise.
func (*PushEvent)GetRepo¶
func (p *PushEvent) GetRepo() *PushEventRepository
GetRepo returns the Repo field.
typePushEventRepoOwner¶
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 (*PushEventRepoOwner)GetEmail¶
func (p *PushEventRepoOwner) GetEmail()string
GetEmail returns the Email field if it's non-nil, zero value otherwise.
func (*PushEventRepoOwner)GetName¶
func (p *PushEventRepoOwner) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
typePushEventRepository¶
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 *User `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"`PullsURL *string `json:"pulls_url,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"`Archived *bool `json:"archived,omitempty"`Disabled *bool `json:"disabled,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 (*PushEventRepository)GetArchiveURL¶
func (p *PushEventRepository) GetArchiveURL()string
GetArchiveURL returns the ArchiveURL field if it's non-nil, zero value otherwise.
func (*PushEventRepository)GetArchived¶
func (p *PushEventRepository) GetArchived()bool
GetArchived returns the Archived field if it's non-nil, zero value otherwise.
func (*PushEventRepository)GetCloneURL¶
func (p *PushEventRepository) GetCloneURL()string
GetCloneURL returns the CloneURL field if it's non-nil, zero value otherwise.
func (*PushEventRepository)GetCreatedAt¶
func (p *PushEventRepository) GetCreatedAt()Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*PushEventRepository)GetDefaultBranch¶
func (p *PushEventRepository) GetDefaultBranch()string
GetDefaultBranch returns the DefaultBranch field if it's non-nil, zero value otherwise.
func (*PushEventRepository)GetDescription¶
func (p *PushEventRepository) GetDescription()string
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (*PushEventRepository)GetDisabled¶
func (p *PushEventRepository) GetDisabled()bool
GetDisabled returns the Disabled field if it's non-nil, zero value otherwise.
func (*PushEventRepository)GetFork¶
func (p *PushEventRepository) GetFork()bool
GetFork returns the Fork field if it's non-nil, zero value otherwise.
func (*PushEventRepository)GetForksCount¶
func (p *PushEventRepository) GetForksCount()int
GetForksCount returns the ForksCount field if it's non-nil, zero value otherwise.
func (*PushEventRepository)GetFullName¶
func (p *PushEventRepository) GetFullName()string
GetFullName returns the FullName field if it's non-nil, zero value otherwise.
func (*PushEventRepository)GetGitURL¶
func (p *PushEventRepository) GetGitURL()string
GetGitURL returns the GitURL field if it's non-nil, zero value otherwise.
func (*PushEventRepository)GetHTMLURL¶
func (p *PushEventRepository) GetHTMLURL()string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*PushEventRepository)GetHasDownloads¶
func (p *PushEventRepository) GetHasDownloads()bool
GetHasDownloads returns the HasDownloads field if it's non-nil, zero value otherwise.
func (*PushEventRepository)GetHasIssues¶
func (p *PushEventRepository) GetHasIssues()bool
GetHasIssues returns the HasIssues field if it's non-nil, zero value otherwise.
func (*PushEventRepository)GetHasPages¶
func (p *PushEventRepository) GetHasPages()bool
GetHasPages returns the HasPages field if it's non-nil, zero value otherwise.
func (*PushEventRepository)GetHasWiki¶
func (p *PushEventRepository) GetHasWiki()bool
GetHasWiki returns the HasWiki field if it's non-nil, zero value otherwise.
func (*PushEventRepository)GetHomepage¶
func (p *PushEventRepository) GetHomepage()string
GetHomepage returns the Homepage field if it's non-nil, zero value otherwise.
func (*PushEventRepository)GetID¶
func (p *PushEventRepository) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*PushEventRepository)GetLanguage¶
func (p *PushEventRepository) GetLanguage()string
GetLanguage returns the Language field if it's non-nil, zero value otherwise.
func (*PushEventRepository)GetMasterBranch¶
func (p *PushEventRepository) GetMasterBranch()string
GetMasterBranch returns the MasterBranch field if it's non-nil, zero value otherwise.
func (*PushEventRepository)GetName¶
func (p *PushEventRepository) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*PushEventRepository)GetNodeID¶
func (p *PushEventRepository) GetNodeID()string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (*PushEventRepository)GetOpenIssuesCount¶
func (p *PushEventRepository) GetOpenIssuesCount()int
GetOpenIssuesCount returns the OpenIssuesCount field if it's non-nil, zero value otherwise.
func (*PushEventRepository)GetOrganization¶
func (p *PushEventRepository) GetOrganization()string
GetOrganization returns the Organization field if it's non-nil, zero value otherwise.
func (*PushEventRepository)GetOwner¶
func (p *PushEventRepository) GetOwner() *User
GetOwner returns the Owner field.
func (*PushEventRepository)GetPrivate¶
func (p *PushEventRepository) GetPrivate()bool
GetPrivate returns the Private field if it's non-nil, zero value otherwise.
func (*PushEventRepository)GetPullsURL¶
func (p *PushEventRepository) GetPullsURL()string
GetPullsURL returns the PullsURL field if it's non-nil, zero value otherwise.
func (*PushEventRepository)GetPushedAt¶
func (p *PushEventRepository) GetPushedAt()Timestamp
GetPushedAt returns the PushedAt field if it's non-nil, zero value otherwise.
func (*PushEventRepository)GetSSHURL¶
func (p *PushEventRepository) GetSSHURL()string
GetSSHURL returns the SSHURL field if it's non-nil, zero value otherwise.
func (*PushEventRepository)GetSVNURL¶
func (p *PushEventRepository) GetSVNURL()string
GetSVNURL returns the SVNURL field if it's non-nil, zero value otherwise.
func (*PushEventRepository)GetSize¶
func (p *PushEventRepository) GetSize()int
GetSize returns the Size field if it's non-nil, zero value otherwise.
func (*PushEventRepository)GetStargazersCount¶
func (p *PushEventRepository) GetStargazersCount()int
GetStargazersCount returns the StargazersCount field if it's non-nil, zero value otherwise.
func (*PushEventRepository)GetStatusesURL¶
func (p *PushEventRepository) GetStatusesURL()string
GetStatusesURL returns the StatusesURL field if it's non-nil, zero value otherwise.
func (*PushEventRepository)GetURL¶
func (p *PushEventRepository) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (*PushEventRepository)GetUpdatedAt¶
func (p *PushEventRepository) GetUpdatedAt()Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (*PushEventRepository)GetWatchersCount¶
func (p *PushEventRepository) GetWatchersCount()int
GetWatchersCount returns the WatchersCount field if it's non-nil, zero value otherwise.
typeRate¶
type Rate struct {// The number of requests per hour the client is currently limited to.Limitint `json:"limit"`// The number of remaining requests the client can make this hour.Remainingint `json:"remaining"`// The time at which the current rate limit will reset.ResetTimestamp `json:"reset"`}
Rate represents the rate limit for the current client.
typeRateLimitError¶
type RateLimitError struct {RateRate// Rate specifies last known rate limit for the clientResponse *http.Response// HTTP response that caused this errorMessagestring `json:"message"`// error message}
RateLimitError occurs when GitHub returns 403 Forbidden response with a rate limitremaining value of 0.
func (*RateLimitError)Error¶
func (r *RateLimitError) Error()string
func (*RateLimitError)Is¶
func (r *RateLimitError) Is(targeterror)bool
Is returns whether the provided error equals this error.
typeRateLimits¶
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://docs.github.com/en/free-pro-team@latest/rest/reference/#rate-limitingCore *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://docs.github.com/en/free-pro-team@latest/rest/reference/search/#rate-limitSearch *Rate `json:"search"`}
RateLimits represents the rate limits for the current client.
func (*RateLimits)GetSearch¶
func (r *RateLimits) GetSearch() *Rate
GetSearch returns the Search field.
func (RateLimits)String¶
func (rRateLimits) String()string
typeRawOptions¶
type RawOptions struct {TypeRawType}
RawOptions specifies parameters when user wants to get raw format ofa response instead of JSON.
typeReaction¶
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", "rocket", or "eyes".Content *string `json:"content,omitempty"`}
Reaction represents a GitHub reaction.
func (*Reaction)GetContent¶
GetContent returns the Content field if it's non-nil, zero value otherwise.
typeReactions¶
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"`Rocket *int `json:"rocket,omitempty"`Eyes *int `json:"eyes,omitempty"`URL *string `json:"url,omitempty"`}
Reactions represents a summary of GitHub reactions.
func (*Reactions)GetConfused¶
GetConfused returns the Confused field if it's non-nil, zero value otherwise.
func (*Reactions)GetHooray¶
GetHooray returns the Hooray field if it's non-nil, zero value otherwise.
func (*Reactions)GetMinusOne¶
GetMinusOne returns the MinusOne field if it's non-nil, zero value otherwise.
func (*Reactions)GetPlusOne¶
GetPlusOne returns the PlusOne field if it's non-nil, zero value otherwise.
func (*Reactions)GetRocket¶
GetRocket returns the Rocket field if it's non-nil, zero value otherwise.
func (*Reactions)GetTotalCount¶
GetTotalCount returns the TotalCount field if it's non-nil, zero value otherwise.
typeReactionsService¶
type ReactionsService service
ReactionsService provides access to the reactions-related functions in theGitHub API.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/reactions/
func (*ReactionsService)CreateCommentReaction¶
func (s *ReactionsService) CreateCommentReaction(ctxcontext.Context, owner, repostring, idint64, contentstring) (*Reaction, *Response,error)
CreateCommentReaction creates a reaction for a commit comment.Note that if you have already created a reaction of type content, thepreviously created reaction will be returned with Status: 200 OK.The content should have one of the following values: "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", or "eyes".
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/reactions/#create-reaction-for-a-commit-comment
func (*ReactionsService)CreateIssueCommentReaction¶
func (s *ReactionsService) CreateIssueCommentReaction(ctxcontext.Context, owner, repostring, idint64, contentstring) (*Reaction, *Response,error)
CreateIssueCommentReaction creates a reaction for an issue comment.Note that if you have already created a reaction of type content, thepreviously created reaction will be returned with Status: 200 OK.The content should have one of the following values: "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", or "eyes".
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/reactions/#create-reaction-for-an-issue-comment
func (*ReactionsService)CreateIssueReaction¶
func (s *ReactionsService) CreateIssueReaction(ctxcontext.Context, owner, repostring, numberint, contentstring) (*Reaction, *Response,error)
CreateIssueReaction creates a reaction for an issue.Note that if you have already created a reaction of type content, thepreviously created reaction will be returned with Status: 200 OK.The content should have one of the following values: "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", or "eyes".
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/reactions/#create-reaction-for-an-issue
func (*ReactionsService)CreatePullRequestCommentReaction¶
func (s *ReactionsService) CreatePullRequestCommentReaction(ctxcontext.Context, owner, repostring, idint64, contentstring) (*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, thepreviously created reaction will be returned with Status: 200 OK.The content should have one of the following values: "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", or "eyes".
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/reactions/#create-reaction-for-a-pull-request-review-comment
func (*ReactionsService)CreateReleaseReaction¶
func (s *ReactionsService) CreateReleaseReaction(ctxcontext.Context, owner, repostring, releaseIDint64, contentstring) (*Reaction, *Response,error)
Create a reaction to a release.Note that a response with a Status: 200 OK means that you alreadyadded the reaction type to this release.The content should have one of the following values: "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", or "eyes".
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/reactions/#create-reaction-for-a-release
func (*ReactionsService)CreateTeamDiscussionCommentReaction¶
func (s *ReactionsService) CreateTeamDiscussionCommentReaction(ctxcontext.Context, teamIDint64, discussionNumber, commentNumberint, contentstring) (*Reaction, *Response,error)
CreateTeamDiscussionCommentReaction creates a reaction for a team discussion comment.The content should have one of the following values: "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", or "eyes".
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/reactions/#create-reaction-for-a-team-discussion-comment-legacy
func (*ReactionsService)CreateTeamDiscussionReaction¶
func (s *ReactionsService) CreateTeamDiscussionReaction(ctxcontext.Context, teamIDint64, discussionNumberint, contentstring) (*Reaction, *Response,error)
CreateTeamDiscussionReaction creates a reaction for a team discussion.The content should have one of the following values: "+1", "-1", "laugh", "confused", "heart", "hooray", "rocket", or "eyes".
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/reactions/#create-reaction-for-a-team-discussion-legacy
func (*ReactionsService)DeleteCommentReaction¶
func (s *ReactionsService) DeleteCommentReaction(ctxcontext.Context, owner, repostring, commentID, reactionIDint64) (*Response,error)
DeleteCommentReaction deletes the reaction for a commit comment.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/reactions/#delete-a-commit-comment-reaction
func (*ReactionsService)DeleteCommentReactionByID¶
func (s *ReactionsService) DeleteCommentReactionByID(ctxcontext.Context, repoID, commentID, reactionIDint64) (*Response,error)
DeleteCommentReactionByID deletes the reaction for a commit comment by repository ID.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/reactions/#delete-a-commit-comment-reaction
func (*ReactionsService)DeleteIssueCommentReaction¶
func (s *ReactionsService) DeleteIssueCommentReaction(ctxcontext.Context, owner, repostring, commentID, reactionIDint64) (*Response,error)
DeleteIssueCommentReaction deletes the reaction to an issue comment.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/reactions/#delete-an-issue-comment-reaction
func (*ReactionsService)DeleteIssueCommentReactionByID¶
func (s *ReactionsService) DeleteIssueCommentReactionByID(ctxcontext.Context, repoID, commentID, reactionIDint64) (*Response,error)
DeleteIssueCommentReactionByID deletes the reaction to an issue comment by repository ID.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/reactions/#delete-an-issue-comment-reaction
func (*ReactionsService)DeleteIssueReaction¶
func (s *ReactionsService) DeleteIssueReaction(ctxcontext.Context, owner, repostring, issueNumberint, reactionIDint64) (*Response,error)
DeleteIssueReaction deletes the reaction to an issue.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/reactions/#delete-an-issue-reaction
func (*ReactionsService)DeleteIssueReactionByID¶
func (s *ReactionsService) DeleteIssueReactionByID(ctxcontext.Context, repoID, issueNumberint, reactionIDint64) (*Response,error)
DeleteIssueReactionByID deletes the reaction to an issue by repository ID.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/reactions/#delete-an-issue-reaction
func (*ReactionsService)DeletePullRequestCommentReaction¶
func (s *ReactionsService) DeletePullRequestCommentReaction(ctxcontext.Context, owner, repostring, commentID, reactionIDint64) (*Response,error)
DeletePullRequestCommentReaction deletes the reaction to a pull request review comment.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/reactions/#delete-a-pull-request-comment-reaction
func (*ReactionsService)DeletePullRequestCommentReactionByID¶
func (s *ReactionsService) DeletePullRequestCommentReactionByID(ctxcontext.Context, repoID, commentID, reactionIDint64) (*Response,error)
DeletePullRequestCommentReactionByID deletes the reaction to a pull request review comment by repository ID.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/reactions/#delete-a-pull-request-comment-reaction
func (*ReactionsService)DeleteTeamDiscussionCommentReaction¶
func (s *ReactionsService) DeleteTeamDiscussionCommentReaction(ctxcontext.Context, org, teamSlugstring, discussionNumber, commentNumberint, reactionIDint64) (*Response,error)
DeleteTeamDiscussionCommentReaction deletes the reaction to a team discussion comment.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/reactions/#delete-team-discussion-comment-reaction
func (*ReactionsService)DeleteTeamDiscussionCommentReactionByOrgIDAndTeamID¶
func (s *ReactionsService) DeleteTeamDiscussionCommentReactionByOrgIDAndTeamID(ctxcontext.Context, orgID, teamID, discussionNumber, commentNumberint, reactionIDint64) (*Response,error)
DeleteTeamDiscussionCommentReactionByOrgIDAndTeamID deletes the reaction to a team discussion comment by organization ID and team ID.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/reactions/#delete-team-discussion-comment-reaction
func (*ReactionsService)DeleteTeamDiscussionReaction¶
func (s *ReactionsService) DeleteTeamDiscussionReaction(ctxcontext.Context, org, teamSlugstring, discussionNumberint, reactionIDint64) (*Response,error)
DeleteTeamDiscussionReaction deletes the reaction to a team discussion.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/reactions/#delete-team-discussion-reaction
func (*ReactionsService)DeleteTeamDiscussionReactionByOrgIDAndTeamID¶
func (s *ReactionsService) DeleteTeamDiscussionReactionByOrgIDAndTeamID(ctxcontext.Context, orgID, teamID, discussionNumberint, reactionIDint64) (*Response,error)
DeleteTeamDiscussionReactionByOrgIDAndTeamID deletes the reaction to a team discussion by organization ID and team ID.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/reactions/#delete-team-discussion-reaction
func (*ReactionsService)ListCommentReactions¶
func (s *ReactionsService) ListCommentReactions(ctxcontext.Context, owner, repostring, idint64, opts *ListCommentReactionOptions) ([]*Reaction, *Response,error)
ListCommentReactions lists the reactions for a commit comment.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/reactions/#list-reactions-for-a-commit-comment
func (*ReactionsService)ListIssueCommentReactions¶
func (s *ReactionsService) ListIssueCommentReactions(ctxcontext.Context, owner, repostring, idint64, opts *ListOptions) ([]*Reaction, *Response,error)
ListIssueCommentReactions lists the reactions for an issue comment.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/reactions/#list-reactions-for-an-issue-comment
func (*ReactionsService)ListIssueReactions¶
func (s *ReactionsService) ListIssueReactions(ctxcontext.Context, owner, repostring, numberint, opts *ListOptions) ([]*Reaction, *Response,error)
ListIssueReactions lists the reactions for an issue.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/reactions/#list-reactions-for-an-issue
func (*ReactionsService)ListPullRequestCommentReactions¶
func (s *ReactionsService) ListPullRequestCommentReactions(ctxcontext.Context, owner, repostring, idint64, opts *ListOptions) ([]*Reaction, *Response,error)
ListPullRequestCommentReactions lists the reactions for a pull request review comment.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/reactions/#list-reactions-for-a-pull-request-review-comment
func (*ReactionsService)ListTeamDiscussionCommentReactions¶
func (s *ReactionsService) ListTeamDiscussionCommentReactions(ctxcontext.Context, teamIDint64, discussionNumber, commentNumberint, opts *ListOptions) ([]*Reaction, *Response,error)
ListTeamDiscussionCommentReactions lists the reactions for a team discussion comment.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/reactions/#list-reactions-for-a-team-discussion-comment-legacy
func (*ReactionsService)ListTeamDiscussionReactions¶
func (s *ReactionsService) ListTeamDiscussionReactions(ctxcontext.Context, teamIDint64, discussionNumberint, opts *ListOptions) ([]*Reaction, *Response,error)
ListTeamDiscussionReactions lists the reactions for a team discussion.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/reactions/#list-reactions-for-a-team-discussion-legacy
typeReference¶
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 (*Reference)GetNodeID¶
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
typeReferenceListOptions¶
type ReferenceListOptions struct {Refstring `url:"-"`ListOptions}
ReferenceListOptions specifies optional parameters to theGitService.ListMatchingRefs method.
typeRegistrationToken¶
type RegistrationToken struct {Token *string `json:"token,omitempty"`ExpiresAt *Timestamp `json:"expires_at,omitempty"`}
RegistrationToken represents a token that can be used to add a self-hosted runner to a repository.
func (*RegistrationToken)GetExpiresAt¶
func (r *RegistrationToken) GetExpiresAt()Timestamp
GetExpiresAt returns the ExpiresAt field if it's non-nil, zero value otherwise.
func (*RegistrationToken)GetToken¶
func (r *RegistrationToken) GetToken()string
GetToken returns the Token field if it's non-nil, zero value otherwise.
typeReleaseAsset¶
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 (*ReleaseAsset)GetBrowserDownloadURL¶
func (r *ReleaseAsset) GetBrowserDownloadURL()string
GetBrowserDownloadURL returns the BrowserDownloadURL field if it's non-nil, zero value otherwise.
func (*ReleaseAsset)GetContentType¶
func (r *ReleaseAsset) GetContentType()string
GetContentType returns the ContentType field if it's non-nil, zero value otherwise.
func (*ReleaseAsset)GetCreatedAt¶
func (r *ReleaseAsset) GetCreatedAt()Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*ReleaseAsset)GetDownloadCount¶
func (r *ReleaseAsset) GetDownloadCount()int
GetDownloadCount returns the DownloadCount field if it's non-nil, zero value otherwise.
func (*ReleaseAsset)GetID¶
func (r *ReleaseAsset) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*ReleaseAsset)GetLabel¶
func (r *ReleaseAsset) GetLabel()string
GetLabel returns the Label field if it's non-nil, zero value otherwise.
func (*ReleaseAsset)GetName¶
func (r *ReleaseAsset) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*ReleaseAsset)GetNodeID¶
func (r *ReleaseAsset) GetNodeID()string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (*ReleaseAsset)GetSize¶
func (r *ReleaseAsset) GetSize()int
GetSize returns the Size field if it's non-nil, zero value otherwise.
func (*ReleaseAsset)GetState¶
func (r *ReleaseAsset) GetState()string
GetState returns the State field if it's non-nil, zero value otherwise.
func (*ReleaseAsset)GetURL¶
func (r *ReleaseAsset) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (*ReleaseAsset)GetUpdatedAt¶
func (r *ReleaseAsset) GetUpdatedAt()Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (*ReleaseAsset)GetUploader¶
func (r *ReleaseAsset) GetUploader() *User
GetUploader returns the Uploader field.
func (ReleaseAsset)String¶
func (rReleaseAsset) String()string
typeReleaseEvent¶
type ReleaseEvent struct {// Action is the action that was performed. Possible values are: "published", "unpublished",// "created", "edited", "deleted", or "prereleased".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, unpublished, created,edited, deleted, or prereleased.The Webhook event name is "release".
GitHub API docs:https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#release
func (*ReleaseEvent)GetAction¶
func (r *ReleaseEvent) GetAction()string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*ReleaseEvent)GetInstallation¶
func (r *ReleaseEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*ReleaseEvent)GetRelease¶
func (r *ReleaseEvent) GetRelease() *RepositoryRelease
GetRelease returns the Release field.
func (*ReleaseEvent)GetRepo¶
func (r *ReleaseEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (*ReleaseEvent)GetSender¶
func (r *ReleaseEvent) GetSender() *User
GetSender returns the Sender field.
typeRemoveToken¶
type RemoveToken struct {Token *string `json:"token,omitempty"`ExpiresAt *Timestamp `json:"expires_at,omitempty"`}
RemoveToken represents a token that can be used to remove a self-hosted runner from a repository.
func (*RemoveToken)GetExpiresAt¶
func (r *RemoveToken) GetExpiresAt()Timestamp
GetExpiresAt returns the ExpiresAt field if it's non-nil, zero value otherwise.
func (*RemoveToken)GetToken¶
func (r *RemoveToken) GetToken()string
GetToken returns the Token field if it's non-nil, zero value otherwise.
typeRename¶
Rename contains details for 'renamed' events.
typeRenameOrgResponse¶
type RenameOrgResponse struct {Message *string `json:"message,omitempty"`URL *string `json:"url,omitempty"`}
RenameOrgResponse is the response given when renaming an Organization.
func (*RenameOrgResponse)GetMessage¶
func (r *RenameOrgResponse) GetMessage()string
GetMessage returns the Message field if it's non-nil, zero value otherwise.
func (*RenameOrgResponse)GetURL¶
func (r *RenameOrgResponse) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
typeRepoName¶
type RepoName struct {From *string `json:"from,omitempty"`}
RepoName represents a change of repository name.
typeRepoStats¶
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 repositoriestogether with the total number of pushes and wikis.
func (*RepoStats)GetForkRepos¶
GetForkRepos returns the ForkRepos field if it's non-nil, zero value otherwise.
func (*RepoStats)GetOrgRepos¶
GetOrgRepos returns the OrgRepos field if it's non-nil, zero value otherwise.
func (*RepoStats)GetRootRepos¶
GetRootRepos returns the RootRepos field if it's non-nil, zero value otherwise.
func (*RepoStats)GetTotalPushes¶
GetTotalPushes returns the TotalPushes field if it's non-nil, zero value otherwise.
func (*RepoStats)GetTotalRepos¶
GetTotalRepos returns the TotalRepos field if it's non-nil, zero value otherwise.
func (*RepoStats)GetTotalWikis¶
GetTotalWikis returns the TotalWikis field if it's non-nil, zero value otherwise.
typeRepoStatus¶
type RepoStatus struct {ID *int64 `json:"id,omitempty"`NodeID *string `json:"node_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"`// AvatarURL is the URL of the avatar of this status.AvatarURL *string `json:"avatar_url,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 (*RepoStatus)GetAvatarURL¶
func (r *RepoStatus) GetAvatarURL()string
GetAvatarURL returns the AvatarURL field if it's non-nil, zero value otherwise.
func (*RepoStatus)GetContext¶
func (r *RepoStatus) GetContext()string
GetContext returns the Context field if it's non-nil, zero value otherwise.
func (*RepoStatus)GetCreatedAt¶
func (r *RepoStatus) GetCreatedAt()time.Time
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*RepoStatus)GetCreator¶
func (r *RepoStatus) GetCreator() *User
GetCreator returns the Creator field.
func (*RepoStatus)GetDescription¶
func (r *RepoStatus) GetDescription()string
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (*RepoStatus)GetID¶
func (r *RepoStatus) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*RepoStatus)GetNodeID¶
func (r *RepoStatus) GetNodeID()string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (*RepoStatus)GetState¶
func (r *RepoStatus) GetState()string
GetState returns the State field if it's non-nil, zero value otherwise.
func (*RepoStatus)GetTargetURL¶
func (r *RepoStatus) GetTargetURL()string
GetTargetURL returns the TargetURL field if it's non-nil, zero value otherwise.
func (*RepoStatus)GetURL¶
func (r *RepoStatus) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (*RepoStatus)GetUpdatedAt¶
func (r *RepoStatus) GetUpdatedAt()time.Time
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (RepoStatus)String¶
func (rRepoStatus) String()string
typeRepositoriesSearchResult¶
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 (*RepositoriesSearchResult)GetIncompleteResults¶
func (r *RepositoriesSearchResult) GetIncompleteResults()bool
GetIncompleteResults returns the IncompleteResults field if it's non-nil, zero value otherwise.
func (*RepositoriesSearchResult)GetTotal¶
func (r *RepositoriesSearchResult) GetTotal()int
GetTotal returns the Total field if it's non-nil, zero value otherwise.
typeRepositoriesService¶
type RepositoriesService service
RepositoriesService handles communication with the repository relatedmethods of the GitHub API.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/
func (*RepositoriesService)AddAdminEnforcement¶
func (s *RepositoriesService) AddAdminEnforcement(ctxcontext.Context, owner, repo, branchstring) (*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://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#set-admin-branch-protection
func (*RepositoriesService)AddAppRestrictions¶
func (s *RepositoriesService) AddAppRestrictions(ctxcontext.Context, owner, repo, branchstring, slug []string) ([]*App, *Response,error)
AddAppRestrictions grants the specified apps push access to a given protected branch.It requires the GitHub apps to have `write` access to the `content` permission.
Note: The list of users, apps, and teams in total is limited to 100 items.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#add-app-access-restrictions
func (*RepositoriesService)AddAutolink¶
func (s *RepositoriesService) AddAutolink(ctxcontext.Context, owner, repostring, opts *AutolinkOptions) (*Autolink, *Response,error)
AddAutolink creates an autolink reference for a repository.Users with admin access to the repository can create an autolink.
GitHub API docs:https://docs.github.com/en/rest/reference/repos#create-an-autolink-reference-for-a-repository
func (*RepositoriesService)AddCollaborator¶
func (s *RepositoriesService) AddCollaborator(ctxcontext.Context, owner, repo, userstring, opts *RepositoryAddCollaboratorOptions) (*CollaboratorInvitation, *Response,error)
AddCollaborator sends an invitation to the specified GitHub userto become a collaborator to the given repo.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#add-a-repository-collaborator
func (*RepositoriesService)CompareCommits¶
func (s *RepositoriesService) CompareCommits(ctxcontext.Context, owner, repostring, base, headstring, opts *ListOptions) (*CommitsComparison, *Response,error)
CompareCommits compares a range of commits with each other.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#compare-two-commits
func (*RepositoriesService)CompareCommitsRaw¶
func (s *RepositoriesService) CompareCommitsRaw(ctxcontext.Context, owner, repo, base, headstring, optsRawOptions) (string, *Response,error)
CompareCommitsRaw compares a range of commits with each other in raw (diff or patch) format.
Both "base" and "head" must be branch names in "repo".To compare branches across other repositories in the same network as "repo",use the format "<USERNAME>:branch".
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#compare-two-commits
func (*RepositoriesService)Create¶
func (s *RepositoriesService) Create(ctxcontext.Context, orgstring, repo *Repository) (*Repository, *Response,error)
Create a new repository. If an organization is specified, the newrepository will be created under that org. If the empty string isspecified, it will be created for the authenticated user.
Note that only a subset of the repo fields are used and repo mustnot be nil.
Also note that this method will return the response without actuallywaiting for GitHub to finish creating the repository and letting thechanges propagate throughout its servers. You may set up a loop withexponential back-off to verify repository's creation.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#create-a-repository-for-the-authenticated-userGitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#create-an-organization-repository
func (*RepositoriesService)CreateComment¶
func (s *RepositoriesService) CreateComment(ctxcontext.Context, owner, repo, shastring, 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://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#create-a-commit-comment
func (*RepositoriesService)CreateDeployment¶
func (s *RepositoriesService) CreateDeployment(ctxcontext.Context, owner, repostring, request *DeploymentRequest) (*Deployment, *Response,error)
CreateDeployment creates a new deployment for a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#create-a-deployment
func (*RepositoriesService)CreateDeploymentStatus¶
func (s *RepositoriesService) CreateDeploymentStatus(ctxcontext.Context, owner, repostring, deploymentint64, request *DeploymentStatusRequest) (*DeploymentStatus, *Response,error)
CreateDeploymentStatus creates a new status for a deployment.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#create-a-deployment-status
func (*RepositoriesService)CreateFile¶
func (s *RepositoriesService) CreateFile(ctxcontext.Context, owner, repo, pathstring, opts *RepositoryContentFileOptions) (*RepositoryContentResponse, *Response,error)
CreateFile creates a new file in a repository at the given path and returnsthe commit and file metadata.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#create-or-update-file-contents
Example¶
package mainimport ("context""fmt""github.com/google/go-github/v43/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-Authenticationclient := 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 (*RepositoriesService)CreateFork¶
func (s *RepositoriesService) CreateFork(ctxcontext.Context, owner, repostring, opts *RepositoryCreateForkOptions) (*Repository, *Response,error)
CreateFork creates a fork of the specified repository.
This method might return an *AcceptedError and a status code of202. This is because this is the status that GitHub returns to signify thatit 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 resultin a successful request.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#create-a-fork
func (*RepositoriesService)CreateFromTemplate¶
func (s *RepositoriesService) CreateFromTemplate(ctxcontext.Context, templateOwner, templateRepostring, templateRepoReq *TemplateRepoRequest) (*Repository, *Response,error)
CreateFromTemplate generates a repository from a template.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#create-a-repository-using-a-template
func (*RepositoriesService)CreateHook¶
func (s *RepositoriesService) CreateHook(ctxcontext.Context, owner, repostring, hook *Hook) (*Hook, *Response,error)
CreateHook creates a Hook for the specified repository.Config is a required field.
Note that only a subset of the hook fields are used and hook mustnot be nil.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#create-a-repository-webhook
func (*RepositoriesService)CreateKey¶
func (s *RepositoriesService) CreateKey(ctxcontext.Context, ownerstring, repostring, key *Key) (*Key, *Response,error)
CreateKey adds a deploy key for a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#create-a-deploy-key
func (*RepositoriesService)CreateProject¶
func (s *RepositoriesService) CreateProject(ctxcontext.Context, owner, repostring, opts *ProjectOptions) (*Project, *Response,error)
CreateProject creates a GitHub Project for the specified repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/projects/#create-a-repository-project
func (*RepositoriesService)CreateRelease¶
func (s *RepositoriesService) CreateRelease(ctxcontext.Context, owner, repostring, release *RepositoryRelease) (*RepositoryRelease, *Response,error)
CreateRelease adds a new release for a repository.
Note that only a subset of the release fields are used.See RepositoryRelease for more information.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#create-a-release
func (*RepositoriesService)CreateStatus¶
func (s *RepositoriesService) CreateStatus(ctxcontext.Context, owner, repo, refstring, status *RepoStatus) (*RepoStatus, *Response,error)
CreateStatus creates a new status for a repository at the specifiedreference. Ref can be a SHA, a branch name, or a tag name.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#create-a-commit-status
func (*RepositoriesService)CreateUpdateEnvironment¶
func (s *RepositoriesService) CreateUpdateEnvironment(ctxcontext.Context, owner, repo, namestring, environment *CreateUpdateEnvironment) (*Environment, *Response,error)
CreateUpdateEnvironment create or update a new environment for a repository.
GitHub API docs:https://docs.github.com/en/rest/reference/repos#create-or-update-an-environment
func (*RepositoriesService)Delete¶
Delete a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#delete-a-repository
func (*RepositoriesService)DeleteAutolink¶
func (s *RepositoriesService) DeleteAutolink(ctxcontext.Context, owner, repostring, idint64) (*Response,error)
DeleteAutolink deletes a single autolink reference by ID that was configured for the given repository.Information about autolinks are only available to repository administrators.
GitHub API docs:https://docs.github.com/en/rest/reference/repos#delete-an-autolink-reference-from-a-repository
func (*RepositoriesService)DeleteComment¶
func (s *RepositoriesService) DeleteComment(ctxcontext.Context, owner, repostring, idint64) (*Response,error)
DeleteComment deletes a single comment from a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#delete-a-commit-comment
func (*RepositoriesService)DeleteDeployment¶
func (s *RepositoriesService) DeleteDeployment(ctxcontext.Context, owner, repostring, deploymentIDint64) (*Response,error)
DeleteDeployment deletes an existing deployment for a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#delete-a-deployment
func (*RepositoriesService)DeleteEnvironment¶
func (s *RepositoriesService) DeleteEnvironment(ctxcontext.Context, owner, repo, namestring) (*Response,error)
DeleteEnvironment delete an environment from a repository.
GitHub API docs:https://docs.github.com/en/rest/reference/repos#delete-an-environment
func (*RepositoriesService)DeleteFile¶
func (s *RepositoriesService) DeleteFile(ctxcontext.Context, owner, repo, pathstring, opts *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://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#delete-a-file
func (*RepositoriesService)DeleteHook¶
func (s *RepositoriesService) DeleteHook(ctxcontext.Context, owner, repostring, idint64) (*Response,error)
DeleteHook deletes a specified Hook.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#delete-a-repository-webhook
func (*RepositoriesService)DeleteInvitation¶
func (s *RepositoriesService) DeleteInvitation(ctxcontext.Context, owner, repostring, invitationIDint64) (*Response,error)
DeleteInvitation deletes a repository invitation.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#delete-a-repository-invitation
func (*RepositoriesService)DeleteKey¶
func (s *RepositoriesService) DeleteKey(ctxcontext.Context, ownerstring, repostring, idint64) (*Response,error)
DeleteKey deletes a deploy key.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#delete-a-deploy-key
func (*RepositoriesService)DeletePreReceiveHook¶
func (s *RepositoriesService) DeletePreReceiveHook(ctxcontext.Context, owner, repostring, idint64) (*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 (*RepositoriesService)DeleteRelease¶
func (s *RepositoriesService) DeleteRelease(ctxcontext.Context, owner, repostring, idint64) (*Response,error)
DeleteRelease delete a single release from a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#delete-a-release
func (*RepositoriesService)DeleteReleaseAsset¶
func (s *RepositoriesService) DeleteReleaseAsset(ctxcontext.Context, owner, repostring, idint64) (*Response,error)
DeleteReleaseAsset delete a single release asset from a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#delete-a-release-asset
func (*RepositoriesService)DisableAutomatedSecurityFixes¶
func (s *RepositoriesService) DisableAutomatedSecurityFixes(ctxcontext.Context, owner, repositorystring) (*Response,error)
DisableAutomatedSecurityFixes disables vulnerability alerts and the dependency graph for a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#disable-automated-security-fixes
func (*RepositoriesService)DisableDismissalRestrictions¶
func (s *RepositoriesService) DisableDismissalRestrictions(ctxcontext.Context, owner, repo, branchstring) (*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://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#update-pull-request-review-protection
func (*RepositoriesService)DisablePages¶
DisablePages disables GitHub Pages for the named repo.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#delete-a-github-pages-site
func (*RepositoriesService)DisableVulnerabilityAlerts¶
func (s *RepositoriesService) DisableVulnerabilityAlerts(ctxcontext.Context, owner, repositorystring) (*Response,error)
DisableVulnerabilityAlerts disables vulnerability alerts and the dependency graph for a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#disable-vulnerability-alerts
func (*RepositoriesService)Dispatch¶
func (s *RepositoriesService) Dispatch(ctxcontext.Context, owner, repostring, optsDispatchRequestOptions) (*Repository, *Response,error)
Dispatch triggers a repository_dispatch event in a GitHub Actions workflow.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#create-a-repository-dispatch-event
func (*RepositoriesService)DownloadContents¶
func (s *RepositoriesService) DownloadContents(ctxcontext.Context, owner, repo, filepathstring, opts *RepositoryContentGetOptions) (io.ReadCloser, *Response,error)
DownloadContents returns an io.ReadCloser that reads the contents of thespecified file. This function will work with files of any size, as opposedto GetContents which is limited to 1 Mb files. It is the caller'sresponsibility to close the ReadCloser.
It is possible for the download to result in a failed response when thereturned error is nil. Callers should check the returned Response statuscode to verify the content is from a successful response.
func (*RepositoriesService)DownloadContentsWithMeta¶
func (s *RepositoriesService) DownloadContentsWithMeta(ctxcontext.Context, owner, repo, filepathstring, opts *RepositoryContentGetOptions) (io.ReadCloser, *RepositoryContent, *Response,error)
DownloadContentsWithMeta is identical to DownloadContents but additionallyreturns the RepositoryContent of the requested file. This additional datais useful for future operations involving the requested file. For merelyreading the content of a file, DownloadContents is perfectly adequate.
It is possible for the download to result in a failed response when thereturned error is nil. Callers should check the returned Response statuscode to verify the content is from a successful response.
func (*RepositoriesService)DownloadReleaseAsset¶
func (s *RepositoriesService) DownloadReleaseAsset(ctxcontext.Context, owner, repostring, idint64, followRedirectsClient *http.Client) (rcio.ReadCloser, redirectURLstring, errerror)
DownloadReleaseAsset downloads a release asset or returns a redirect URL.
DownloadReleaseAsset returns an io.ReadCloser that reads the contents of thespecified 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 insteadof the io.ReadCloser. Exactly one of rc and redirectURL will be zero.
followRedirectsClient can be passed to download the asset from a redirectedlocation. Passing http.DefaultClient is recommended unless special circumstancesexist, but it's possible to pass any http.Client. If nil is passed theredirectURL will be returned instead.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-a-release-asset
func (*RepositoriesService)Edit¶
func (s *RepositoriesService) Edit(ctxcontext.Context, owner, repostring, repository *Repository) (*Repository, *Response,error)
Edit updates a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#update-a-repository
func (*RepositoriesService)EditHook¶
func (s *RepositoriesService) EditHook(ctxcontext.Context, owner, repostring, idint64, hook *Hook) (*Hook, *Response,error)
EditHook updates a specified Hook.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#update-a-repository-webhook
func (*RepositoriesService)EditRelease¶
func (s *RepositoriesService) EditRelease(ctxcontext.Context, owner, repostring, idint64, release *RepositoryRelease) (*RepositoryRelease, *Response,error)
EditRelease edits a repository release.
Note that only a subset of the release fields are used.See RepositoryRelease for more information.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#update-a-release
func (*RepositoriesService)EditReleaseAsset¶
func (s *RepositoriesService) EditReleaseAsset(ctxcontext.Context, owner, repostring, idint64, release *ReleaseAsset) (*ReleaseAsset, *Response,error)
EditReleaseAsset edits a repository release asset.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#update-a-release-asset
func (*RepositoriesService)EnableAutomatedSecurityFixes¶
func (s *RepositoriesService) EnableAutomatedSecurityFixes(ctxcontext.Context, owner, repositorystring) (*Response,error)
EnableAutomatedSecurityFixes enables the automated security fixes for a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#enable-automated-security-fixes
func (*RepositoriesService)EnablePages¶
func (s *RepositoriesService) EnablePages(ctxcontext.Context, owner, repostring, pages *Pages) (*Pages, *Response,error)
EnablePages enables GitHub Pages for the named repo.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#create-a-github-pages-site
func (*RepositoriesService)EnableVulnerabilityAlerts¶
func (s *RepositoriesService) EnableVulnerabilityAlerts(ctxcontext.Context, owner, repositorystring) (*Response,error)
EnableVulnerabilityAlerts enables vulnerability alerts and the dependency graph for a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#enable-vulnerability-alerts
func (*RepositoriesService)GenerateReleaseNotes¶
func (s *RepositoriesService) GenerateReleaseNotes(ctxcontext.Context, owner, repostring, opts *GenerateNotesOptions) (*RepositoryReleaseNotes, *Response,error)
GenerateReleaseNotes generates the release notes for the given tag.TODO: api docsGitHub API docs:
func (*RepositoriesService)Get¶
func (s *RepositoriesService) Get(ctxcontext.Context, owner, repostring) (*Repository, *Response,error)
Get fetches a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-a-repository
func (*RepositoriesService)GetAdminEnforcement¶
func (s *RepositoriesService) GetAdminEnforcement(ctxcontext.Context, owner, repo, branchstring) (*AdminEnforcement, *Response,error)
GetAdminEnforcement gets admin enforcement information of a protected branch.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-admin-branch-protection
func (*RepositoriesService)GetArchiveLink¶
func (s *RepositoriesService) GetArchiveLink(ctxcontext.Context, owner, repostring, archiveformatArchiveFormat, opts *RepositoryContentGetOptions, followRedirectsbool) (*url.URL, *Response,error)
GetArchiveLink returns an URL to download a tarball or zipball archive for arepository. The archiveFormat can be specified by either the github.Tarballor github.Zipball constant.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/contents/#get-archive-link
func (*RepositoriesService)GetAutolink¶
func (s *RepositoriesService) GetAutolink(ctxcontext.Context, owner, repostring, idint64) (*Autolink, *Response,error)
GetAutolink returns a single autolink reference by ID that was configured for the given repository.Information about autolinks are only available to repository administrators.
GitHub API docs:https://docs.github.com/en/rest/reference/repos#get-an-autolink-reference-of-a-repository
func (*RepositoriesService)GetBranch¶
func (s *RepositoriesService) GetBranch(ctxcontext.Context, owner, repo, branchstring, followRedirectsbool) (*Branch, *Response,error)
GetBranch gets the specified branch for a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-a-branch
func (*RepositoriesService)GetBranchProtection¶
func (s *RepositoriesService) GetBranchProtection(ctxcontext.Context, owner, repo, branchstring) (*Protection, *Response,error)
GetBranchProtection gets the protection of a given branch.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-branch-protection
func (*RepositoriesService)GetByID¶
func (s *RepositoriesService) GetByID(ctxcontext.Context, idint64) (*Repository, *Response,error)
GetByID fetches a repository.
Note: GetByID uses the undocumented GitHub API endpoint /repositories/:id.
func (*RepositoriesService)GetCodeOfConduct¶
func (s *RepositoriesService) GetCodeOfConduct(ctxcontext.Context, owner, repostring) (*CodeOfConduct, *Response,error)
GetCodeOfConduct gets the contents of a repository's code of conduct.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/codes-of-conduct/#get-the-code-of-conduct-for-a-repository
func (*RepositoriesService)GetCombinedStatus¶
func (s *RepositoriesService) GetCombinedStatus(ctxcontext.Context, owner, repo, refstring, opts *ListOptions) (*CombinedStatus, *Response,error)
GetCombinedStatus returns the combined status of a repository at the specifiedreference. ref can be a SHA, a branch name, or a tag name.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-the-combined-status-for-a-specific-reference
func (*RepositoriesService)GetComment¶
func (s *RepositoriesService) GetComment(ctxcontext.Context, owner, repostring, idint64) (*RepositoryComment, *Response,error)
GetComment gets a single comment from a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-a-commit-comment
func (*RepositoriesService)GetCommit¶
func (s *RepositoriesService) GetCommit(ctxcontext.Context, owner, repo, shastring, opts *ListOptions) (*RepositoryCommit, *Response,error)
GetCommit fetches the specified commit, including all details about it.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-a-single-commitGitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-a-commit
func (*RepositoriesService)GetCommitRaw¶
func (s *RepositoriesService) GetCommitRaw(ctxcontext.Context, ownerstring, repostring, shastring, optsRawOptions) (string, *Response,error)
GetCommitRaw fetches the specified commit in raw (diff or patch) format.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-a-commit
func (*RepositoriesService)GetCommitSHA1¶
func (s *RepositoriesService) GetCommitSHA1(ctxcontext.Context, owner, repo, ref, lastSHAstring) (string, *Response,error)
GetCommitSHA1 gets the SHA-1 of a commit reference. If a last-known SHA1 issupplied and no new commits have occurred, a 304 Unmodified response is returned.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-a-commit
func (*RepositoriesService)GetCommunityHealthMetrics¶
func (s *RepositoriesService) GetCommunityHealthMetrics(ctxcontext.Context, owner, repostring) (*CommunityHealthMetrics, *Response,error)
GetCommunityHealthMetrics retrieves all the community health metrics for a repository.
GitHub API docs:https://docs.github.com/en/rest/reference/repos#get-community-profile-metrics
func (*RepositoriesService)GetContents¶
func (s *RepositoriesService) GetContents(ctxcontext.Context, owner, repo, pathstring, opts *RepositoryContentGetOptions) (fileContent *RepositoryContent, directoryContent []*RepositoryContent, resp *Response, errerror)
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/orsubdirectories of a directory (when path references a directory). To make iteasy to distinguish between both result types and to mimic the API as muchas possible, both result types will be returned but only one will contain avalue and the other will be nil.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-repository-content
func (*RepositoriesService)GetDeployment¶
func (s *RepositoriesService) GetDeployment(ctxcontext.Context, owner, repostring, deploymentIDint64) (*Deployment, *Response,error)
GetDeployment returns a single deployment of a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-a-deployment
func (*RepositoriesService)GetDeploymentStatus¶
func (s *RepositoriesService) GetDeploymentStatus(ctxcontext.Context, owner, repostring, deploymentID, deploymentStatusIDint64) (*DeploymentStatus, *Response,error)
GetDeploymentStatus returns a single deployment status of a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-a-deployment-status
func (*RepositoriesService)GetEnvironment¶
func (s *RepositoriesService) GetEnvironment(ctxcontext.Context, owner, repo, namestring) (*Environment, *Response,error)
GetEnvironment get a single environment for a repository.
GitHub API docs:https://docs.github.com/en/rest/reference/repos#get-an-environment
func (*RepositoriesService)GetHook¶
func (s *RepositoriesService) GetHook(ctxcontext.Context, owner, repostring, idint64) (*Hook, *Response,error)
GetHook returns a single specified Hook.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-a-repository-webhook
func (*RepositoriesService)GetHookDelivery¶
func (s *RepositoriesService) GetHookDelivery(ctxcontext.Context, owner, repostring, hookID, deliveryIDint64) (*HookDelivery, *Response,error)
GetHookDelivery returns a delivery for a webhook configured in a repository.
GitHub API docs:https://docs.github.com/en/rest/reference/repos#get-a-delivery-for-a-repository-webhook
func (*RepositoriesService)GetKey¶
func (s *RepositoriesService) GetKey(ctxcontext.Context, ownerstring, repostring, idint64) (*Key, *Response,error)
GetKey fetches a single deploy key.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-a-deploy-key
func (*RepositoriesService)GetLatestPagesBuild¶
func (s *RepositoriesService) GetLatestPagesBuild(ctxcontext.Context, owner, repostring) (*PagesBuild, *Response,error)
GetLatestPagesBuild fetches the latest build information for a GitHub pages site.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-latest-pages-build
func (*RepositoriesService)GetLatestRelease¶
func (s *RepositoriesService) GetLatestRelease(ctxcontext.Context, owner, repostring) (*RepositoryRelease, *Response,error)
GetLatestRelease fetches the latest published release for the repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-the-latest-release
func (*RepositoriesService)GetPageBuild¶
func (s *RepositoriesService) GetPageBuild(ctxcontext.Context, owner, repostring, idint64) (*PagesBuild, *Response,error)
GetPageBuild fetches the specific build information for a GitHub pages site.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-github-pages-build
func (*RepositoriesService)GetPagesInfo¶
func (s *RepositoriesService) GetPagesInfo(ctxcontext.Context, owner, repostring) (*Pages, *Response,error)
GetPagesInfo fetches information about a GitHub Pages site.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-a-github-pages-site
func (*RepositoriesService)GetPermissionLevel¶
func (s *RepositoriesService) GetPermissionLevel(ctxcontext.Context, owner, repo, userstring) (*RepositoryPermissionLevel, *Response,error)
GetPermissionLevel retrieves the specific permission level a collaborator has for a given repository.GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-repository-permissions-for-a-user
func (*RepositoriesService)GetPreReceiveHook¶
func (s *RepositoriesService) GetPreReceiveHook(ctxcontext.Context, owner, repostring, idint64) (*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 (*RepositoriesService)GetPullRequestReviewEnforcement¶
func (s *RepositoriesService) GetPullRequestReviewEnforcement(ctxcontext.Context, owner, repo, branchstring) (*PullRequestReviewsEnforcement, *Response,error)
GetPullRequestReviewEnforcement gets pull request review enforcement of a protected branch.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-pull-request-review-protection
func (*RepositoriesService)GetReadme¶
func (s *RepositoriesService) GetReadme(ctxcontext.Context, owner, repostring, opts *RepositoryContentGetOptions) (*RepositoryContent, *Response,error)
GetReadme gets the Readme file for the repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-a-repository-readme
Example¶
package mainimport ("context""fmt""github.com/google/go-github/v43/github")func main() {client := github.NewClient(nil)ctx := context.Background()readme, _, err := client.Repositories.GetReadme(ctx, "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 (*RepositoriesService)GetRelease¶
func (s *RepositoriesService) GetRelease(ctxcontext.Context, owner, repostring, idint64) (*RepositoryRelease, *Response,error)
GetRelease fetches a single release.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-a-release
func (*RepositoriesService)GetReleaseAsset¶
func (s *RepositoriesService) GetReleaseAsset(ctxcontext.Context, owner, repostring, idint64) (*ReleaseAsset, *Response,error)
GetReleaseAsset fetches a single release asset.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-a-release-asset
func (*RepositoriesService)GetReleaseByTag¶
func (s *RepositoriesService) GetReleaseByTag(ctxcontext.Context, owner, repo, tagstring) (*RepositoryRelease, *Response,error)
GetReleaseByTag fetches a release with the specified tag.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-a-release-by-tag-name
func (*RepositoriesService)GetRequiredStatusChecks¶
func (s *RepositoriesService) GetRequiredStatusChecks(ctxcontext.Context, owner, repo, branchstring) (*RequiredStatusChecks, *Response,error)
GetRequiredStatusChecks gets the required status checks for a given protected branch.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-status-checks-protection
func (*RepositoriesService)GetSignaturesProtectedBranch¶
func (s *RepositoriesService) GetSignaturesProtectedBranch(ctxcontext.Context, owner, repo, branchstring) (*SignaturesProtectedBranch, *Response,error)
GetSignaturesProtectedBranch gets required signatures of protected branch.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-commit-signature-protection
func (*RepositoriesService)GetVulnerabilityAlerts¶
func (s *RepositoriesService) GetVulnerabilityAlerts(ctxcontext.Context, owner, repositorystring) (bool, *Response,error)
GetVulnerabilityAlerts checks if vulnerability alerts are enabled for a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#check-if-vulnerability-alerts-are-enabled-for-a-repository
func (*RepositoriesService)IsCollaborator¶
func (s *RepositoriesService) IsCollaborator(ctxcontext.Context, owner, repo, userstring) (bool, *Response,error)
IsCollaborator checks whether the specified GitHub user has collaboratoraccess to the given repo.Note: This will return false if the user is not a collaborator OR the useris not a GitHub user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#check-if-a-user-is-a-repository-collaborator
func (*RepositoriesService)License¶
func (s *RepositoriesService) License(ctxcontext.Context, owner, repostring) (*RepositoryLicense, *Response,error)
License gets the contents of a repository's license if one is detected.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/licenses/#get-the-license-for-a-repository
func (*RepositoriesService)List¶
func (s *RepositoriesService) List(ctxcontext.Context, userstring, opts *RepositoryListOptions) ([]*Repository, *Response,error)
List the repositories for a user. Passing the empty string will listrepositories for the authenticated user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#list-repositories-for-the-authenticated-userGitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#list-repositories-for-a-user
Example¶
package mainimport ("context""fmt""github.com/google/go-github/v43/github")func main() {client := github.NewClient(nil)user := "willnorris"opt := &github.RepositoryListOptions{Type: "owner", Sort: "updated", Direction: "desc"}ctx := context.Background()repos, _, err := client.Repositories.List(ctx, user, opt)if err != nil {fmt.Println(err)}fmt.Printf("Recently updated repositories by %q: %v", user, github.Stringify(repos))}
func (*RepositoriesService)ListAll¶
func (s *RepositoriesService) ListAll(ctxcontext.Context, opts *RepositoryListAllOptions) ([]*Repository, *Response,error)
ListAll lists all GitHub repositories in the order that they were created.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#list-public-repositories
func (*RepositoriesService)ListAllTopics¶
func (s *RepositoriesService) ListAllTopics(ctxcontext.Context, owner, repostring) ([]string, *Response,error)
ListAllTopics lists topics for a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-all-repository-topics
func (*RepositoriesService)ListApps¶
func (s *RepositoriesService) ListApps(ctxcontext.Context, owner, repo, branchstring) ([]*App, *Response,error)
ListApps lists the GitHub apps that have push access to a given protected branch.It requires the GitHub apps to have `write` access to the `content` permission.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-apps-with-access-to-the-protected-branch
func (*RepositoriesService)ListAutolinks¶
func (s *RepositoriesService) ListAutolinks(ctxcontext.Context, owner, repostring, opts *ListOptions) ([]*Autolink, *Response,error)
ListAutolinks returns a list of autolinks configured for the given repository.Information about autolinks are only available to repository administrators.
GitHub API docs:https://docs.github.com/en/rest/reference/repos#list-all-autolinks-of-a-repository
func (*RepositoriesService)ListBranches¶
func (s *RepositoriesService) ListBranches(ctxcontext.Context, ownerstring, repostring, opts *BranchListOptions) ([]*Branch, *Response,error)
ListBranches lists branches for the specified repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#list-branches
func (*RepositoriesService)ListBranchesHeadCommit¶
func (s *RepositoriesService) ListBranchesHeadCommit(ctxcontext.Context, owner, repo, shastring) ([]*BranchCommit, *Response,error)
ListBranchesHeadCommit gets all branches where the given commit SHA is the HEAD,or latest commit for the branch.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#list-branches-for-head-commit
func (*RepositoriesService)ListByOrg¶
func (s *RepositoriesService) ListByOrg(ctxcontext.Context, orgstring, opts *RepositoryListByOrgOptions) ([]*Repository, *Response,error)
ListByOrg lists the repositories for an organization.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#list-organization-repositories
func (*RepositoriesService)ListCodeFrequency¶
func (s *RepositoriesService) ListCodeFrequency(ctxcontext.Context, owner, repostring) ([]*WeeklyStats, *Response,error)
ListCodeFrequency returns a weekly aggregate of the number of additions anddeletions pushed to a repository. Returned WeeklyStats will containadditions and deletions, but not total commits.
If this is the first time these statistics are requested for the givenrepository, this method will return an *AcceptedError and a status code of202. This is because this is the status that GitHub returns to signify thatit is now computing the requested statistics. A follow up request, after adelay of a second or so, should result in a successful request.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-the-weekly-commit-activity
func (*RepositoriesService)ListCollaborators¶
func (s *RepositoriesService) ListCollaborators(ctxcontext.Context, owner, repostring, opts *ListCollaboratorsOptions) ([]*User, *Response,error)
ListCollaborators lists the GitHub users that have access to the repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#list-repository-collaborators
func (*RepositoriesService)ListComments¶
func (s *RepositoriesService) ListComments(ctxcontext.Context, owner, repostring, opts *ListOptions) ([]*RepositoryComment, *Response,error)
ListComments lists all the comments for the repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#list-commit-comments-for-a-repository
func (*RepositoriesService)ListCommitActivity¶
func (s *RepositoriesService) ListCommitActivity(ctxcontext.Context, owner, repostring) ([]*WeeklyCommitActivity, *Response,error)
ListCommitActivity returns the last year of commit activitygrouped 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 givenrepository, this method will return an *AcceptedError and a status code of202. This is because this is the status that GitHub returns to signify thatit is now computing the requested statistics. A follow up request, after adelay of a second or so, should result in a successful request.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-the-last-year-of-commit-activity
func (*RepositoriesService)ListCommitComments¶
func (s *RepositoriesService) ListCommitComments(ctxcontext.Context, owner, repo, shastring, opts *ListOptions) ([]*RepositoryComment, *Response,error)
ListCommitComments lists all the comments for a given commit SHA.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#list-commit-comments
func (*RepositoriesService)ListCommits¶
func (s *RepositoriesService) ListCommits(ctxcontext.Context, owner, repostring, opts *CommitsListOptions) ([]*RepositoryCommit, *Response,error)
ListCommits lists the commits of a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#list-commits
func (*RepositoriesService)ListContributors¶
func (s *RepositoriesService) ListContributors(ctxcontext.Context, ownerstring, repositorystring, opts *ListContributorsOptions) ([]*Contributor, *Response,error)
ListContributors lists contributors for a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#list-repository-contributors
func (*RepositoriesService)ListContributorsStats¶
func (s *RepositoriesService) ListContributorsStats(ctxcontext.Context, owner, repostring) ([]*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 givenrepository, this method will return an *AcceptedError and a status code of202. This is because this is the status that GitHub returns to signify thatit is now computing the requested statistics. A follow up request, after adelay of a second or so, should result in a successful request.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-all-contributor-commit-activity
func (*RepositoriesService)ListDeploymentStatuses¶
func (s *RepositoriesService) ListDeploymentStatuses(ctxcontext.Context, owner, repostring, deploymentint64, opts *ListOptions) ([]*DeploymentStatus, *Response,error)
ListDeploymentStatuses lists the statuses of a given deployment of a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#list-deployment-statuses
func (*RepositoriesService)ListDeployments¶
func (s *RepositoriesService) ListDeployments(ctxcontext.Context, owner, repostring, opts *DeploymentsListOptions) ([]*Deployment, *Response,error)
ListDeployments lists the deployments of a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#list-deployments
func (*RepositoriesService)ListEnvironments¶
func (s *RepositoriesService) ListEnvironments(ctxcontext.Context, owner, repostring, opts *EnvironmentListOptions) (*EnvResponse, *Response,error)
ListEnvironments lists all environments for a repository.
GitHub API docs:https://docs.github.com/en/rest/reference/repos#get-all-environments
func (*RepositoriesService)ListForks¶
func (s *RepositoriesService) ListForks(ctxcontext.Context, owner, repostring, opts *RepositoryListForksOptions) ([]*Repository, *Response,error)
ListForks lists the forks of the specified repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#list-forks
func (*RepositoriesService)ListHookDeliveries¶
func (s *RepositoriesService) ListHookDeliveries(ctxcontext.Context, owner, repostring, idint64, opts *ListCursorOptions) ([]*HookDelivery, *Response,error)
ListHookDeliveries lists webhook deliveries for a webhook configured in a repository.
GitHub API docs:https://docs.github.com/en/rest/reference/repos#list-deliveries-for-a-repository-webhook
func (*RepositoriesService)ListHooks¶
func (s *RepositoriesService) ListHooks(ctxcontext.Context, owner, repostring, opts *ListOptions) ([]*Hook, *Response,error)
ListHooks lists all Hooks for the specified repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#list-repository-webhooks
func (*RepositoriesService)ListInvitations¶
func (s *RepositoriesService) ListInvitations(ctxcontext.Context, owner, repostring, opts *ListOptions) ([]*RepositoryInvitation, *Response,error)
ListInvitations lists all currently-open repository invitations.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#list-repository-invitations
func (*RepositoriesService)ListKeys¶
func (s *RepositoriesService) ListKeys(ctxcontext.Context, ownerstring, repostring, opts *ListOptions) ([]*Key, *Response,error)
ListKeys lists the deploy keys for a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#list-deploy-keys
func (*RepositoriesService)ListLanguages¶
func (s *RepositoriesService) ListLanguages(ctxcontext.Context, ownerstring, repostring) (map[string]int, *Response,error)
ListLanguages lists languages for the specified repository. The returned mapspecifies the languages and the number of bytes of code written in thatlanguage. For example:
{ "C": 78769, "Python": 7769}
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#list-repository-languages
func (*RepositoriesService)ListPagesBuilds¶
func (s *RepositoriesService) ListPagesBuilds(ctxcontext.Context, owner, repostring, opts *ListOptions) ([]*PagesBuild, *Response,error)
ListPagesBuilds lists the builds for a GitHub Pages site.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#list-github-pages-builds
func (*RepositoriesService)ListParticipation¶
func (s *RepositoriesService) ListParticipation(ctxcontext.Context, owner, repostring) (*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 getthe 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 givenrepository, this method will return an *AcceptedError and a status code of202. This is because this is the status that GitHub returns to signify thatit is now computing the requested statistics. A follow up request, after adelay of a second or so, should result in a successful request.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-the-weekly-commit-count
func (*RepositoriesService)ListPreReceiveHooks¶
func (s *RepositoriesService) ListPreReceiveHooks(ctxcontext.Context, owner, repostring, opts *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 (*RepositoriesService)ListProjects¶
func (s *RepositoriesService) ListProjects(ctxcontext.Context, owner, repostring, opts *ProjectListOptions) ([]*Project, *Response,error)
ListProjects lists the projects for a repo.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/projects/#list-repository-projects
func (*RepositoriesService)ListPunchCard¶
func (s *RepositoriesService) ListPunchCard(ctxcontext.Context, owner, repostring) ([]*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 givenrepository, this method will return an *AcceptedError and a status code of202. This is because this is the status that GitHub returns to signify thatit is now computing the requested statistics. A follow up request, after adelay of a second or so, should result in a successful request.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-the-hourly-commit-count-for-each-day
func (*RepositoriesService)ListReleaseAssets¶
func (s *RepositoriesService) ListReleaseAssets(ctxcontext.Context, owner, repostring, idint64, opts *ListOptions) ([]*ReleaseAsset, *Response,error)
ListReleaseAssets lists the release's assets.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#list-release-assets
func (*RepositoriesService)ListReleases¶
func (s *RepositoriesService) ListReleases(ctxcontext.Context, owner, repostring, opts *ListOptions) ([]*RepositoryRelease, *Response,error)
ListReleases lists the releases for a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#list-releases
func (*RepositoriesService)ListRequiredStatusChecksContexts¶
func (s *RepositoriesService) ListRequiredStatusChecksContexts(ctxcontext.Context, owner, repo, branchstring) (contexts []string, resp *Response, errerror)
ListRequiredStatusChecksContexts lists the required status checks contexts for a given protected branch.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-all-status-check-contexts
func (*RepositoriesService)ListStatuses¶
func (s *RepositoriesService) ListStatuses(ctxcontext.Context, owner, repo, refstring, opts *ListOptions) ([]*RepoStatus, *Response,error)
ListStatuses lists the statuses of a repository at the specifiedreference. ref can be a SHA, a branch name, or a tag name.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#list-commit-statuses-for-a-reference
func (*RepositoriesService)ListTags¶
func (s *RepositoriesService) ListTags(ctxcontext.Context, ownerstring, repostring, opts *ListOptions) ([]*RepositoryTag, *Response,error)
ListTags lists tags for the specified repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#list-repository-tags
func (*RepositoriesService)ListTeams¶
func (s *RepositoriesService) ListTeams(ctxcontext.Context, ownerstring, repostring, opts *ListOptions) ([]*Team, *Response,error)
ListTeams lists the teams for the specified repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#list-repository-teams
func (*RepositoriesService)ListTrafficClones¶
func (s *RepositoriesService) ListTrafficClones(ctxcontext.Context, owner, repostring, opts *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://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-repository-clones
func (*RepositoriesService)ListTrafficPaths¶
func (s *RepositoriesService) ListTrafficPaths(ctxcontext.Context, owner, repostring) ([]*TrafficPath, *Response,error)
ListTrafficPaths list the top 10 popular content over the last 14 days.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-top-referral-paths
func (*RepositoriesService)ListTrafficReferrers¶
func (s *RepositoriesService) ListTrafficReferrers(ctxcontext.Context, owner, repostring) ([]*TrafficReferrer, *Response,error)
ListTrafficReferrers list the top 10 referrers over the last 14 days.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-top-referral-sources
func (*RepositoriesService)ListTrafficViews¶
func (s *RepositoriesService) ListTrafficViews(ctxcontext.Context, owner, repostring, opts *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://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#get-page-views
func (*RepositoriesService)Merge¶
func (s *RepositoriesService) Merge(ctxcontext.Context, owner, repostring, request *RepositoryMergeRequest) (*RepositoryCommit, *Response,error)
Merge a branch in the specified repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#merge-a-branch
func (*RepositoriesService)OptionalSignaturesOnProtectedBranch¶
func (s *RepositoriesService) OptionalSignaturesOnProtectedBranch(ctxcontext.Context, owner, repo, branchstring) (*Response,error)
OptionalSignaturesOnProtectedBranch removes required signed commits on a given branch.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#delete-commit-signature-protection
func (*RepositoriesService)PingHook¶
func (s *RepositoriesService) PingHook(ctxcontext.Context, owner, repostring, idint64) (*Response,error)
PingHook triggers a 'ping' event to be sent to the Hook.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#ping-a-repository-webhook
func (*RepositoriesService)RemoveAdminEnforcement¶
func (s *RepositoriesService) RemoveAdminEnforcement(ctxcontext.Context, owner, repo, branchstring) (*Response,error)
RemoveAdminEnforcement removes admin enforcement from a protected branch.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#delete-admin-branch-protection
func (*RepositoriesService)RemoveAppRestrictions¶
func (s *RepositoriesService) RemoveAppRestrictions(ctxcontext.Context, owner, repo, branchstring, slug []string) ([]*App, *Response,error)
RemoveAppRestrictions removes the ability of an app to push to this branch.It requires the GitHub apps to have `write` access to the `content` permission.
Note: The list of users, apps, and teams in total is limited to 100 items.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#remove-app-access-restrictions
func (*RepositoriesService)RemoveBranchProtection¶
func (s *RepositoriesService) RemoveBranchProtection(ctxcontext.Context, owner, repo, branchstring) (*Response,error)
RemoveBranchProtection removes the protection of a given branch.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#delete-branch-protection
func (*RepositoriesService)RemoveCollaborator¶
func (s *RepositoriesService) RemoveCollaborator(ctxcontext.Context, owner, repo, userstring) (*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://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#remove-a-repository-collaborator
func (*RepositoriesService)RemovePullRequestReviewEnforcement¶
func (s *RepositoriesService) RemovePullRequestReviewEnforcement(ctxcontext.Context, owner, repo, branchstring) (*Response,error)
RemovePullRequestReviewEnforcement removes pull request enforcement of a protected branch.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#delete-pull-request-review-protection
func (*RepositoriesService)RemoveRequiredStatusChecks¶
func (s *RepositoriesService) RemoveRequiredStatusChecks(ctxcontext.Context, owner, repo, branchstring) (*Response,error)
RemoveRequiredStatusChecks removes the required status checks for a given protected branch.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#remove-status-check-protection
func (*RepositoriesService)RenameBranch¶
func (s *RepositoriesService) RenameBranch(ctxcontext.Context, owner, repo, branch, newNamestring) (*Branch, *Response,error)
RenameBranch renames a branch in a repository.
To rename a non-default branch: Users must have push access. GitHub Apps must have the `contents:write` repository permission.To rename the default branch: Users must have admin or owner permissions. GitHub Apps must have the `administration:write` repository permission.
GitHub API docs:https://docs.github.com/en/rest/reference/repos#rename-a-branch
func (*RepositoriesService)ReplaceAllTopics¶
func (s *RepositoriesService) ReplaceAllTopics(ctxcontext.Context, owner, repostring, topics []string) ([]string, *Response,error)
ReplaceAllTopics replaces topics for a repository.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#replace-all-repository-topics
func (*RepositoriesService)ReplaceAppRestrictions¶
func (s *RepositoriesService) ReplaceAppRestrictions(ctxcontext.Context, owner, repo, branchstring, slug []string) ([]*App, *Response,error)
ReplaceAppRestrictions replaces the apps that have push access to a given protected branch.It removes all apps that previously had push access and grants push access to the new list of apps.It requires the GitHub apps to have `write` access to the `content` permission.
Note: The list of users, apps, and teams in total is limited to 100 items.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#set-app-access-restrictions
func (*RepositoriesService)RequestPageBuild¶
func (s *RepositoriesService) RequestPageBuild(ctxcontext.Context, owner, repostring) (*PagesBuild, *Response,error)
RequestPageBuild requests a build of a GitHub Pages site without needing to push new commit.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#request-a-github-pages-build
func (*RepositoriesService)RequireSignaturesOnProtectedBranch¶
func (s *RepositoriesService) RequireSignaturesOnProtectedBranch(ctxcontext.Context, owner, repo, branchstring) (*SignaturesProtectedBranch, *Response,error)
RequireSignaturesOnProtectedBranch makes signed commits required on a protected branch.It requires admin access and branch protection to be enabled.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#create-commit-signature-protection
func (*RepositoriesService)TestHook¶
func (s *RepositoriesService) TestHook(ctxcontext.Context, owner, repostring, idint64) (*Response,error)
TestHook triggers a test Hook by github.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#test-the-push-repository-webhook
func (*RepositoriesService)Transfer¶
func (s *RepositoriesService) Transfer(ctxcontext.Context, owner, repostring, transferTransferRequest) (*Repository, *Response,error)
Transfer transfers a repository from one account or organization to another.
This method might return an *AcceptedError and a status code of202. This is because this is the status that GitHub returns to signify thatit 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 resultin a successful request.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#transfer-a-repository
func (*RepositoriesService)UpdateBranchProtection¶
func (s *RepositoriesService) UpdateBranchProtection(ctxcontext.Context, owner, repo, branchstring, preq *ProtectionRequest) (*Protection, *Response,error)
UpdateBranchProtection updates the protection of a given branch.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#update-branch-protection
func (*RepositoriesService)UpdateComment¶
func (s *RepositoriesService) UpdateComment(ctxcontext.Context, owner, repostring, idint64, comment *RepositoryComment) (*RepositoryComment, *Response,error)
UpdateComment updates the body of a single comment.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#update-a-commit-comment
func (*RepositoriesService)UpdateFile¶
func (s *RepositoriesService) UpdateFile(ctxcontext.Context, owner, repo, pathstring, opts *RepositoryContentFileOptions) (*RepositoryContentResponse, *Response,error)
UpdateFile updates a file in a repository at the given path and returns thecommit and file metadata. Requires the blob SHA of the file being updated.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#create-or-update-file-contents
func (*RepositoriesService)UpdateInvitation¶
func (s *RepositoriesService) UpdateInvitation(ctxcontext.Context, owner, repostring, invitationIDint64, permissionsstring) (*RepositoryInvitation, *Response,error)
UpdateInvitation updates the permissions associated with a repositoryinvitation.
permissions represents the permissions that the associated user will haveon the repository. Possible values are: "read", "write", "admin".
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#update-a-repository-invitation
func (*RepositoriesService)UpdatePages¶
func (s *RepositoriesService) UpdatePages(ctxcontext.Context, owner, repostring, opts *PagesUpdate) (*Response,error)
UpdatePages updates GitHub Pages for the named repo.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#update-information-about-a-github-pages-site
func (*RepositoriesService)UpdatePreReceiveHook¶
func (s *RepositoriesService) UpdatePreReceiveHook(ctxcontext.Context, owner, repostring, idint64, 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 (*RepositoriesService)UpdatePullRequestReviewEnforcement¶
func (s *RepositoriesService) UpdatePullRequestReviewEnforcement(ctxcontext.Context, owner, repo, branchstring, 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://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#update-pull-request-review-protection
func (*RepositoriesService)UpdateRequiredStatusChecks¶
func (s *RepositoriesService) UpdateRequiredStatusChecks(ctxcontext.Context, owner, repo, branchstring, sreq *RequiredStatusChecksRequest) (*RequiredStatusChecks, *Response,error)
UpdateRequiredStatusChecks updates the required status checks for a given protected branch.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#update-status-check-protection
func (*RepositoriesService)UploadReleaseAsset¶
func (s *RepositoriesService) UploadReleaseAsset(ctxcontext.Context, owner, repostring, idint64, opts *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://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#upload-a-release-asset
typeRepository¶
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"`OpenIssues *int `json:"open_issues,omitempty"`// Deprecated: Replaced by OpenIssuesCount. For backward compatibility OpenIssues is still populated.StargazersCount *int `json:"stargazers_count,omitempty"`SubscribersCount *int `json:"subscribers_count,omitempty"`WatchersCount *int `json:"watchers_count,omitempty"`// Deprecated: Replaced by StargazersCount. For backward compatibility WatchersCount is still populated.Watchers *int `json:"watchers,omitempty"`// Deprecated: Replaced by StargazersCount. For backward compatibility Watchers is still populated.Size *int `json:"size,omitempty"`AutoInit *bool `json:"auto_init,omitempty"`Parent *Repository `json:"parent,omitempty"`Source *Repository `json:"source,omitempty"`TemplateRepository *Repository `json:"template_repository,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"`AllowAutoMerge *bool `json:"allow_auto_merge,omitempty"`AllowForking *bool `json:"allow_forking,omitempty"`DeleteBranchOnMerge *bool `json:"delete_branch_on_merge,omitempty"`Topics []string `json:"topics,omitempty"`Archived *bool `json:"archived,omitempty"`Disabled *bool `json:"disabled,omitempty"`// Only provided when using RepositoriesService.Get while in previewLicense *License `json:"license,omitempty"`// Additional mutable fields when creating and editing a repositoryPrivate *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"`IsTemplate *bool `json:"is_template,omitempty"`LicenseTemplate *string `json:"license_template,omitempty"`GitignoreTemplate *string `json:"gitignore_template,omitempty"`// Options for configuring Advanced Security and Secret ScanningSecurityAndAnalysis *SecurityAndAnalysis `json:"security_and_analysis,omitempty"`// Creating an organization repository. Required for non-owners.TeamID *int64 `json:"team_id,omitempty"`// API URLsURL *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 andhttps://docs.github.com/en/free-pro-team@latest/rest/reference/search/#text-match-metadataTextMatches []*TextMatch `json:"text_matches,omitempty"`// Visibility is only used for Create and Edit endpoints. The visibility field// overrides the field parameter when both are used.// Can be one of public, private or internal.Visibility *string `json:"visibility,omitempty"`}
Repository represents a GitHub repository.
func (*Repository)GetAllowAutoMerge¶
func (r *Repository) GetAllowAutoMerge()bool
GetAllowAutoMerge returns the AllowAutoMerge field if it's non-nil, zero value otherwise.
func (*Repository)GetAllowForking¶
func (r *Repository) GetAllowForking()bool
GetAllowForking returns the AllowForking field if it's non-nil, zero value otherwise.
func (*Repository)GetAllowMergeCommit¶
func (r *Repository) GetAllowMergeCommit()bool
GetAllowMergeCommit returns the AllowMergeCommit field if it's non-nil, zero value otherwise.
func (*Repository)GetAllowRebaseMerge¶
func (r *Repository) GetAllowRebaseMerge()bool
GetAllowRebaseMerge returns the AllowRebaseMerge field if it's non-nil, zero value otherwise.
func (*Repository)GetAllowSquashMerge¶
func (r *Repository) GetAllowSquashMerge()bool
GetAllowSquashMerge returns the AllowSquashMerge field if it's non-nil, zero value otherwise.
func (*Repository)GetArchiveURL¶
func (r *Repository) GetArchiveURL()string
GetArchiveURL returns the ArchiveURL field if it's non-nil, zero value otherwise.
func (*Repository)GetArchived¶
func (r *Repository) GetArchived()bool
GetArchived returns the Archived field if it's non-nil, zero value otherwise.
func (*Repository)GetAssigneesURL¶
func (r *Repository) GetAssigneesURL()string
GetAssigneesURL returns the AssigneesURL field if it's non-nil, zero value otherwise.
func (*Repository)GetAutoInit¶
func (r *Repository) GetAutoInit()bool
GetAutoInit returns the AutoInit field if it's non-nil, zero value otherwise.
func (*Repository)GetBlobsURL¶
func (r *Repository) GetBlobsURL()string
GetBlobsURL returns the BlobsURL field if it's non-nil, zero value otherwise.
func (*Repository)GetBranchesURL¶
func (r *Repository) GetBranchesURL()string
GetBranchesURL returns the BranchesURL field if it's non-nil, zero value otherwise.
func (*Repository)GetCloneURL¶
func (r *Repository) GetCloneURL()string
GetCloneURL returns the CloneURL field if it's non-nil, zero value otherwise.
func (*Repository)GetCodeOfConduct¶
func (r *Repository) GetCodeOfConduct() *CodeOfConduct
GetCodeOfConduct returns the CodeOfConduct field.
func (*Repository)GetCollaboratorsURL¶
func (r *Repository) GetCollaboratorsURL()string
GetCollaboratorsURL returns the CollaboratorsURL field if it's non-nil, zero value otherwise.
func (*Repository)GetCommentsURL¶
func (r *Repository) GetCommentsURL()string
GetCommentsURL returns the CommentsURL field if it's non-nil, zero value otherwise.
func (*Repository)GetCommitsURL¶
func (r *Repository) GetCommitsURL()string
GetCommitsURL returns the CommitsURL field if it's non-nil, zero value otherwise.
func (*Repository)GetCompareURL¶
func (r *Repository) GetCompareURL()string
GetCompareURL returns the CompareURL field if it's non-nil, zero value otherwise.
func (*Repository)GetContentsURL¶
func (r *Repository) GetContentsURL()string
GetContentsURL returns the ContentsURL field if it's non-nil, zero value otherwise.
func (*Repository)GetContributorsURL¶
func (r *Repository) GetContributorsURL()string
GetContributorsURL returns the ContributorsURL field if it's non-nil, zero value otherwise.
func (*Repository)GetCreatedAt¶
func (r *Repository) GetCreatedAt()Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*Repository)GetDefaultBranch¶
func (r *Repository) GetDefaultBranch()string
GetDefaultBranch returns the DefaultBranch field if it's non-nil, zero value otherwise.
func (*Repository)GetDeleteBranchOnMerge¶
func (r *Repository) GetDeleteBranchOnMerge()bool
GetDeleteBranchOnMerge returns the DeleteBranchOnMerge field if it's non-nil, zero value otherwise.
func (*Repository)GetDeploymentsURL¶
func (r *Repository) GetDeploymentsURL()string
GetDeploymentsURL returns the DeploymentsURL field if it's non-nil, zero value otherwise.
func (*Repository)GetDescription¶
func (r *Repository) GetDescription()string
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (*Repository)GetDisabled¶
func (r *Repository) GetDisabled()bool
GetDisabled returns the Disabled field if it's non-nil, zero value otherwise.
func (*Repository)GetDownloadsURL¶
func (r *Repository) GetDownloadsURL()string
GetDownloadsURL returns the DownloadsURL field if it's non-nil, zero value otherwise.
func (*Repository)GetEventsURL¶
func (r *Repository) GetEventsURL()string
GetEventsURL returns the EventsURL field if it's non-nil, zero value otherwise.
func (*Repository)GetFork¶
func (r *Repository) GetFork()bool
GetFork returns the Fork field if it's non-nil, zero value otherwise.
func (*Repository)GetForksCount¶
func (r *Repository) GetForksCount()int
GetForksCount returns the ForksCount field if it's non-nil, zero value otherwise.
func (*Repository)GetForksURL¶
func (r *Repository) GetForksURL()string
GetForksURL returns the ForksURL field if it's non-nil, zero value otherwise.
func (*Repository)GetFullName¶
func (r *Repository) GetFullName()string
GetFullName returns the FullName field if it's non-nil, zero value otherwise.
func (*Repository)GetGitCommitsURL¶
func (r *Repository) GetGitCommitsURL()string
GetGitCommitsURL returns the GitCommitsURL field if it's non-nil, zero value otherwise.
func (*Repository)GetGitRefsURL¶
func (r *Repository) GetGitRefsURL()string
GetGitRefsURL returns the GitRefsURL field if it's non-nil, zero value otherwise.
func (*Repository)GetGitTagsURL¶
func (r *Repository) GetGitTagsURL()string
GetGitTagsURL returns the GitTagsURL field if it's non-nil, zero value otherwise.
func (*Repository)GetGitURL¶
func (r *Repository) GetGitURL()string
GetGitURL returns the GitURL field if it's non-nil, zero value otherwise.
func (*Repository)GetGitignoreTemplate¶
func (r *Repository) GetGitignoreTemplate()string
GetGitignoreTemplate returns the GitignoreTemplate field if it's non-nil, zero value otherwise.
func (*Repository)GetHTMLURL¶
func (r *Repository) GetHTMLURL()string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*Repository)GetHasDownloads¶
func (r *Repository) GetHasDownloads()bool
GetHasDownloads returns the HasDownloads field if it's non-nil, zero value otherwise.
func (*Repository)GetHasIssues¶
func (r *Repository) GetHasIssues()bool
GetHasIssues returns the HasIssues field if it's non-nil, zero value otherwise.
func (*Repository)GetHasPages¶
func (r *Repository) GetHasPages()bool
GetHasPages returns the HasPages field if it's non-nil, zero value otherwise.
func (*Repository)GetHasProjects¶
func (r *Repository) GetHasProjects()bool
GetHasProjects returns the HasProjects field if it's non-nil, zero value otherwise.
func (*Repository)GetHasWiki¶
func (r *Repository) GetHasWiki()bool
GetHasWiki returns the HasWiki field if it's non-nil, zero value otherwise.
func (*Repository)GetHomepage¶
func (r *Repository) GetHomepage()string
GetHomepage returns the Homepage field if it's non-nil, zero value otherwise.
func (*Repository)GetHooksURL¶
func (r *Repository) GetHooksURL()string
GetHooksURL returns the HooksURL field if it's non-nil, zero value otherwise.
func (*Repository)GetID¶
func (r *Repository) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*Repository)GetIsTemplate¶
func (r *Repository) GetIsTemplate()bool
GetIsTemplate returns the IsTemplate field if it's non-nil, zero value otherwise.
func (*Repository)GetIssueCommentURL¶
func (r *Repository) GetIssueCommentURL()string
GetIssueCommentURL returns the IssueCommentURL field if it's non-nil, zero value otherwise.
func (*Repository)GetIssueEventsURL¶
func (r *Repository) GetIssueEventsURL()string
GetIssueEventsURL returns the IssueEventsURL field if it's non-nil, zero value otherwise.
func (*Repository)GetIssuesURL¶
func (r *Repository) GetIssuesURL()string
GetIssuesURL returns the IssuesURL field if it's non-nil, zero value otherwise.
func (*Repository)GetKeysURL¶
func (r *Repository) GetKeysURL()string
GetKeysURL returns the KeysURL field if it's non-nil, zero value otherwise.
func (*Repository)GetLabelsURL¶
func (r *Repository) GetLabelsURL()string
GetLabelsURL returns the LabelsURL field if it's non-nil, zero value otherwise.
func (*Repository)GetLanguage¶
func (r *Repository) GetLanguage()string
GetLanguage returns the Language field if it's non-nil, zero value otherwise.
func (*Repository)GetLanguagesURL¶
func (r *Repository) GetLanguagesURL()string
GetLanguagesURL returns the LanguagesURL field if it's non-nil, zero value otherwise.
func (*Repository)GetLicense¶
func (r *Repository) GetLicense() *License
GetLicense returns the License field.
func (*Repository)GetLicenseTemplate¶
func (r *Repository) GetLicenseTemplate()string
GetLicenseTemplate returns the LicenseTemplate field if it's non-nil, zero value otherwise.
func (*Repository)GetMasterBranch¶
func (r *Repository) GetMasterBranch()string
GetMasterBranch returns the MasterBranch field if it's non-nil, zero value otherwise.
func (*Repository)GetMergesURL¶
func (r *Repository) GetMergesURL()string
GetMergesURL returns the MergesURL field if it's non-nil, zero value otherwise.
func (*Repository)GetMilestonesURL¶
func (r *Repository) GetMilestonesURL()string
GetMilestonesURL returns the MilestonesURL field if it's non-nil, zero value otherwise.
func (*Repository)GetMirrorURL¶
func (r *Repository) GetMirrorURL()string
GetMirrorURL returns the MirrorURL field if it's non-nil, zero value otherwise.
func (*Repository)GetName¶
func (r *Repository) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*Repository)GetNetworkCount¶
func (r *Repository) GetNetworkCount()int
GetNetworkCount returns the NetworkCount field if it's non-nil, zero value otherwise.
func (*Repository)GetNodeID¶
func (r *Repository) GetNodeID()string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (*Repository)GetNotificationsURL¶
func (r *Repository) GetNotificationsURL()string
GetNotificationsURL returns the NotificationsURL field if it's non-nil, zero value otherwise.
func (*Repository)GetOpenIssues¶
func (r *Repository) GetOpenIssues()int
GetOpenIssues returns the OpenIssues field if it's non-nil, zero value otherwise.
func (*Repository)GetOpenIssuesCount¶
func (r *Repository) GetOpenIssuesCount()int
GetOpenIssuesCount returns the OpenIssuesCount field if it's non-nil, zero value otherwise.
func (*Repository)GetOrganization¶
func (r *Repository) GetOrganization() *Organization
GetOrganization returns the Organization field.
func (*Repository)GetParent¶
func (r *Repository) GetParent() *Repository
GetParent returns the Parent field.
func (*Repository)GetPermissions¶
func (r *Repository) GetPermissions() map[string]bool
GetPermissions returns the Permissions map if it's non-nil, an empty map otherwise.
func (*Repository)GetPrivate¶
func (r *Repository) GetPrivate()bool
GetPrivate returns the Private field if it's non-nil, zero value otherwise.
func (*Repository)GetPullsURL¶
func (r *Repository) GetPullsURL()string
GetPullsURL returns the PullsURL field if it's non-nil, zero value otherwise.
func (*Repository)GetPushedAt¶
func (r *Repository) GetPushedAt()Timestamp
GetPushedAt returns the PushedAt field if it's non-nil, zero value otherwise.
func (*Repository)GetReleasesURL¶
func (r *Repository) GetReleasesURL()string
GetReleasesURL returns the ReleasesURL field if it's non-nil, zero value otherwise.
func (*Repository)GetSSHURL¶
func (r *Repository) GetSSHURL()string
GetSSHURL returns the SSHURL field if it's non-nil, zero value otherwise.
func (*Repository)GetSVNURL¶
func (r *Repository) GetSVNURL()string
GetSVNURL returns the SVNURL field if it's non-nil, zero value otherwise.
func (*Repository)GetSecurityAndAnalysis¶
func (r *Repository) GetSecurityAndAnalysis() *SecurityAndAnalysis
GetSecurityAndAnalysis returns the SecurityAndAnalysis field.
func (*Repository)GetSize¶
func (r *Repository) GetSize()int
GetSize returns the Size field if it's non-nil, zero value otherwise.
func (*Repository)GetSource¶
func (r *Repository) GetSource() *Repository
GetSource returns the Source field.
func (*Repository)GetStargazersCount¶
func (r *Repository) GetStargazersCount()int
GetStargazersCount returns the StargazersCount field if it's non-nil, zero value otherwise.
func (*Repository)GetStargazersURL¶
func (r *Repository) GetStargazersURL()string
GetStargazersURL returns the StargazersURL field if it's non-nil, zero value otherwise.
func (*Repository)GetStatusesURL¶
func (r *Repository) GetStatusesURL()string
GetStatusesURL returns the StatusesURL field if it's non-nil, zero value otherwise.
func (*Repository)GetSubscribersCount¶
func (r *Repository) GetSubscribersCount()int
GetSubscribersCount returns the SubscribersCount field if it's non-nil, zero value otherwise.
func (*Repository)GetSubscribersURL¶
func (r *Repository) GetSubscribersURL()string
GetSubscribersURL returns the SubscribersURL field if it's non-nil, zero value otherwise.
func (*Repository)GetSubscriptionURL¶
func (r *Repository) GetSubscriptionURL()string
GetSubscriptionURL returns the SubscriptionURL field if it's non-nil, zero value otherwise.
func (*Repository)GetTagsURL¶
func (r *Repository) GetTagsURL()string
GetTagsURL returns the TagsURL field if it's non-nil, zero value otherwise.
func (*Repository)GetTeamID¶
func (r *Repository) GetTeamID()int64
GetTeamID returns the TeamID field if it's non-nil, zero value otherwise.
func (*Repository)GetTeamsURL¶
func (r *Repository) GetTeamsURL()string
GetTeamsURL returns the TeamsURL field if it's non-nil, zero value otherwise.
func (*Repository)GetTemplateRepository¶
func (r *Repository) GetTemplateRepository() *Repository
GetTemplateRepository returns the TemplateRepository field.
func (*Repository)GetTreesURL¶
func (r *Repository) GetTreesURL()string
GetTreesURL returns the TreesURL field if it's non-nil, zero value otherwise.
func (*Repository)GetURL¶
func (r *Repository) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (*Repository)GetUpdatedAt¶
func (r *Repository) GetUpdatedAt()Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (*Repository)GetVisibility¶
func (r *Repository) GetVisibility()string
GetVisibility returns the Visibility field if it's non-nil, zero value otherwise.
func (*Repository)GetWatchers¶
func (r *Repository) GetWatchers()int
GetWatchers returns the Watchers field if it's non-nil, zero value otherwise.
func (*Repository)GetWatchersCount¶
func (r *Repository) GetWatchersCount()int
GetWatchersCount returns the WatchersCount field if it's non-nil, zero value otherwise.
func (Repository)String¶
func (rRepository) String()string
typeRepositoryActiveCommitters¶
type RepositoryActiveCommitters struct {Name *string `json:"name,omitempty"`AdvancedSecurityCommitters *int `json:"advanced_security_committers,omitempty"`AdvancedSecurityCommittersBreakdown []*AdvancedSecurityCommittersBreakdown `json:"advanced_security_committers_breakdown,omitempty"`}
RepositoryActiveCommitters represents active committers on each repository.
func (*RepositoryActiveCommitters)GetAdvancedSecurityCommitters¶
func (r *RepositoryActiveCommitters) GetAdvancedSecurityCommitters()int
GetAdvancedSecurityCommitters returns the AdvancedSecurityCommitters field if it's non-nil, zero value otherwise.
func (*RepositoryActiveCommitters)GetName¶
func (r *RepositoryActiveCommitters) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
typeRepositoryAddCollaboratorOptions¶
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// maintain - team members can manage the repository without access to sensitive or destructive actions.// triage - team members can proactively manage issues and pull requests without write access.//// Default value is "push". This option is only valid for organization-owned repositories.Permissionstring `json:"permission,omitempty"`}
RepositoryAddCollaboratorOptions specifies the optional parameters to theRepositoriesService.AddCollaborator method.
typeRepositoryComment¶
type RepositoryComment struct {HTMLURL *string `json:"html_url,omitempty"`URL *string `json:"url,omitempty"`ID *int64 `json:"id,omitempty"`NodeID *string `json:"node_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 fieldsBody *string `json:"body"`// User-initialized fieldsPath *string `json:"path,omitempty"`Position *int `json:"position,omitempty"`}
RepositoryComment represents a comment for a commit, file, or line in a repository.
func (*RepositoryComment)GetBody¶
func (r *RepositoryComment) GetBody()string
GetBody returns the Body field if it's non-nil, zero value otherwise.
func (*RepositoryComment)GetCommitID¶
func (r *RepositoryComment) GetCommitID()string
GetCommitID returns the CommitID field if it's non-nil, zero value otherwise.
func (*RepositoryComment)GetCreatedAt¶
func (r *RepositoryComment) GetCreatedAt()time.Time
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*RepositoryComment)GetHTMLURL¶
func (r *RepositoryComment) GetHTMLURL()string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*RepositoryComment)GetID¶
func (r *RepositoryComment) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*RepositoryComment)GetNodeID¶
func (r *RepositoryComment) GetNodeID()string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (*RepositoryComment)GetPath¶
func (r *RepositoryComment) GetPath()string
GetPath returns the Path field if it's non-nil, zero value otherwise.
func (*RepositoryComment)GetPosition¶
func (r *RepositoryComment) GetPosition()int
GetPosition returns the Position field if it's non-nil, zero value otherwise.
func (*RepositoryComment)GetReactions¶
func (r *RepositoryComment) GetReactions() *Reactions
GetReactions returns the Reactions field.
func (*RepositoryComment)GetURL¶
func (r *RepositoryComment) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (*RepositoryComment)GetUpdatedAt¶
func (r *RepositoryComment) GetUpdatedAt()time.Time
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (*RepositoryComment)GetUser¶
func (r *RepositoryComment) GetUser() *User
GetUser returns the User field.
func (RepositoryComment)String¶
func (rRepositoryComment) String()string
typeRepositoryCommit¶
type RepositoryCommit struct {NodeID *string `json:"node_id,omitempty"`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 (*RepositoryCommit)GetAuthor¶
func (r *RepositoryCommit) GetAuthor() *User
GetAuthor returns the Author field.
func (*RepositoryCommit)GetCommentsURL¶
func (r *RepositoryCommit) GetCommentsURL()string
GetCommentsURL returns the CommentsURL field if it's non-nil, zero value otherwise.
func (*RepositoryCommit)GetCommit¶
func (r *RepositoryCommit) GetCommit() *Commit
GetCommit returns the Commit field.
func (*RepositoryCommit)GetCommitter¶
func (r *RepositoryCommit) GetCommitter() *User
GetCommitter returns the Committer field.
func (*RepositoryCommit)GetHTMLURL¶
func (r *RepositoryCommit) GetHTMLURL()string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*RepositoryCommit)GetNodeID¶
func (r *RepositoryCommit) GetNodeID()string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (*RepositoryCommit)GetSHA¶
func (r *RepositoryCommit) GetSHA()string
GetSHA returns the SHA field if it's non-nil, zero value otherwise.
func (*RepositoryCommit)GetStats¶
func (r *RepositoryCommit) GetStats() *CommitStats
GetStats returns the Stats field.
func (*RepositoryCommit)GetURL¶
func (r *RepositoryCommit) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (RepositoryCommit)String¶
func (rRepositoryCommit) String()string
typeRepositoryContent¶
type RepositoryContent struct {Type *string `json:"type,omitempty"`// Target is only set if the type is "symlink" and the target is not a normal file.// If Target is set, Path will be the symlink path.Target *string `json:"target,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 (*RepositoryContent)GetContent¶
func (r *RepositoryContent) GetContent() (string,error)
GetContent returns the content of r, decoding it if necessary.
func (*RepositoryContent)GetDownloadURL¶
func (r *RepositoryContent) GetDownloadURL()string
GetDownloadURL returns the DownloadURL field if it's non-nil, zero value otherwise.
func (*RepositoryContent)GetEncoding¶
func (r *RepositoryContent) GetEncoding()string
GetEncoding returns the Encoding field if it's non-nil, zero value otherwise.
func (*RepositoryContent)GetGitURL¶
func (r *RepositoryContent) GetGitURL()string
GetGitURL returns the GitURL field if it's non-nil, zero value otherwise.
func (*RepositoryContent)GetHTMLURL¶
func (r *RepositoryContent) GetHTMLURL()string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*RepositoryContent)GetName¶
func (r *RepositoryContent) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*RepositoryContent)GetPath¶
func (r *RepositoryContent) GetPath()string
GetPath returns the Path field if it's non-nil, zero value otherwise.
func (*RepositoryContent)GetSHA¶
func (r *RepositoryContent) GetSHA()string
GetSHA returns the SHA field if it's non-nil, zero value otherwise.
func (*RepositoryContent)GetSize¶
func (r *RepositoryContent) GetSize()int
GetSize returns the Size field if it's non-nil, zero value otherwise.
func (*RepositoryContent)GetTarget¶
func (r *RepositoryContent) GetTarget()string
GetTarget returns the Target field if it's non-nil, zero value otherwise.
func (*RepositoryContent)GetType¶
func (r *RepositoryContent) GetType()string
GetType returns the Type field if it's non-nil, zero value otherwise.
func (*RepositoryContent)GetURL¶
func (r *RepositoryContent) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (RepositoryContent)String¶
func (rRepositoryContent) String()string
String converts RepositoryContent to a string. It's primarily for testing.
typeRepositoryContentFileOptions¶
type RepositoryContentFileOptions struct {Message *string `json:"message,omitempty"`Content []byte `json:"content,omitempty"`// unencodedSHA *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 (*RepositoryContentFileOptions)GetAuthor¶
func (r *RepositoryContentFileOptions) GetAuthor() *CommitAuthor
GetAuthor returns the Author field.
func (*RepositoryContentFileOptions)GetBranch¶
func (r *RepositoryContentFileOptions) GetBranch()string
GetBranch returns the Branch field if it's non-nil, zero value otherwise.
func (*RepositoryContentFileOptions)GetCommitter¶
func (r *RepositoryContentFileOptions) GetCommitter() *CommitAuthor
GetCommitter returns the Committer field.
func (*RepositoryContentFileOptions)GetMessage¶
func (r *RepositoryContentFileOptions) GetMessage()string
GetMessage returns the Message field if it's non-nil, zero value otherwise.
func (*RepositoryContentFileOptions)GetSHA¶
func (r *RepositoryContentFileOptions) GetSHA()string
GetSHA returns the SHA field if it's non-nil, zero value otherwise.
typeRepositoryContentGetOptions¶
type RepositoryContentGetOptions struct {Refstring `url:"ref,omitempty"`}
RepositoryContentGetOptions represents an optional ref parameter, which can be a SHA,branch, or tag
typeRepositoryContentResponse¶
type RepositoryContentResponse struct {Content *RepositoryContent `json:"content,omitempty"`Commit `json:"commit,omitempty"`}
RepositoryContentResponse holds the parsed response from CreateFile, UpdateFile, and DeleteFile.
func (*RepositoryContentResponse)GetContent¶
func (r *RepositoryContentResponse) GetContent() *RepositoryContent
GetContent returns the Content field.
typeRepositoryCreateForkOptions¶
type RepositoryCreateForkOptions struct {// The organization to fork the repository into.Organizationstring `url:"organization,omitempty"`}
RepositoryCreateForkOptions specifies the optional parameters to theRepositoriesService.CreateFork method.
typeRepositoryDispatchEvent¶
type RepositoryDispatchEvent struct {// Action is the event_type that submitted with the repository dispatch payload. Value can be any string.Action *string `json:"action,omitempty"`Branch *string `json:"branch,omitempty"`ClientPayloadjson.RawMessage `json:"client_payload,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"`}
RepositoryDispatchEvent is triggered when a client sends a POST request to the repository dispatch event endpoint.
GitHub API docs:https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#repository_dispatch
func (*RepositoryDispatchEvent)GetAction¶
func (r *RepositoryDispatchEvent) GetAction()string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*RepositoryDispatchEvent)GetBranch¶
func (r *RepositoryDispatchEvent) GetBranch()string
GetBranch returns the Branch field if it's non-nil, zero value otherwise.
func (*RepositoryDispatchEvent)GetInstallation¶
func (r *RepositoryDispatchEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*RepositoryDispatchEvent)GetOrg¶
func (r *RepositoryDispatchEvent) GetOrg() *Organization
GetOrg returns the Org field.
func (*RepositoryDispatchEvent)GetRepo¶
func (r *RepositoryDispatchEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (*RepositoryDispatchEvent)GetSender¶
func (r *RepositoryDispatchEvent) GetSender() *User
GetSender returns the Sender field.
typeRepositoryEvent¶
type RepositoryEvent struct {// Action is the action that was performed. Possible values are: "created",// "deleted" (organization hooks only), "archived", "unarchived", "edited", "renamed",// "transferred", "publicized", or "privatized".Action *string `json:"action,omitempty"`Repo *Repository `json:"repository,omitempty"`// The following fields are only populated by Webhook events.Changes *EditChange `json:"changes,omitempty"`Org *Organization `json:"organization,omitempty"`Sender *User `json:"sender,omitempty"`Installation *Installation `json:"installation,omitempty"`}
RepositoryEvent is triggered when a repository is created, archived, unarchived,renamed, edited, transferred, made public, or made private. Organization hooks arealso trigerred when a repository is deleted.The Webhook event name is "repository".
Events of this type are not visible in timelines, they are only used totrigger organization webhooks.
GitHub API docs:https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#repository
func (*RepositoryEvent)GetAction¶
func (r *RepositoryEvent) GetAction()string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*RepositoryEvent)GetChanges¶
func (r *RepositoryEvent) GetChanges() *EditChange
GetChanges returns the Changes field.
func (*RepositoryEvent)GetInstallation¶
func (r *RepositoryEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*RepositoryEvent)GetOrg¶
func (r *RepositoryEvent) GetOrg() *Organization
GetOrg returns the Org field.
func (*RepositoryEvent)GetRepo¶
func (r *RepositoryEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (*RepositoryEvent)GetSender¶
func (r *RepositoryEvent) GetSender() *User
GetSender returns the Sender field.
typeRepositoryInvitation¶
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 (*RepositoryInvitation)GetCreatedAt¶
func (r *RepositoryInvitation) GetCreatedAt()Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*RepositoryInvitation)GetHTMLURL¶
func (r *RepositoryInvitation) GetHTMLURL()string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*RepositoryInvitation)GetID¶
func (r *RepositoryInvitation) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*RepositoryInvitation)GetInvitee¶
func (r *RepositoryInvitation) GetInvitee() *User
GetInvitee returns the Invitee field.
func (*RepositoryInvitation)GetInviter¶
func (r *RepositoryInvitation) GetInviter() *User
GetInviter returns the Inviter field.
func (*RepositoryInvitation)GetPermissions¶
func (r *RepositoryInvitation) GetPermissions()string
GetPermissions returns the Permissions field if it's non-nil, zero value otherwise.
func (*RepositoryInvitation)GetRepo¶
func (r *RepositoryInvitation) GetRepo() *Repository
GetRepo returns the Repo field.
func (*RepositoryInvitation)GetURL¶
func (r *RepositoryInvitation) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
typeRepositoryLicense¶
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 (*RepositoryLicense)GetContent¶
func (r *RepositoryLicense) GetContent()string
GetContent returns the Content field if it's non-nil, zero value otherwise.
func (*RepositoryLicense)GetDownloadURL¶
func (r *RepositoryLicense) GetDownloadURL()string
GetDownloadURL returns the DownloadURL field if it's non-nil, zero value otherwise.
func (*RepositoryLicense)GetEncoding¶
func (r *RepositoryLicense) GetEncoding()string
GetEncoding returns the Encoding field if it's non-nil, zero value otherwise.
func (*RepositoryLicense)GetGitURL¶
func (r *RepositoryLicense) GetGitURL()string
GetGitURL returns the GitURL field if it's non-nil, zero value otherwise.
func (*RepositoryLicense)GetHTMLURL¶
func (r *RepositoryLicense) GetHTMLURL()string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*RepositoryLicense)GetLicense¶
func (r *RepositoryLicense) GetLicense() *License
GetLicense returns the License field.
func (*RepositoryLicense)GetName¶
func (r *RepositoryLicense) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*RepositoryLicense)GetPath¶
func (r *RepositoryLicense) GetPath()string
GetPath returns the Path field if it's non-nil, zero value otherwise.
func (*RepositoryLicense)GetSHA¶
func (r *RepositoryLicense) GetSHA()string
GetSHA returns the SHA field if it's non-nil, zero value otherwise.
func (*RepositoryLicense)GetSize¶
func (r *RepositoryLicense) GetSize()int
GetSize returns the Size field if it's non-nil, zero value otherwise.
func (*RepositoryLicense)GetType¶
func (r *RepositoryLicense) GetType()string
GetType returns the Type field if it's non-nil, zero value otherwise.
func (*RepositoryLicense)GetURL¶
func (r *RepositoryLicense) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (RepositoryLicense)String¶
func (lRepositoryLicense) String()string
typeRepositoryListAllOptions¶
type RepositoryListAllOptions struct {// ID of the last repository seenSinceint64 `url:"since,omitempty"`}
RepositoryListAllOptions specifies the optional parameters to theRepositoriesService.ListAll method.
typeRepositoryListByOrgOptions¶
type RepositoryListByOrgOptions struct {// Type of repositories to list. Possible values are: all, public, private,// forks, sources, member. Default is "all".Typestring `url:"type,omitempty"`// How to sort the repository list. Can be one of created, updated, pushed,// full_name. Default is "created".Sortstring `url:"sort,omitempty"`// Direction in which to sort repositories. Can be one of asc or desc.// Default when using full_name: asc; otherwise desc.Directionstring `url:"direction,omitempty"`ListOptions}
RepositoryListByOrgOptions specifies the optional parameters to theRepositoriesService.ListByOrg method.
typeRepositoryListForksOptions¶
type RepositoryListForksOptions struct {// How to sort the forks list. Possible values are: newest, oldest,// watchers. Default is "newest".Sortstring `url:"sort,omitempty"`ListOptions}
RepositoryListForksOptions specifies the optional parameters to theRepositoriesService.ListForks method.
typeRepositoryListOptions¶
type RepositoryListOptions struct {// Visibility of repositories to list. Can be one of all, public, or private.// Default: allVisibilitystring `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_memberAffiliationstring `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.Typestring `url:"type,omitempty"`// How to sort the repository list. Can be one of created, updated, pushed,// full_name. Default: full_nameSortstring `url:"sort,omitempty"`// Direction in which to sort repositories. Can be one of asc or desc.// Default: when using full_name: asc; otherwise descDirectionstring `url:"direction,omitempty"`ListOptions}
RepositoryListOptions specifies the optional parameters to theRepositoriesService.List method.
typeRepositoryMergeRequest¶
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 arepository.
func (*RepositoryMergeRequest)GetBase¶
func (r *RepositoryMergeRequest) GetBase()string
GetBase returns the Base field if it's non-nil, zero value otherwise.
func (*RepositoryMergeRequest)GetCommitMessage¶
func (r *RepositoryMergeRequest) GetCommitMessage()string
GetCommitMessage returns the CommitMessage field if it's non-nil, zero value otherwise.
func (*RepositoryMergeRequest)GetHead¶
func (r *RepositoryMergeRequest) GetHead()string
GetHead returns the Head field if it's non-nil, zero value otherwise.
typeRepositoryParticipation¶
type RepositoryParticipation struct {All []int `json:"all,omitempty"`Owner []int `json:"owner,omitempty"`}
RepositoryParticipation is the number of commits by everyonewho has contributed to the repository (including the owner)as well as the number of commits by the owner themself.
func (RepositoryParticipation)String¶
func (rRepositoryParticipation) String()string
typeRepositoryPermissionLevel¶
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 organizationmember has for a given repository.
func (*RepositoryPermissionLevel)GetPermission¶
func (r *RepositoryPermissionLevel) GetPermission()string
GetPermission returns the Permission field if it's non-nil, zero value otherwise.
func (*RepositoryPermissionLevel)GetUser¶
func (r *RepositoryPermissionLevel) GetUser() *User
GetUser returns the User field.
typeRepositoryRelease¶
type RepositoryRelease struct {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"`DiscussionCategoryName *string `json:"discussion_category_name,omitempty"`GenerateReleaseNotes *bool `json:"generate_release_notes,omitempty"`// The following fields are not used in CreateRelease or EditRelease:ID *int64 `json:"id,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 (*RepositoryRelease)GetAssetsURL¶
func (r *RepositoryRelease) GetAssetsURL()string
GetAssetsURL returns the AssetsURL field if it's non-nil, zero value otherwise.
func (*RepositoryRelease)GetAuthor¶
func (r *RepositoryRelease) GetAuthor() *User
GetAuthor returns the Author field.
func (*RepositoryRelease)GetBody¶
func (r *RepositoryRelease) GetBody()string
GetBody returns the Body field if it's non-nil, zero value otherwise.
func (*RepositoryRelease)GetCreatedAt¶
func (r *RepositoryRelease) GetCreatedAt()Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*RepositoryRelease)GetDiscussionCategoryName¶
func (r *RepositoryRelease) GetDiscussionCategoryName()string
GetDiscussionCategoryName returns the DiscussionCategoryName field if it's non-nil, zero value otherwise.
func (*RepositoryRelease)GetDraft¶
func (r *RepositoryRelease) GetDraft()bool
GetDraft returns the Draft field if it's non-nil, zero value otherwise.
func (*RepositoryRelease)GetGenerateReleaseNotes¶
func (r *RepositoryRelease) GetGenerateReleaseNotes()bool
GetGenerateReleaseNotes returns the GenerateReleaseNotes field if it's non-nil, zero value otherwise.
func (*RepositoryRelease)GetHTMLURL¶
func (r *RepositoryRelease) GetHTMLURL()string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*RepositoryRelease)GetID¶
func (r *RepositoryRelease) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*RepositoryRelease)GetName¶
func (r *RepositoryRelease) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*RepositoryRelease)GetNodeID¶
func (r *RepositoryRelease) GetNodeID()string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (*RepositoryRelease)GetPrerelease¶
func (r *RepositoryRelease) GetPrerelease()bool
GetPrerelease returns the Prerelease field if it's non-nil, zero value otherwise.
func (*RepositoryRelease)GetPublishedAt¶
func (r *RepositoryRelease) GetPublishedAt()Timestamp
GetPublishedAt returns the PublishedAt field if it's non-nil, zero value otherwise.
func (*RepositoryRelease)GetTagName¶
func (r *RepositoryRelease) GetTagName()string
GetTagName returns the TagName field if it's non-nil, zero value otherwise.
func (*RepositoryRelease)GetTarballURL¶
func (r *RepositoryRelease) GetTarballURL()string
GetTarballURL returns the TarballURL field if it's non-nil, zero value otherwise.
func (*RepositoryRelease)GetTargetCommitish¶
func (r *RepositoryRelease) GetTargetCommitish()string
GetTargetCommitish returns the TargetCommitish field if it's non-nil, zero value otherwise.
func (*RepositoryRelease)GetURL¶
func (r *RepositoryRelease) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (*RepositoryRelease)GetUploadURL¶
func (r *RepositoryRelease) GetUploadURL()string
GetUploadURL returns the UploadURL field if it's non-nil, zero value otherwise.
func (*RepositoryRelease)GetZipballURL¶
func (r *RepositoryRelease) GetZipballURL()string
GetZipballURL returns the ZipballURL field if it's non-nil, zero value otherwise.
func (RepositoryRelease)String¶
func (rRepositoryRelease) String()string
typeRepositoryReleaseNotes¶
RepositoryReleaseNotes represents a GitHub-generated release notes.
typeRepositoryTag¶
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 (*RepositoryTag)GetCommit¶
func (r *RepositoryTag) GetCommit() *Commit
GetCommit returns the Commit field.
func (*RepositoryTag)GetName¶
func (r *RepositoryTag) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*RepositoryTag)GetTarballURL¶
func (r *RepositoryTag) GetTarballURL()string
GetTarballURL returns the TarballURL field if it's non-nil, zero value otherwise.
func (*RepositoryTag)GetZipballURL¶
func (r *RepositoryTag) GetZipballURL()string
GetZipballURL returns the ZipballURL field if it's non-nil, zero value otherwise.
typeRepositoryVulnerabilityAlert¶
type RepositoryVulnerabilityAlert struct {ID *int64 `json:"id,omitempty"`AffectedRange *string `json:"affected_range,omitempty"`AffectedPackageName *string `json:"affected_package_name,omitempty"`ExternalReference *string `json:"external_reference,omitempty"`ExternalIdentifier *string `json:"external_identifier,omitempty"`GitHubSecurityAdvisoryID *string `json:"ghsa_id,omitempty"`Severity *string `json:"severity,omitempty"`CreatedAt *Timestamp `json:"created_at,omitempty"`FixedIn *string `json:"fixed_in,omitempty"`Dismisser *User `json:"dismisser,omitempty"`DismissReason *string `json:"dismiss_reason,omitempty"`DismissedAt *Timestamp `json:"dismissed_at,omitempty"`}
RepositoryVulnerabilityAlert represents a repository security alert.
func (*RepositoryVulnerabilityAlert)GetAffectedPackageName¶
func (r *RepositoryVulnerabilityAlert) GetAffectedPackageName()string
GetAffectedPackageName returns the AffectedPackageName field if it's non-nil, zero value otherwise.
func (*RepositoryVulnerabilityAlert)GetAffectedRange¶
func (r *RepositoryVulnerabilityAlert) GetAffectedRange()string
GetAffectedRange returns the AffectedRange field if it's non-nil, zero value otherwise.
func (*RepositoryVulnerabilityAlert)GetCreatedAt¶
func (r *RepositoryVulnerabilityAlert) GetCreatedAt()Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*RepositoryVulnerabilityAlert)GetDismissReason¶
func (r *RepositoryVulnerabilityAlert) GetDismissReason()string
GetDismissReason returns the DismissReason field if it's non-nil, zero value otherwise.
func (*RepositoryVulnerabilityAlert)GetDismissedAt¶
func (r *RepositoryVulnerabilityAlert) GetDismissedAt()Timestamp
GetDismissedAt returns the DismissedAt field if it's non-nil, zero value otherwise.
func (*RepositoryVulnerabilityAlert)GetDismisser¶
func (r *RepositoryVulnerabilityAlert) GetDismisser() *User
GetDismisser returns the Dismisser field.
func (*RepositoryVulnerabilityAlert)GetExternalIdentifier¶
func (r *RepositoryVulnerabilityAlert) GetExternalIdentifier()string
GetExternalIdentifier returns the ExternalIdentifier field if it's non-nil, zero value otherwise.
func (*RepositoryVulnerabilityAlert)GetExternalReference¶
func (r *RepositoryVulnerabilityAlert) GetExternalReference()string
GetExternalReference returns the ExternalReference field if it's non-nil, zero value otherwise.
func (*RepositoryVulnerabilityAlert)GetFixedIn¶
func (r *RepositoryVulnerabilityAlert) GetFixedIn()string
GetFixedIn returns the FixedIn field if it's non-nil, zero value otherwise.
func (*RepositoryVulnerabilityAlert)GetGitHubSecurityAdvisoryID¶
func (r *RepositoryVulnerabilityAlert) GetGitHubSecurityAdvisoryID()string
GetGitHubSecurityAdvisoryID returns the GitHubSecurityAdvisoryID field if it's non-nil, zero value otherwise.
func (*RepositoryVulnerabilityAlert)GetID¶
func (r *RepositoryVulnerabilityAlert) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*RepositoryVulnerabilityAlert)GetSeverity¶
func (r *RepositoryVulnerabilityAlert) GetSeverity()string
GetSeverity returns the Severity field if it's non-nil, zero value otherwise.
typeRepositoryVulnerabilityAlertEvent¶
type RepositoryVulnerabilityAlertEvent struct {// Action is the action that was performed. Possible values are: "create", "dismiss", "resolve".Action *string `json:"action,omitempty"`//The security alert of the vulnerable dependency.Alert *RepositoryVulnerabilityAlert `json:"alert,omitempty"`//The repository of the vulnerable dependency.Repository *Repository `json:"repository,omitempty"`// The following fields are only populated by Webhook events.Installation *Installation `json:"installation,omitempty"`}
RepositoryVulnerabilityAlertEvent is triggered when a security alert is created, dismissed, or resolved.
GitHub API docs:https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#repository_vulnerability_alert
func (*RepositoryVulnerabilityAlertEvent)GetAction¶
func (r *RepositoryVulnerabilityAlertEvent) GetAction()string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*RepositoryVulnerabilityAlertEvent)GetAlert¶
func (r *RepositoryVulnerabilityAlertEvent) GetAlert() *RepositoryVulnerabilityAlert
GetAlert returns the Alert field.
func (*RepositoryVulnerabilityAlertEvent)GetInstallation¶
func (r *RepositoryVulnerabilityAlertEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*RepositoryVulnerabilityAlertEvent)GetRepository¶
func (r *RepositoryVulnerabilityAlertEvent) GetRepository() *Repository
GetRepository returns the Repository field.
typeRequestedAction¶
type RequestedAction struct {Identifierstring `json:"identifier"`// The integrator reference of the action requested by the user.}
RequestedAction is included in a CheckRunEvent when a user has invoked an action,i.e. when the CheckRunEvent's Action field is "requested_action".
typeRequireLinearHistory¶
type RequireLinearHistory struct {Enabledbool `json:"enabled"`}
RequireLinearHistory represents the configuration to enforce branches with no merge commit.
typeRequiredConversationResolution¶
type RequiredConversationResolution struct {Enabledbool `json:"enabled"`}
RequiredConversationResolution, if enabled, requires all comments on the pull request to be resolved before it can be merged to a protected branch.
typeRequiredReviewer¶
type RequiredReviewer struct {Type *string `json:"type,omitempty"`Reviewer interface{} `json:"reviewer,omitempty"`}
RequiredReviewer represents a required reviewer.
func (*RequiredReviewer)GetType¶
func (r *RequiredReviewer) GetType()string
GetType returns the Type field if it's non-nil, zero value otherwise.
func (*RequiredReviewer)UnmarshalJSON¶
func (r *RequiredReviewer) UnmarshalJSON(data []byte)error
UnmarshalJSON implements the json.Unmarshaler interface.This helps us handle the fact that RequiredReviewer can have either a User or Team type reviewer field.
typeRequiredStatusCheck¶
type RequiredStatusCheck struct {// The name of the required check.Contextstring `json:"context"`// The ID of the GitHub App that must provide this check.// Omit this field to automatically select the GitHub App// that has recently provided this check,// or any app if it was not set by a GitHub App.// Pass -1 to explicitly allow any app to set the status.AppID *int64 `json:"app_id,omitempty"`}
RequiredStatusCheck represents a status check of a protected branch.
func (*RequiredStatusCheck)GetAppID¶
func (r *RequiredStatusCheck) GetAppID()int64
GetAppID returns the AppID field if it's non-nil, zero value otherwise.
typeRequiredStatusChecks¶
type RequiredStatusChecks struct {// Require branches to be up to date before merging. (Required.)Strictbool `json:"strict"`// The list of status checks to require in order to merge into this// branch. (Deprecated. Note: only one of Contexts/Checks can be populated,// but at least one must be populated).Contexts []string `json:"contexts,omitempty"`// The list of status checks to require in order to merge into this// branch.Checks []*RequiredStatusCheck `json:"checks,omitempty"`}
RequiredStatusChecks represents the protection status of a individual branch.
typeRequiredStatusChecksRequest¶
type RequiredStatusChecksRequest struct {Strict *bool `json:"strict,omitempty"`// Note: if both Contexts and Checks are populated,// the GitHub API will only use Checks.Contexts []string `json:"contexts,omitempty"`Checks []*RequiredStatusCheck `json:"checks,omitempty"`}
RequiredStatusChecksRequest represents a request to edit a protected branch's status checks.
func (*RequiredStatusChecksRequest)GetStrict¶
func (r *RequiredStatusChecksRequest) GetStrict()bool
GetStrict returns the Strict field if it's non-nil, zero value otherwise.
typeResponse¶
type Response struct {*http.Response// These fields provide the page values for paginating through a set of// results. Any or all of these may be set to the zero value for// responses that are not part of a paginated set, or for which there// are no additional pages.//// These fields support what is called "offset pagination" and should// be used with the ListOptions struct.NextPageintPrevPageintFirstPageintLastPageint// Additionally, some APIs support "cursor pagination" instead of offset.// This means that a token points directly to the next record which// can lead to O(1) performance compared to O(n) performance provided// by offset pagination.//// For APIs that support cursor pagination (such as// TeamsService.ListIDPGroupsInOrganization), the following field// will be populated to point to the next page.//// To use this token, set ListCursorOptions.Page to this value before// calling the endpoint again.NextPageTokenstring// For APIs that support cursor pagination, such as RepositoriesService.ListHookDeliveries,// the following field will be populated to point to the next page.// Set ListCursorOptions.Cursor to this value when calling the endpoint again.Cursorstring// For APIs that support before/after pagination, such as OrganizationsService.AuditLog.BeforestringAfterstring// Explicitly specify the Rate type so Rate's String() receiver doesn't// propagate to Response.RateRate// token's expiration dateTokenExpirationTimestamp}
Response is a GitHub API response. This wraps the standard http.Responsereturned from GitHub and provides convenient access to things likepagination links.
typeReviewers¶
type Reviewers struct {Users []*User `json:"users,omitempty"`Teams []*Team `json:"teams,omitempty"`}
Reviewers represents reviewers of a pull request.
typeReviewersRequest¶
type ReviewersRequest struct {NodeID *string `json:"node_id,omitempty"`Reviewers []string `json:"reviewers,omitempty"`TeamReviewers []string `json:"team_reviewers,omitempty"`}
ReviewersRequest specifies users and teams for a pull request review request.
func (*ReviewersRequest)GetNodeID¶
func (r *ReviewersRequest) GetNodeID()string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
typeRule¶
type Rule struct {ID *string `json:"id,omitempty"`Severity *string `json:"severity,omitempty"`Description *string `json:"description,omitempty"`Name *string `json:"name,omitempty"`SecuritySeverityLevel *string `json:"security_severity_level,omitempty"`FullDescription *string `json:"full_description,omitempty"`Tags []string `json:"tags,omitempty"`Help *string `json:"help,omitempty"`}
Rule represents the complete details of GitHub Code Scanning alert type.
func (*Rule)GetDescription¶
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (*Rule)GetFullDescription¶
GetFullDescription returns the FullDescription field if it's non-nil, zero value otherwise.
func (*Rule)GetSecuritySeverityLevel¶
GetSecuritySeverityLevel returns the SecuritySeverityLevel field if it's non-nil, zero value otherwise.
func (*Rule)GetSeverity¶
GetSeverity returns the Severity field if it's non-nil, zero value otherwise.
typeRunner¶
type Runner struct {ID *int64 `json:"id,omitempty"`Name *string `json:"name,omitempty"`OS *string `json:"os,omitempty"`Status *string `json:"status,omitempty"`Busy *bool `json:"busy,omitempty"`Labels []*RunnerLabels `json:"labels,omitempty"`}
Runner represents a self-hosted runner registered with a repository.
typeRunnerApplicationDownload¶
type RunnerApplicationDownload struct {OS *string `json:"os,omitempty"`Architecture *string `json:"architecture,omitempty"`DownloadURL *string `json:"download_url,omitempty"`Filename *string `json:"filename,omitempty"`TempDownloadToken *string `json:"temp_download_token,omitempty"`SHA256Checksum *string `json:"sha256_checksum,omitempty"`}
RunnerApplicationDownload represents a binary for the self-hosted runner application that can be downloaded.
func (*RunnerApplicationDownload)GetArchitecture¶
func (r *RunnerApplicationDownload) GetArchitecture()string
GetArchitecture returns the Architecture field if it's non-nil, zero value otherwise.
func (*RunnerApplicationDownload)GetDownloadURL¶
func (r *RunnerApplicationDownload) GetDownloadURL()string
GetDownloadURL returns the DownloadURL field if it's non-nil, zero value otherwise.
func (*RunnerApplicationDownload)GetFilename¶
func (r *RunnerApplicationDownload) GetFilename()string
GetFilename returns the Filename field if it's non-nil, zero value otherwise.
func (*RunnerApplicationDownload)GetOS¶
func (r *RunnerApplicationDownload) GetOS()string
GetOS returns the OS field if it's non-nil, zero value otherwise.
func (*RunnerApplicationDownload)GetSHA256Checksum¶
func (r *RunnerApplicationDownload) GetSHA256Checksum()string
GetSHA256Checksum returns the SHA256Checksum field if it's non-nil, zero value otherwise.
func (*RunnerApplicationDownload)GetTempDownloadToken¶
func (r *RunnerApplicationDownload) GetTempDownloadToken()string
GetTempDownloadToken returns the TempDownloadToken field if it's non-nil, zero value otherwise.
typeRunnerGroup¶
type RunnerGroup struct {ID *int64 `json:"id,omitempty"`Name *string `json:"name,omitempty"`Visibility *string `json:"visibility,omitempty"`Default *bool `json:"default,omitempty"`SelectedRepositoriesURL *string `json:"selected_repositories_url,omitempty"`RunnersURL *string `json:"runners_url,omitempty"`Inherited *bool `json:"inherited,omitempty"`AllowsPublicRepositories *bool `json:"allows_public_repositories,omitempty"`}
RunnerGroup represents a self-hosted runner group configured in an organization.
func (*RunnerGroup)GetAllowsPublicRepositories¶
func (r *RunnerGroup) GetAllowsPublicRepositories()bool
GetAllowsPublicRepositories returns the AllowsPublicRepositories field if it's non-nil, zero value otherwise.
func (*RunnerGroup)GetDefault¶
func (r *RunnerGroup) GetDefault()bool
GetDefault returns the Default field if it's non-nil, zero value otherwise.
func (*RunnerGroup)GetID¶
func (r *RunnerGroup) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*RunnerGroup)GetInherited¶
func (r *RunnerGroup) GetInherited()bool
GetInherited returns the Inherited field if it's non-nil, zero value otherwise.
func (*RunnerGroup)GetName¶
func (r *RunnerGroup) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*RunnerGroup)GetRunnersURL¶
func (r *RunnerGroup) GetRunnersURL()string
GetRunnersURL returns the RunnersURL field if it's non-nil, zero value otherwise.
func (*RunnerGroup)GetSelectedRepositoriesURL¶
func (r *RunnerGroup) GetSelectedRepositoriesURL()string
GetSelectedRepositoriesURL returns the SelectedRepositoriesURL field if it's non-nil, zero value otherwise.
func (*RunnerGroup)GetVisibility¶
func (r *RunnerGroup) GetVisibility()string
GetVisibility returns the Visibility field if it's non-nil, zero value otherwise.
typeRunnerGroups¶
type RunnerGroups struct {TotalCountint `json:"total_count"`RunnerGroups []*RunnerGroup `json:"runner_groups"`}
RunnerGroups represents a collection of self-hosted runner groups configured for an organization.
typeRunnerLabels¶
type RunnerLabels struct {ID *int64 `json:"id,omitempty"`Name *string `json:"name,omitempty"`Type *string `json:"type,omitempty"`}
RunnerLabels represents a collection of labels attached to each runner.
func (*RunnerLabels)GetID¶
func (r *RunnerLabels) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*RunnerLabels)GetName¶
func (r *RunnerLabels) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*RunnerLabels)GetType¶
func (r *RunnerLabels) GetType()string
GetType returns the Type field if it's non-nil, zero value otherwise.
typeSCIMService¶
type SCIMService service
SCIMService provides access to SCIM related functions in theGitHub API.
GitHub API docs:https://docs.github.com/en/rest/reference/scim
func (*SCIMService)DeleteSCIMUserFromOrg¶
func (s *SCIMService) DeleteSCIMUserFromOrg(ctxcontext.Context, org, scimUserIDstring) (*Response,error)
DeleteSCIMUserFromOrg deletes SCIM user from an organization.
GitHub API docs:https://docs.github.com/en/rest/reference/scim#delete-a-scim-user-from-an-organization
func (*SCIMService)GetSCIMProvisioningInfoForUser¶
func (s *SCIMService) GetSCIMProvisioningInfoForUser(ctxcontext.Context, org, scimUserIDstring) (*Response,error)
GetSCIMProvisioningInfoForUser returns SCIM provisioning information for a user.
GitHub API docs:https://docs.github.com/en/rest/reference/scim#get-scim-provisioning-information-for-a-user
func (*SCIMService)ListSCIMProvisionedIdentities¶
func (s *SCIMService) ListSCIMProvisionedIdentities(ctxcontext.Context, orgstring, opts *ListSCIMProvisionedIdentitiesOptions) (*Response,error)
ListSCIMProvisionedIdentities lists SCIM provisioned identities.
GitHub API docs:https://docs.github.com/en/rest/reference/scim#list-scim-provisioned-identities
func (*SCIMService)ProvisionAndInviteSCIMUser¶
func (s *SCIMService) ProvisionAndInviteSCIMUser(ctxcontext.Context, orgstring, opts *SCIMUserAttributes) (*Response,error)
ProvisionAndInviteSCIMUser provisions organization membership for a user, and sends an activation email to the email address.
GitHub API docs:https://docs.github.com/en/rest/reference/scim#provision-and-invite-a-scim-user
func (*SCIMService)UpdateAttributeForSCIMUser¶
func (s *SCIMService) UpdateAttributeForSCIMUser(ctxcontext.Context, org, scimUserIDstring, opts *UpdateAttributeForSCIMUserOptions) (*Response,error)
UpdateAttributeForSCIMUser updates an attribute for an SCIM user.
GitHub API docs:https://docs.github.com/en/rest/reference/scim#update-an-attribute-for-a-scim-user
func (*SCIMService)UpdateProvisionedOrgMembership¶
func (s *SCIMService) UpdateProvisionedOrgMembership(ctxcontext.Context, org, scimUserIDstring, opts *SCIMUserAttributes) (*Response,error)
UpdateProvisionedOrgMembership updates a provisioned organization membership.
GitHub API docs:https://docs.github.com/en/rest/reference/scim#update-a-provisioned-organization-membership
typeSCIMUserAttributes¶
type SCIMUserAttributes struct {UserNamestring `json:"userName"`// Configured by the admin. Could be an email, login, or username. (Required.)NameSCIMUserName `json:"name"`// (Required.)DisplayName *string `json:"displayName,omitempty"`// The name of the user, suitable for display to end-users. (Optional.)Emails []*SCIMUserEmail `json:"emails"`// User emails. (Required.)Schemas []string `json:"schemas,omitempty"`// (Optional.)ExternalID *string `json:"externalId,omitempty"`// (Optional.)Groups []string `json:"groups,omitempty"`// (Optional.)Active *bool `json:"active,omitempty"`// (Optional.)}
SCIMUserAttributes represents supported SCIM User attributes.
GitHub API docs:https://docs.github.com/en/rest/reference/scim#supported-scim-user-attributes
func (*SCIMUserAttributes)GetActive¶
func (s *SCIMUserAttributes) GetActive()bool
GetActive returns the Active field if it's non-nil, zero value otherwise.
func (*SCIMUserAttributes)GetDisplayName¶
func (s *SCIMUserAttributes) GetDisplayName()string
GetDisplayName returns the DisplayName field if it's non-nil, zero value otherwise.
func (*SCIMUserAttributes)GetExternalID¶
func (s *SCIMUserAttributes) GetExternalID()string
GetExternalID returns the ExternalID field if it's non-nil, zero value otherwise.
typeSCIMUserEmail¶
type SCIMUserEmail struct {Valuestring `json:"value"`// (Required.)Primary *bool `json:"primary,omitempty"`// (Optional.)Type *string `json:"type,omitempty"`// (Optional.)}
SCIMUserEmail represents SCIM user email.
func (*SCIMUserEmail)GetPrimary¶
func (s *SCIMUserEmail) GetPrimary()bool
GetPrimary returns the Primary field if it's non-nil, zero value otherwise.
func (*SCIMUserEmail)GetType¶
func (s *SCIMUserEmail) GetType()string
GetType returns the Type field if it's non-nil, zero value otherwise.
typeSCIMUserName¶
type SCIMUserName struct {GivenNamestring `json:"givenName"`// The first name of the user. (Required.)FamilyNamestring `json:"familyName"`// The family name of the user. (Required.)Formatted *string `json:"formatted,omitempty"`// (Optional.)}
SCIMUserName represents SCIM user information.
func (*SCIMUserName)GetFormatted¶
func (s *SCIMUserName) GetFormatted()string
GetFormatted returns the Formatted field if it's non-nil, zero value otherwise.
typeSarifAnalysis¶
type SarifAnalysis struct {CommitSHA *string `json:"commit_sha,omitempty"`Ref *string `json:"ref,omitempty"`Sarif *string `json:"sarif,omitempty"`CheckoutURI *string `json:"checkout_uri,omitempty"`StartedAt *Timestamp `json:"started_at,omitempty"`ToolName *string `json:"tool_name,omitempty"`}
SarifAnalysis specifies the results of a code scanning job.
GitHub API docs:https://docs.github.com/en/rest/reference/code-scanning#upload-an-analysis-as-sarif-data
func (*SarifAnalysis)GetCheckoutURI¶
func (s *SarifAnalysis) GetCheckoutURI()string
GetCheckoutURI returns the CheckoutURI field if it's non-nil, zero value otherwise.
func (*SarifAnalysis)GetCommitSHA¶
func (s *SarifAnalysis) GetCommitSHA()string
GetCommitSHA returns the CommitSHA field if it's non-nil, zero value otherwise.
func (*SarifAnalysis)GetRef¶
func (s *SarifAnalysis) GetRef()string
GetRef returns the Ref field if it's non-nil, zero value otherwise.
func (*SarifAnalysis)GetSarif¶
func (s *SarifAnalysis) GetSarif()string
GetSarif returns the Sarif field if it's non-nil, zero value otherwise.
func (*SarifAnalysis)GetStartedAt¶
func (s *SarifAnalysis) GetStartedAt()Timestamp
GetStartedAt returns the StartedAt field if it's non-nil, zero value otherwise.
func (*SarifAnalysis)GetToolName¶
func (s *SarifAnalysis) GetToolName()string
GetToolName returns the ToolName field if it's non-nil, zero value otherwise.
typeSarifID¶
SarifID identifies a sarif analysis upload.
GitHub API docs:https://docs.github.com/en/rest/reference/code-scanning#upload-an-analysis-as-sarif-data
typeScanningAnalysis¶
type ScanningAnalysis struct {ID *int64 `json:"id,omitempty"`Ref *string `json:"ref,omitempty"`CommitSHA *string `json:"commit_sha,omitempty"`AnalysisKey *string `json:"analysis_key,omitempty"`Environment *string `json:"environment,omitempty"`Error *string `json:"error,omitempty"`Category *string `json:"category,omitempty"`CreatedAt *Timestamp `json:"created_at,omitempty"`ResultsCount *int `json:"results_count,omitempty"`RulesCount *int `json:"rules_count,omitempty"`URL *string `json:"url,omitempty"`SarifID *string `json:"sarif_id,omitempty"`Tool *Tool `json:"tool,omitempty"`Deletable *bool `json:"deletable,omitempty"`Warning *string `json:"warning,omitempty"`}
ScanningAnalysis represents an individual GitHub Code Scanning ScanningAnalysis on a single repository.
GitHub API docs:https://docs.github.com/en/rest/reference/code-scanning#list-code-scanning-analyses-for-a-repository
func (*ScanningAnalysis)GetAnalysisKey¶
func (s *ScanningAnalysis) GetAnalysisKey()string
GetAnalysisKey returns the AnalysisKey field if it's non-nil, zero value otherwise.
func (*ScanningAnalysis)GetCategory¶
func (s *ScanningAnalysis) GetCategory()string
GetCategory returns the Category field if it's non-nil, zero value otherwise.
func (*ScanningAnalysis)GetCommitSHA¶
func (s *ScanningAnalysis) GetCommitSHA()string
GetCommitSHA returns the CommitSHA field if it's non-nil, zero value otherwise.
func (*ScanningAnalysis)GetCreatedAt¶
func (s *ScanningAnalysis) GetCreatedAt()Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*ScanningAnalysis)GetDeletable¶
func (s *ScanningAnalysis) GetDeletable()bool
GetDeletable returns the Deletable field if it's non-nil, zero value otherwise.
func (*ScanningAnalysis)GetEnvironment¶
func (s *ScanningAnalysis) GetEnvironment()string
GetEnvironment returns the Environment field if it's non-nil, zero value otherwise.
func (*ScanningAnalysis)GetError¶
func (s *ScanningAnalysis) GetError()string
GetError returns the Error field if it's non-nil, zero value otherwise.
func (*ScanningAnalysis)GetID¶
func (s *ScanningAnalysis) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*ScanningAnalysis)GetRef¶
func (s *ScanningAnalysis) GetRef()string
GetRef returns the Ref field if it's non-nil, zero value otherwise.
func (*ScanningAnalysis)GetResultsCount¶
func (s *ScanningAnalysis) GetResultsCount()int
GetResultsCount returns the ResultsCount field if it's non-nil, zero value otherwise.
func (*ScanningAnalysis)GetRulesCount¶
func (s *ScanningAnalysis) GetRulesCount()int
GetRulesCount returns the RulesCount field if it's non-nil, zero value otherwise.
func (*ScanningAnalysis)GetSarifID¶
func (s *ScanningAnalysis) GetSarifID()string
GetSarifID returns the SarifID field if it's non-nil, zero value otherwise.
func (*ScanningAnalysis)GetTool¶
func (s *ScanningAnalysis) GetTool() *Tool
GetTool returns the Tool field.
func (*ScanningAnalysis)GetURL¶
func (s *ScanningAnalysis) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (*ScanningAnalysis)GetWarning¶
func (s *ScanningAnalysis) GetWarning()string
GetWarning returns the Warning field if it's non-nil, zero value otherwise.
typeScope¶
type Scopestring
Scope models a GitHub authorization scope.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/oauth/#scopes
const (ScopeNoneScope = "(no scope)"// REVISIT: is this actually returned, or just a documentation artifact?ScopeUserScope = "user"ScopeUserEmailScope = "user:email"ScopeUserFollowScope = "user:follow"ScopePublicRepoScope = "public_repo"ScopeRepoScope = "repo"ScopeRepoDeploymentScope = "repo_deployment"ScopeRepoStatusScope = "repo:status"ScopeDeleteRepoScope = "delete_repo"ScopeNotificationsScope = "notifications"ScopeGistScope = "gist"ScopeReadRepoHookScope = "read:repo_hook"ScopeWriteRepoHookScope = "write:repo_hook"ScopeAdminRepoHookScope = "admin:repo_hook"ScopeAdminOrgHookScope = "admin:org_hook"ScopeReadOrgScope = "read:org"ScopeWriteOrgScope = "write:org"ScopeAdminOrgScope = "admin:org"ScopeReadPublicKeyScope = "read:public_key"ScopeWritePublicKeyScope = "write:public_key"ScopeAdminPublicKeyScope = "admin:public_key"ScopeReadGPGKeyScope = "read:gpg_key"ScopeWriteGPGKeyScope = "write:gpg_key"ScopeAdminGPGKeyScope = "admin:gpg_key"ScopeSecurityEventsScope = "security_events")
This is the set of scopes for GitHub API V3
typeSearchOptions¶
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.Sortstring `url:"sort,omitempty"`// Sort order if sort parameter is provided. Possible values are: asc,// desc. Default is desc.Orderstring `url:"order,omitempty"`// Whether to retrieve text match metadata with a queryTextMatchbool `url:"-"`ListOptions}
SearchOptions specifies optional parameters to the SearchService methods.
typeSearchService¶
type SearchService service
SearchService provides access to the search related functionsin 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 searchfor 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).
If query includes multiple conditions, it MUST NOT include "+" as the condition separator.You have to use " " as the separator instead.For example, querying with "language:c++" and "leveldb", then query should be"language:c++ leveldb" but not "language:c+++leveldb".
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/search/
func (*SearchService)Code¶
func (s *SearchService) Code(ctxcontext.Context, querystring, opts *SearchOptions) (*CodeSearchResult, *Response,error)
Code searches code via various criteria.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/search/#search-code
func (*SearchService)Commits¶
func (s *SearchService) Commits(ctxcontext.Context, querystring, opts *SearchOptions) (*CommitsSearchResult, *Response,error)
Commits searches commits via various criteria.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/search/#search-commits
func (*SearchService)Issues¶
func (s *SearchService) Issues(ctxcontext.Context, querystring, opts *SearchOptions) (*IssuesSearchResult, *Response,error)
Issues searches issues via various criteria.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/search/#search-issues-and-pull-requests
func (*SearchService)Labels¶
func (s *SearchService) Labels(ctxcontext.Context, repoIDint64, querystring, opts *SearchOptions) (*LabelsSearchResult, *Response,error)
Labels searches labels in the repository with ID repoID via various criteria.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/search/#search-labels
func (*SearchService)Repositories¶
func (s *SearchService) Repositories(ctxcontext.Context, querystring, opts *SearchOptions) (*RepositoriesSearchResult, *Response,error)
Repositories searches repositories via various criteria.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/search/#search-repositories
func (*SearchService)Topics¶
func (s *SearchService) Topics(ctxcontext.Context, querystring, opts *SearchOptions) (*TopicsSearchResult, *Response,error)
Topics finds topics via various criteria. Results are sorted by best match.Please seehttps://help.github.com/en/articles/searching-topics for moreinformation about search qualifiers.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/search/#search-topics
func (*SearchService)Users¶
func (s *SearchService) Users(ctxcontext.Context, querystring, opts *SearchOptions) (*UsersSearchResult, *Response,error)
Users searches users via various criteria.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/search/#search-users
typeSecret¶
type Secret struct {Namestring `json:"name"`CreatedAtTimestamp `json:"created_at"`UpdatedAtTimestamp `json:"updated_at"`Visibilitystring `json:"visibility,omitempty"`SelectedRepositoriesURLstring `json:"selected_repositories_url,omitempty"`}
Secret represents a repository action secret.
typeSecretScanning¶
type SecretScanning struct {Status *string `json:"status,omitempty"`}
SecretScanning specifies the state of secret scanning on a repository.
GitHub API docs:https://docs.github.com/en/code-security/secret-security/about-secret-scanning
func (*SecretScanning)GetStatus¶
func (s *SecretScanning) GetStatus()string
GetStatus returns the Status field if it's non-nil, zero value otherwise.
func (SecretScanning)String¶
func (sSecretScanning) String()string
typeSecretScanningAlert¶
type SecretScanningAlert struct {Number *int `json:"number,omitempty"`CreatedAt *Timestamp `json:"created_at,omitempty"`URL *string `json:"url,omitempty"`HTMLURL *string `json:"html_url,omitempty"`LocationsURL *string `json:"locations_url,omitempty"`State *string `json:"state,omitempty"`Resolution *string `json:"resolution,omitempty"`ResolvedAt *Timestamp `json:"resolved_at,omitempty"`ResolvedBy *User `json:"resolved_by,omitempty"`SecretType *string `json:"secret_type,omitempty"`Secret *string `json:"secret,omitempty"`}
SecretScanningAlert represents a GitHub secret scanning alert.
func (*SecretScanningAlert)GetCreatedAt¶
func (s *SecretScanningAlert) GetCreatedAt()Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*SecretScanningAlert)GetHTMLURL¶
func (s *SecretScanningAlert) GetHTMLURL()string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*SecretScanningAlert)GetLocationsURL¶
func (s *SecretScanningAlert) GetLocationsURL()string
GetLocationsURL returns the LocationsURL field if it's non-nil, zero value otherwise.
func (*SecretScanningAlert)GetNumber¶
func (s *SecretScanningAlert) GetNumber()int
GetNumber returns the Number field if it's non-nil, zero value otherwise.
func (*SecretScanningAlert)GetResolution¶
func (s *SecretScanningAlert) GetResolution()string
GetResolution returns the Resolution field if it's non-nil, zero value otherwise.
func (*SecretScanningAlert)GetResolvedAt¶
func (s *SecretScanningAlert) GetResolvedAt()Timestamp
GetResolvedAt returns the ResolvedAt field if it's non-nil, zero value otherwise.
func (*SecretScanningAlert)GetResolvedBy¶
func (s *SecretScanningAlert) GetResolvedBy() *User
GetResolvedBy returns the ResolvedBy field.
func (*SecretScanningAlert)GetSecret¶
func (s *SecretScanningAlert) GetSecret()string
GetSecret returns the Secret field if it's non-nil, zero value otherwise.
func (*SecretScanningAlert)GetSecretType¶
func (s *SecretScanningAlert) GetSecretType()string
GetSecretType returns the SecretType field if it's non-nil, zero value otherwise.
func (*SecretScanningAlert)GetState¶
func (s *SecretScanningAlert) GetState()string
GetState returns the State field if it's non-nil, zero value otherwise.
func (*SecretScanningAlert)GetURL¶
func (s *SecretScanningAlert) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
typeSecretScanningAlertEvent¶
type SecretScanningAlertEvent struct {// Action is the action that was performed. Possible values are: "created", "resolved", or "reopened".Action *string `json:"action,omitempty"`// Alert is the secret scanning alert involved in the event.Alert *SecretScanningAlert `json:"alert,omitempty"`// Only populated by the "resolved" and "reopen" actionsSender *User `json:"sender,omitempty"`// The following fields are only populated by Webhook events.Repo *Repository `json:"repository,omitempty"`Organization *Organization `json:"organization,omitempty"`Enterprise *Enterprise `json:"enterprise,omitempty"`Installation *Installation `json:"installation,omitempty"`}
SecretScanningAlertEvent is triggered when a secret scanning alert occurs in a repository.The Webhook name is secret_scanning_alert.
GitHub API docs:https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#secret_scanning_alert
func (*SecretScanningAlertEvent)GetAction¶
func (s *SecretScanningAlertEvent) GetAction()string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*SecretScanningAlertEvent)GetAlert¶
func (s *SecretScanningAlertEvent) GetAlert() *SecretScanningAlert
GetAlert returns the Alert field.
func (*SecretScanningAlertEvent)GetEnterprise¶
func (s *SecretScanningAlertEvent) GetEnterprise() *Enterprise
GetEnterprise returns the Enterprise field.
func (*SecretScanningAlertEvent)GetInstallation¶
func (s *SecretScanningAlertEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*SecretScanningAlertEvent)GetOrganization¶
func (s *SecretScanningAlertEvent) GetOrganization() *Organization
GetOrganization returns the Organization field.
func (*SecretScanningAlertEvent)GetRepo¶
func (s *SecretScanningAlertEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (*SecretScanningAlertEvent)GetSender¶
func (s *SecretScanningAlertEvent) GetSender() *User
GetSender returns the Sender field.
typeSecretScanningAlertListOptions¶
type SecretScanningAlertListOptions struct {// State of the secret scanning alerts to list. Set to open or resolved to only list secret scanning alerts in a specific state.Statestring `url:"state,omitempty"`// A comma-separated list of secret types to return. By default all secret types are returned.SecretTypestring `url:"secret_type,omitempty"`// A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed.// Valid resolutions are false_positive, wont_fix, revoked, pattern_edited, pattern_deleted or used_in_tests.Resolutionstring `url:"resolution,omitempty"`ListCursorOptions}
SecretScanningAlertListOptions specifies optional parameters to the SecretScanningService.ListAlertsForEnterprise method.
typeSecretScanningAlertLocation¶
type SecretScanningAlertLocation struct {Type *string `json:"type,omitempty"`Details *SecretScanningAlertLocationDetails `json:"details,omitempty"`}
SecretScanningAlertLocation represents the location for a secret scanning alert.
func (*SecretScanningAlertLocation)GetDetails¶
func (s *SecretScanningAlertLocation) GetDetails() *SecretScanningAlertLocationDetails
GetDetails returns the Details field.
func (*SecretScanningAlertLocation)GetType¶
func (s *SecretScanningAlertLocation) GetType()string
GetType returns the Type field if it's non-nil, zero value otherwise.
typeSecretScanningAlertLocationDetails¶
type SecretScanningAlertLocationDetails struct {Path *string `json:"path,omitempty"`Startline *int `json:"start_line,omitempty"`EndLine *int `json:"end_line,omitempty"`StartColumn *int `json:"start_column,omitempty"`EndColumn *int `json:"end_column,omitempty"`BlobSHA *string `json:"blob_sha,omitempty"`BlobURL *string `json:"blob_url,omitempty"`CommitSHA *string `json:"commit_sha,omitempty"`CommitURL *string `json:"commit_url,omitempty"`}
SecretScanningAlertLocationDetails represents the location details for a secret scanning alert.
func (*SecretScanningAlertLocationDetails)GetBlobSHA¶
func (s *SecretScanningAlertLocationDetails) GetBlobSHA()string
GetBlobSHA returns the BlobSHA field if it's non-nil, zero value otherwise.
func (*SecretScanningAlertLocationDetails)GetBlobURL¶
func (s *SecretScanningAlertLocationDetails) GetBlobURL()string
GetBlobURL returns the BlobURL field if it's non-nil, zero value otherwise.
func (*SecretScanningAlertLocationDetails)GetCommitSHA¶
func (s *SecretScanningAlertLocationDetails) GetCommitSHA()string
GetCommitSHA returns the CommitSHA field if it's non-nil, zero value otherwise.
func (*SecretScanningAlertLocationDetails)GetCommitURL¶
func (s *SecretScanningAlertLocationDetails) GetCommitURL()string
GetCommitURL returns the CommitURL field if it's non-nil, zero value otherwise.
func (*SecretScanningAlertLocationDetails)GetEndColumn¶
func (s *SecretScanningAlertLocationDetails) GetEndColumn()int
GetEndColumn returns the EndColumn field if it's non-nil, zero value otherwise.
func (*SecretScanningAlertLocationDetails)GetEndLine¶
func (s *SecretScanningAlertLocationDetails) GetEndLine()int
GetEndLine returns the EndLine field if it's non-nil, zero value otherwise.
func (*SecretScanningAlertLocationDetails)GetPath¶
func (s *SecretScanningAlertLocationDetails) GetPath()string
GetPath returns the Path field if it's non-nil, zero value otherwise.
func (*SecretScanningAlertLocationDetails)GetStartColumn¶
func (s *SecretScanningAlertLocationDetails) GetStartColumn()int
GetStartColumn returns the StartColumn field if it's non-nil, zero value otherwise.
func (*SecretScanningAlertLocationDetails)GetStartline¶
func (s *SecretScanningAlertLocationDetails) GetStartline()int
GetStartline returns the Startline field if it's non-nil, zero value otherwise.
typeSecretScanningAlertUpdateOptions¶
type SecretScanningAlertUpdateOptions struct {// Required. Sets the state of the secret scanning alert. Can be either open or resolved.// You must provide resolution when you set the state to resolved.State *string `url:"state,omitempty"`// A comma-separated list of secret types to return. By default all secret types are returned.SecretType *string `url:"secret_type,omitempty"`// Required when the state is resolved. The reason for resolving the alert. Can be one of false_positive,// wont_fix, revoked, or used_in_tests.Resolution *string `url:"resolution,omitempty"`}
SecretScanningAlertUpdateOptions specifies optional parameters to the SecretScanningService.UpdateAlert method.
func (*SecretScanningAlertUpdateOptions)GetResolution¶
func (s *SecretScanningAlertUpdateOptions) GetResolution()string
GetResolution returns the Resolution field if it's non-nil, zero value otherwise.
func (*SecretScanningAlertUpdateOptions)GetSecretType¶
func (s *SecretScanningAlertUpdateOptions) GetSecretType()string
GetSecretType returns the SecretType field if it's non-nil, zero value otherwise.
func (*SecretScanningAlertUpdateOptions)GetState¶
func (s *SecretScanningAlertUpdateOptions) GetState()string
GetState returns the State field if it's non-nil, zero value otherwise.
typeSecretScanningService¶
type SecretScanningService service
SecretScanningService handles communication with the secret scanning relatedmethods of the GitHub API.
GitHub API docs:https://docs.github.com/en/rest/reference/secret-scanning
func (*SecretScanningService)GetAlert¶
func (s *SecretScanningService) GetAlert(ctxcontext.Context, owner, repostring, numberint64) (*SecretScanningAlert, *Response,error)
Gets a single secret scanning alert detected in a private repository.
To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token withthe repo scope or security_events scope.
GitHub API docs:https://docs.github.com/en/rest/reference/secret-scanning#get-a-secret-scanning-alert
func (*SecretScanningService)ListAlertsForEnterprise¶
func (s *SecretScanningService) ListAlertsForEnterprise(ctxcontext.Context, enterprisestring, opts *SecretScanningAlertListOptions) ([]*SecretScanningAlert, *Response,error)
Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.
To use this endpoint, you must be a member of the enterprise, and you must use an access token with the repo scope orsecurity_events scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager.
GitHub API docs:https://docs.github.com/en/rest/reference/secret-scanning#list-secret-scanning-alerts-for-an-enterprise
func (*SecretScanningService)ListAlertsForOrg¶
func (s *SecretScanningService) ListAlertsForOrg(ctxcontext.Context, orgstring, opts *SecretScanningAlertListOptions) ([]*SecretScanningAlert, *Response,error)
Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.
To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token withthe repo scope or security_events scope.
GitHub API docs:https://docs.github.com/en/rest/reference/secret-scanning#list-secret-scanning-alerts-for-an-organization
func (*SecretScanningService)ListAlertsForRepo¶
func (s *SecretScanningService) ListAlertsForRepo(ctxcontext.Context, owner, repostring, opts *SecretScanningAlertListOptions) ([]*SecretScanningAlert, *Response,error)
Lists secret scanning alerts for a private repository, from newest to oldest.
To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token withthe repo scope or security_events scope.
GitHub API docs:https://docs.github.com/en/rest/reference/secret-scanning#list-secret-scanning-alerts-for-a-repository
func (*SecretScanningService)ListLocationsForAlert¶
func (s *SecretScanningService) ListLocationsForAlert(ctxcontext.Context, owner, repostring, numberint64, opts *ListOptions) ([]*SecretScanningAlertLocation, *Response,error)
Lists all locations for a given secret scanning alert for a private repository.
To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token withthe repo scope or security_events scope.
GitHub API docs:https://docs.github.com/en/rest/reference/secret-scanning#list-locations-for-a-secret-scanning-alert
func (*SecretScanningService)UpdateAlert¶
func (s *SecretScanningService) UpdateAlert(ctxcontext.Context, owner, repostring, numberint64, opts *SecretScanningAlertUpdateOptions) (*SecretScanningAlert, *Response,error)
Updates the status of a secret scanning alert in a private repository.
To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token withthe repo scope or security_events scope.
GitHub API docs:https://docs.github.com/en/rest/reference/secret-scanning#update-a-secret-scanning-alert
typeSecurityAndAnalysis¶
type SecurityAndAnalysis struct {AdvancedSecurity *AdvancedSecurity `json:"advanced_security,omitempty"`SecretScanning *SecretScanning `json:"secret_scanning,omitempty"`}
SecurityAndAnalysis specifies the optional advanced security featuresthat are enabled on a given repository.
func (*SecurityAndAnalysis)GetAdvancedSecurity¶
func (s *SecurityAndAnalysis) GetAdvancedSecurity() *AdvancedSecurity
GetAdvancedSecurity returns the AdvancedSecurity field.
func (*SecurityAndAnalysis)GetSecretScanning¶
func (s *SecurityAndAnalysis) GetSecretScanning() *SecretScanning
GetSecretScanning returns the SecretScanning field.
func (SecurityAndAnalysis)String¶
func (sSecurityAndAnalysis) String()string
typeSelectedRepoIDs¶
type SelectedRepoIDs []int64
SelectedRepoIDs are the repository IDs that have access to the secret.
typeSelectedReposList¶
type SelectedReposList struct {TotalCount *int `json:"total_count,omitempty"`Repositories []*Repository `json:"repositories,omitempty"`}
SelectedReposList represents the list of repositories selected for an organization secret.
func (*SelectedReposList)GetTotalCount¶
func (s *SelectedReposList) GetTotalCount()int
GetTotalCount returns the TotalCount field if it's non-nil, zero value otherwise.
typeServiceHook¶
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 ofavailable events, and default events.
func (*ServiceHook)GetName¶
func (s *ServiceHook) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*ServiceHook)String¶
func (s *ServiceHook) String()string
typeSetRepoAccessRunnerGroupRequest¶
type SetRepoAccessRunnerGroupRequest struct {// Updated list of repository IDs that should be given access to the runner group.SelectedRepositoryIDs []int64 `json:"selected_repository_ids"`}
SetRepoAccessRunnerGroupRequest represents a request to replace the list of repositoriesthat can access a self-hosted runner group configured in an organization.
typeSetRunnerGroupRunnersRequest¶
type SetRunnerGroupRunnersRequest struct {// Updated list of runner IDs that should be given access to the runner group.Runners []int64 `json:"runners"`}
SetRunnerGroupRunnersRequest represents a request to replace the list ofself-hosted runners that are part of an organization runner group.
typeSignatureVerification¶
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 (*SignatureVerification)GetPayload¶
func (s *SignatureVerification) GetPayload()string
GetPayload returns the Payload field if it's non-nil, zero value otherwise.
func (*SignatureVerification)GetReason¶
func (s *SignatureVerification) GetReason()string
GetReason returns the Reason field if it's non-nil, zero value otherwise.
func (*SignatureVerification)GetSignature¶
func (s *SignatureVerification) GetSignature()string
GetSignature returns the Signature field if it's non-nil, zero value otherwise.
func (*SignatureVerification)GetVerified¶
func (s *SignatureVerification) GetVerified()bool
GetVerified returns the Verified field if it's non-nil, zero value otherwise.
typeSignaturesProtectedBranch¶
type SignaturesProtectedBranch struct {URL *string `json:"url,omitempty"`// Commits pushed to matching branches must have verified signatures.Enabled *bool `json:"enabled,omitempty"`}
SignaturesProtectedBranch represents the protection status of an individual branch.
func (*SignaturesProtectedBranch)GetEnabled¶
func (s *SignaturesProtectedBranch) GetEnabled()bool
GetEnabled returns the Enabled field if it's non-nil, zero value otherwise.
func (*SignaturesProtectedBranch)GetURL¶
func (s *SignaturesProtectedBranch) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
typeSource¶
type Source struct {ID *int64 `json:"id,omitempty"`URL *string `json:"url,omitempty"`Actor *User `json:"actor,omitempty"`Type *string `json:"type,omitempty"`Issue *Issue `json:"issue,omitempty"`}
Source represents a reference's source.
typeSourceImportAuthor¶
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://docs.github.com/en/free-pro-team@latest/rest/reference/migration/source_imports/#get-commit-authors
func (*SourceImportAuthor)GetEmail¶
func (s *SourceImportAuthor) GetEmail()string
GetEmail returns the Email field if it's non-nil, zero value otherwise.
func (*SourceImportAuthor)GetID¶
func (s *SourceImportAuthor) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*SourceImportAuthor)GetImportURL¶
func (s *SourceImportAuthor) GetImportURL()string
GetImportURL returns the ImportURL field if it's non-nil, zero value otherwise.
func (*SourceImportAuthor)GetName¶
func (s *SourceImportAuthor) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*SourceImportAuthor)GetRemoteID¶
func (s *SourceImportAuthor) GetRemoteID()string
GetRemoteID returns the RemoteID field if it's non-nil, zero value otherwise.
func (*SourceImportAuthor)GetRemoteName¶
func (s *SourceImportAuthor) GetRemoteName()string
GetRemoteName returns the RemoteName field if it's non-nil, zero value otherwise.
func (*SourceImportAuthor)GetURL¶
func (s *SourceImportAuthor) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (SourceImportAuthor)String¶
func (aSourceImportAuthor) String()string
typeStarEvent¶
type StarEvent struct {// Action is the action that was performed. Possible values are: "created" or "deleted".Action *string `json:"action,omitempty"`// StarredAt is the time the star was created. It will be null for the "deleted" action.StarredAt *Timestamp `json:"starred_at,omitempty"`// The following fields are only populated by Webhook events.Org *Organization `json:"organization,omitempty"`Repo *Repository `json:"repository,omitempty"`Sender *User `json:"sender,omitempty"`Installation *Installation `json:"installation,omitempty"`}
StarEvent is triggered when a star is added or removed from a repository.The Webhook event name is "star".
GitHub API docs:https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#star
func (*StarEvent)GetAction¶
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*StarEvent)GetInstallation¶
func (s *StarEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*StarEvent)GetStarredAt¶
GetStarredAt returns the StarredAt field if it's non-nil, zero value otherwise.
typeStargazer¶
type Stargazer struct {StarredAt *Timestamp `json:"starred_at,omitempty"`User *User `json:"user,omitempty"`}
Stargazer represents a user that has starred a repository.
func (*Stargazer)GetStarredAt¶
GetStarredAt returns the StarredAt field if it's non-nil, zero value otherwise.
typeStarredRepository¶
type StarredRepository struct {StarredAt *Timestamp `json:"starred_at,omitempty"`Repository *Repository `json:"repo,omitempty"`}
StarredRepository is returned by ListStarred.
func (*StarredRepository)GetRepository¶
func (s *StarredRepository) GetRepository() *Repository
GetRepository returns the Repository field.
func (*StarredRepository)GetStarredAt¶
func (s *StarredRepository) GetStarredAt()Timestamp
GetStarredAt returns the StarredAt field if it's non-nil, zero value otherwise.
typeStatusEvent¶
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 totrigger hooks.
GitHub API docs:https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#status
func (*StatusEvent)GetCommit¶
func (s *StatusEvent) GetCommit() *RepositoryCommit
GetCommit returns the Commit field.
func (*StatusEvent)GetContext¶
func (s *StatusEvent) GetContext()string
GetContext returns the Context field if it's non-nil, zero value otherwise.
func (*StatusEvent)GetCreatedAt¶
func (s *StatusEvent) GetCreatedAt()Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*StatusEvent)GetDescription¶
func (s *StatusEvent) GetDescription()string
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (*StatusEvent)GetID¶
func (s *StatusEvent) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*StatusEvent)GetInstallation¶
func (s *StatusEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*StatusEvent)GetName¶
func (s *StatusEvent) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*StatusEvent)GetRepo¶
func (s *StatusEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (*StatusEvent)GetSHA¶
func (s *StatusEvent) GetSHA()string
GetSHA returns the SHA field if it's non-nil, zero value otherwise.
func (*StatusEvent)GetSender¶
func (s *StatusEvent) GetSender() *User
GetSender returns the Sender field.
func (*StatusEvent)GetState¶
func (s *StatusEvent) GetState()string
GetState returns the State field if it's non-nil, zero value otherwise.
func (*StatusEvent)GetTargetURL¶
func (s *StatusEvent) GetTargetURL()string
GetTargetURL returns the TargetURL field if it's non-nil, zero value otherwise.
func (*StatusEvent)GetUpdatedAt¶
func (s *StatusEvent) GetUpdatedAt()Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
typeStorageBilling¶
type StorageBilling struct {DaysLeftInBillingCycleint `json:"days_left_in_billing_cycle"`EstimatedPaidStorageForMonthfloat64 `json:"estimated_paid_storage_for_month"`EstimatedStorageForMonthint `json:"estimated_storage_for_month"`}
StorageBilling represents a GitHub Storage billing.
typeSubscription¶
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 subscriptionsRepositoryURL *string `json:"repository_url,omitempty"`// only populated for thread subscriptionsThreadURL *string `json:"thread_url,omitempty"`}
Subscription identifies a repository or thread subscription.
func (*Subscription)GetCreatedAt¶
func (s *Subscription) GetCreatedAt()Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*Subscription)GetIgnored¶
func (s *Subscription) GetIgnored()bool
GetIgnored returns the Ignored field if it's non-nil, zero value otherwise.
func (*Subscription)GetReason¶
func (s *Subscription) GetReason()string
GetReason returns the Reason field if it's non-nil, zero value otherwise.
func (*Subscription)GetRepositoryURL¶
func (s *Subscription) GetRepositoryURL()string
GetRepositoryURL returns the RepositoryURL field if it's non-nil, zero value otherwise.
func (*Subscription)GetSubscribed¶
func (s *Subscription) GetSubscribed()bool
GetSubscribed returns the Subscribed field if it's non-nil, zero value otherwise.
func (*Subscription)GetThreadURL¶
func (s *Subscription) GetThreadURL()string
GetThreadURL returns the ThreadURL field if it's non-nil, zero value otherwise.
func (*Subscription)GetURL¶
func (s *Subscription) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
typeTag¶
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 (*Tag)GetMessage¶
GetMessage returns the Message field if it's non-nil, zero value otherwise.
func (*Tag)GetVerification¶
func (t *Tag) GetVerification() *SignatureVerification
GetVerification returns the Verification field.
typeTaskStep¶
type TaskStep struct {Name *string `json:"name,omitempty"`Status *string `json:"status,omitempty"`Conclusion *string `json:"conclusion,omitempty"`Number *int64 `json:"number,omitempty"`StartedAt *Timestamp `json:"started_at,omitempty"`CompletedAt *Timestamp `json:"completed_at,omitempty"`}
TaskStep represents a single task step from a sequence of tasks of a job.
func (*TaskStep)GetCompletedAt¶
GetCompletedAt returns the CompletedAt field if it's non-nil, zero value otherwise.
func (*TaskStep)GetConclusion¶
GetConclusion returns the Conclusion field if it's non-nil, zero value otherwise.
func (*TaskStep)GetStartedAt¶
GetStartedAt returns the StartedAt field if it's non-nil, zero value otherwise.
typeTeam¶
type Team struct {ID *int64 `json:"id,omitempty"`NodeID *string `json:"node_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"`// Permissions identifies the permissions that a team has on a given// repository. This is only populated when calling Repositories.ListTeams.Permissions map[string]bool `json:"permissions,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"`HTMLURL *string `json:"html_url,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 tomanage access to an organization's repositories.
func (*Team)GetDescription¶
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (*Team)GetHTMLURL¶
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*Team)GetMembersCount¶
GetMembersCount returns the MembersCount field if it's non-nil, zero value otherwise.
func (*Team)GetMembersURL¶
GetMembersURL returns the MembersURL field if it's non-nil, zero value otherwise.
func (*Team)GetOrganization¶
func (t *Team) GetOrganization() *Organization
GetOrganization returns the Organization field.
func (*Team)GetPermission¶
GetPermission returns the Permission field if it's non-nil, zero value otherwise.
func (*Team)GetPermissions¶
GetPermissions returns the Permissions map if it's non-nil, an empty map otherwise.
func (*Team)GetPrivacy¶
GetPrivacy returns the Privacy field if it's non-nil, zero value otherwise.
func (*Team)GetReposCount¶
GetReposCount returns the ReposCount field if it's non-nil, zero value otherwise.
func (*Team)GetRepositoriesURL¶
GetRepositoriesURL returns the RepositoriesURL field if it's non-nil, zero value otherwise.
typeTeamAddEvent¶
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 usedto trigger hooks.
GitHub API docs:https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#team_add
func (*TeamAddEvent)GetInstallation¶
func (t *TeamAddEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*TeamAddEvent)GetOrg¶
func (t *TeamAddEvent) GetOrg() *Organization
GetOrg returns the Org field.
func (*TeamAddEvent)GetRepo¶
func (t *TeamAddEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (*TeamAddEvent)GetSender¶
func (t *TeamAddEvent) GetSender() *User
GetSender returns the Sender field.
typeTeamAddTeamMembershipOptions¶
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".Rolestring `json:"role,omitempty"`}
TeamAddTeamMembershipOptions specifies the optionalparameters to the TeamsService.AddTeamMembership method.
typeTeamAddTeamRepoOptions¶
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// maintain - team members can manage the repository without access to sensitive or destructive actions.// triage - team members can proactively manage issues and pull requests without write access.//// If not specified, the team's permission attribute will be used.Permissionstring `json:"permission,omitempty"`}
TeamAddTeamRepoOptions specifies the optional parameters to theTeamsService.AddTeamRepo method.
typeTeamChange¶
type TeamChange struct {Description *TeamDescription `json:"description,omitempty"`Name *TeamName `json:"name,omitempty"`Privacy *TeamPrivacy `json:"privacy,omitempty"`Repository *TeamRepository `json:"repository,omitempty"`}
TeamChange represents the changes when a team has been edited.
func (*TeamChange)GetDescription¶
func (t *TeamChange) GetDescription() *TeamDescription
GetDescription returns the Description field.
func (*TeamChange)GetPrivacy¶
func (t *TeamChange) GetPrivacy() *TeamPrivacy
GetPrivacy returns the Privacy field.
func (*TeamChange)GetRepository¶
func (t *TeamChange) GetRepository() *TeamRepository
GetRepository returns the Repository field.
typeTeamDescription¶
type TeamDescription struct {From *string `json:"from,omitempty"`}
TeamDescription represents a team description change.
func (*TeamDescription)GetFrom¶
func (t *TeamDescription) GetFrom()string
GetFrom returns the From field if it's non-nil, zero value otherwise.
typeTeamDiscussion¶
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"`Reactions *Reactions `json:"reactions,omitempty"`}
TeamDiscussion represents a GitHub dicussion in a team.
func (*TeamDiscussion)GetAuthor¶
func (t *TeamDiscussion) GetAuthor() *User
GetAuthor returns the Author field.
func (*TeamDiscussion)GetBody¶
func (t *TeamDiscussion) GetBody()string
GetBody returns the Body field if it's non-nil, zero value otherwise.
func (*TeamDiscussion)GetBodyHTML¶
func (t *TeamDiscussion) GetBodyHTML()string
GetBodyHTML returns the BodyHTML field if it's non-nil, zero value otherwise.
func (*TeamDiscussion)GetBodyVersion¶
func (t *TeamDiscussion) GetBodyVersion()string
GetBodyVersion returns the BodyVersion field if it's non-nil, zero value otherwise.
func (*TeamDiscussion)GetCommentsCount¶
func (t *TeamDiscussion) GetCommentsCount()int
GetCommentsCount returns the CommentsCount field if it's non-nil, zero value otherwise.
func (*TeamDiscussion)GetCommentsURL¶
func (t *TeamDiscussion) GetCommentsURL()string
GetCommentsURL returns the CommentsURL field if it's non-nil, zero value otherwise.
func (*TeamDiscussion)GetCreatedAt¶
func (t *TeamDiscussion) GetCreatedAt()Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*TeamDiscussion)GetHTMLURL¶
func (t *TeamDiscussion) GetHTMLURL()string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*TeamDiscussion)GetLastEditedAt¶
func (t *TeamDiscussion) GetLastEditedAt()Timestamp
GetLastEditedAt returns the LastEditedAt field if it's non-nil, zero value otherwise.
func (*TeamDiscussion)GetNodeID¶
func (t *TeamDiscussion) GetNodeID()string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (*TeamDiscussion)GetNumber¶
func (t *TeamDiscussion) GetNumber()int
GetNumber returns the Number field if it's non-nil, zero value otherwise.
func (*TeamDiscussion)GetPinned¶
func (t *TeamDiscussion) GetPinned()bool
GetPinned returns the Pinned field if it's non-nil, zero value otherwise.
func (*TeamDiscussion)GetPrivate¶
func (t *TeamDiscussion) GetPrivate()bool
GetPrivate returns the Private field if it's non-nil, zero value otherwise.
func (*TeamDiscussion)GetReactions¶
func (t *TeamDiscussion) GetReactions() *Reactions
GetReactions returns the Reactions field.
func (*TeamDiscussion)GetTeamURL¶
func (t *TeamDiscussion) GetTeamURL()string
GetTeamURL returns the TeamURL field if it's non-nil, zero value otherwise.
func (*TeamDiscussion)GetTitle¶
func (t *TeamDiscussion) GetTitle()string
GetTitle returns the Title field if it's non-nil, zero value otherwise.
func (*TeamDiscussion)GetURL¶
func (t *TeamDiscussion) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (*TeamDiscussion)GetUpdatedAt¶
func (t *TeamDiscussion) GetUpdatedAt()Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (TeamDiscussion)String¶
func (dTeamDiscussion) String()string
typeTeamEvent¶
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 usedto trigger hooks.
GitHub API docs:https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#team
func (*TeamEvent)GetAction¶
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*TeamEvent)GetChanges¶
func (t *TeamEvent) GetChanges() *TeamChange
GetChanges returns the Changes field.
func (*TeamEvent)GetInstallation¶
func (t *TeamEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
typeTeamLDAPMapping¶
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 (*TeamLDAPMapping)GetDescription¶
func (t *TeamLDAPMapping) GetDescription()string
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (*TeamLDAPMapping)GetID¶
func (t *TeamLDAPMapping) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*TeamLDAPMapping)GetLDAPDN¶
func (t *TeamLDAPMapping) GetLDAPDN()string
GetLDAPDN returns the LDAPDN field if it's non-nil, zero value otherwise.
func (*TeamLDAPMapping)GetMembersURL¶
func (t *TeamLDAPMapping) GetMembersURL()string
GetMembersURL returns the MembersURL field if it's non-nil, zero value otherwise.
func (*TeamLDAPMapping)GetName¶
func (t *TeamLDAPMapping) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*TeamLDAPMapping)GetPermission¶
func (t *TeamLDAPMapping) GetPermission()string
GetPermission returns the Permission field if it's non-nil, zero value otherwise.
func (*TeamLDAPMapping)GetPrivacy¶
func (t *TeamLDAPMapping) GetPrivacy()string
GetPrivacy returns the Privacy field if it's non-nil, zero value otherwise.
func (*TeamLDAPMapping)GetRepositoriesURL¶
func (t *TeamLDAPMapping) GetRepositoriesURL()string
GetRepositoriesURL returns the RepositoriesURL field if it's non-nil, zero value otherwise.
func (*TeamLDAPMapping)GetSlug¶
func (t *TeamLDAPMapping) GetSlug()string
GetSlug returns the Slug field if it's non-nil, zero value otherwise.
func (*TeamLDAPMapping)GetURL¶
func (t *TeamLDAPMapping) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (TeamLDAPMapping)String¶
func (mTeamLDAPMapping) String()string
typeTeamListTeamMembersOptions¶
type TeamListTeamMembersOptions struct {// Role filters members returned by their role in the team. Possible// values are "all", "member", "maintainer". Default is "all".Rolestring `url:"role,omitempty"`ListOptions}
TeamListTeamMembersOptions specifies the optional parameters to theTeamsService.ListTeamMembers method.
typeTeamName¶
type TeamName struct {From *string `json:"from,omitempty"`}
TeamName represents a team name change.
typeTeamPermissions¶
type TeamPermissions struct {From *TeamPermissionsFrom `json:"from,omitempty"`}
TeamPermissions represents a team permission change.
func (*TeamPermissions)GetFrom¶
func (t *TeamPermissions) GetFrom() *TeamPermissionsFrom
GetFrom returns the From field.
typeTeamPermissionsFrom¶
type TeamPermissionsFrom struct {Admin *bool `json:"admin,omitempty"`Pull *bool `json:"pull,omitempty"`Push *bool `json:"push,omitempty"`}
TeamPermissionsFrom represents a team permission change.
func (*TeamPermissionsFrom)GetAdmin¶
func (t *TeamPermissionsFrom) GetAdmin()bool
GetAdmin returns the Admin field if it's non-nil, zero value otherwise.
func (*TeamPermissionsFrom)GetPull¶
func (t *TeamPermissionsFrom) GetPull()bool
GetPull returns the Pull field if it's non-nil, zero value otherwise.
func (*TeamPermissionsFrom)GetPush¶
func (t *TeamPermissionsFrom) GetPush()bool
GetPush returns the Push field if it's non-nil, zero value otherwise.
typeTeamPrivacy¶
type TeamPrivacy struct {From *string `json:"from,omitempty"`}
TeamPrivacy represents a team privacy change.
func (*TeamPrivacy)GetFrom¶
func (t *TeamPrivacy) GetFrom()string
GetFrom returns the From field if it's non-nil, zero value otherwise.
typeTeamProjectOptions¶
type TeamProjectOptions struct {// Permission specifies the permission to grant to the team for this project.// Possible values are:// "read" - team members can read, but not write to or administer this project.// "write" - team members can read and write, but not administer this project.// "admin" - team members can read, write and administer this project.//Permission *string `json:"permission,omitempty"`}
TeamProjectOptions specifies the optional parameters to theTeamsService.AddTeamProject method.
func (*TeamProjectOptions)GetPermission¶
func (t *TeamProjectOptions) GetPermission()string
GetPermission returns the Permission field if it's non-nil, zero value otherwise.
typeTeamRepository¶
type TeamRepository struct {Permissions *TeamPermissions `json:"permissions,omitempty"`}
TeamRepository represents a team repository permission change.
func (*TeamRepository)GetPermissions¶
func (t *TeamRepository) GetPermissions() *TeamPermissions
GetPermissions returns the Permissions field.
typeTeamsService¶
type TeamsService service
TeamsService provides access to the team-related functionsin the GitHub API.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/
func (*TeamsService)AddTeamMembershipByID¶
func (s *TeamsService) AddTeamMembershipByID(ctxcontext.Context, orgID, teamIDint64, userstring, opts *TeamAddTeamMembershipOptions) (*Membership, *Response,error)
AddTeamMembershipByID adds or invites a user to a team, given a specifiedorganization ID, by team ID.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#add-or-update-team-membership-for-a-user
func (*TeamsService)AddTeamMembershipBySlug¶
func (s *TeamsService) AddTeamMembershipBySlug(ctxcontext.Context, org, slug, userstring, opts *TeamAddTeamMembershipOptions) (*Membership, *Response,error)
AddTeamMembershipBySlug adds or invites a user to a team, given a specifiedorganization name, by team slug.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#add-or-update-team-membership-for-a-user
func (*TeamsService)AddTeamProjectByID¶
func (s *TeamsService) AddTeamProjectByID(ctxcontext.Context, orgID, teamID, projectIDint64, opts *TeamProjectOptions) (*Response,error)
AddTeamProjectByID adds an organization project to a team given the team ID.To add a project to a team or update the team's permission on a project, theauthenticated user must have admin permissions for the project.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#add-or-update-team-project-permissions
func (*TeamsService)AddTeamProjectBySlug¶
func (s *TeamsService) AddTeamProjectBySlug(ctxcontext.Context, org, slugstring, projectIDint64, opts *TeamProjectOptions) (*Response,error)
AddTeamProjectBySlug adds an organization project to a team given the team slug.To add a project to a team or update the team's permission on a project, theauthenticated user must have admin permissions for the project.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#add-or-update-team-project-permissions
func (*TeamsService)AddTeamRepoByID¶
func (s *TeamsService) AddTeamRepoByID(ctxcontext.Context, orgID, teamIDint64, owner, repostring, opts *TeamAddTeamRepoOptions) (*Response,error)
AddTeamRepoByID adds a repository to be managed by the specified team given the team ID.The specified repository must be owned by the organization to which the teambelongs, or a direct fork of a repository owned by the organization.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#add-or-update-team-repository-permissions
func (*TeamsService)AddTeamRepoBySlug¶
func (s *TeamsService) AddTeamRepoBySlug(ctxcontext.Context, org, slug, owner, repostring, opts *TeamAddTeamRepoOptions) (*Response,error)
AddTeamRepoBySlug adds a repository to be managed by the specified team given the team slug.The specified repository must be owned by the organization to which the teambelongs, or a direct fork of a repository owned by the organization.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#add-or-update-team-repository-permissions
func (*TeamsService)CreateCommentByID¶
func (s *TeamsService) CreateCommentByID(ctxcontext.Context, orgID, teamIDint64, discsusionNumberint, commentDiscussionComment) (*DiscussionComment, *Response,error)
CreateCommentByID creates a new comment on a team discussion by team ID.Authenticated user must grant write:discussion scope.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#create-a-discussion-comment
func (*TeamsService)CreateCommentBySlug¶
func (s *TeamsService) CreateCommentBySlug(ctxcontext.Context, org, slugstring, discsusionNumberint, commentDiscussionComment) (*DiscussionComment, *Response,error)
CreateCommentBySlug creates a new comment on a team discussion by team slug.Authenticated user must grant write:discussion scope.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#create-a-discussion-comment
func (*TeamsService)CreateDiscussionByID¶
func (s *TeamsService) CreateDiscussionByID(ctxcontext.Context, orgID, teamIDint64, discussionTeamDiscussion) (*TeamDiscussion, *Response,error)
CreateDiscussionByID creates a new discussion post on a team's page given Organization and Team ID.Authenticated user must grant write:discussion scope.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#create-a-discussion
func (*TeamsService)CreateDiscussionBySlug¶
func (s *TeamsService) CreateDiscussionBySlug(ctxcontext.Context, org, slugstring, discussionTeamDiscussion) (*TeamDiscussion, *Response,error)
CreateDiscussionBySlug creates a new discussion post on a team's page given Organization name and Team's slug.Authenticated user must grant write:discussion scope.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#create-a-discussion
func (*TeamsService)CreateOrUpdateIDPGroupConnectionsByID¶
func (s *TeamsService) CreateOrUpdateIDPGroupConnectionsByID(ctxcontext.Context, orgID, teamIDint64, optsIDPGroupList) (*IDPGroupList, *Response,error)
CreateOrUpdateIDPGroupConnectionsByID creates, updates, or removes a connectionbetween a team and an IDP group given organization and team IDs.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#create-or-update-idp-group-connections
func (*TeamsService)CreateOrUpdateIDPGroupConnectionsBySlug¶
func (s *TeamsService) CreateOrUpdateIDPGroupConnectionsBySlug(ctxcontext.Context, org, slugstring, optsIDPGroupList) (*IDPGroupList, *Response,error)
CreateOrUpdateIDPGroupConnectionsBySlug creates, updates, or removes a connectionbetween a team and an IDP group given organization name and team slug.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#create-or-update-idp-group-connections
func (*TeamsService)CreateTeam¶
func (s *TeamsService) CreateTeam(ctxcontext.Context, orgstring, teamNewTeam) (*Team, *Response,error)
CreateTeam creates a new team within an organization.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#create-a-team
func (*TeamsService)DeleteCommentByID¶
func (s *TeamsService) DeleteCommentByID(ctxcontext.Context, orgID, teamIDint64, discussionNumber, commentNumberint) (*Response,error)
DeleteCommentByID deletes a comment on a team discussion by team ID.Authenticated user must grant write:discussion scope.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#delete-a-discussion-comment
func (*TeamsService)DeleteCommentBySlug¶
func (s *TeamsService) DeleteCommentBySlug(ctxcontext.Context, org, slugstring, discussionNumber, commentNumberint) (*Response,error)
DeleteCommentBySlug deletes a comment on a team discussion by team slug.Authenticated user must grant write:discussion scope.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#delete-a-discussion-comment
func (*TeamsService)DeleteDiscussionByID¶
func (s *TeamsService) DeleteDiscussionByID(ctxcontext.Context, orgID, teamIDint64, discussionNumberint) (*Response,error)
DeleteDiscussionByID deletes a discussion from team's page given Organization and Team ID.Authenticated user must grant write:discussion scope.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#delete-a-discussion
func (*TeamsService)DeleteDiscussionBySlug¶
func (s *TeamsService) DeleteDiscussionBySlug(ctxcontext.Context, org, slugstring, discussionNumberint) (*Response,error)
DeleteDiscussionBySlug deletes a discussion from team's page given Organization name and Team's slug.Authenticated user must grant write:discussion scope.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#delete-a-discussion
func (*TeamsService)DeleteTeamByID¶
DeleteTeamByID deletes a team referenced by ID.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#delete-a-team
func (*TeamsService)DeleteTeamBySlug¶
DeleteTeamBySlug deletes a team reference by slug.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#delete-a-team
func (*TeamsService)EditCommentByID¶
func (s *TeamsService) EditCommentByID(ctxcontext.Context, orgID, teamIDint64, discussionNumber, commentNumberint, commentDiscussionComment) (*DiscussionComment, *Response,error)
EditCommentByID edits the body text of a discussion comment by team ID.Authenticated user must grant write:discussion scope.User is allowed to edit body of a comment only.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#update-a-discussion-comment
func (*TeamsService)EditCommentBySlug¶
func (s *TeamsService) EditCommentBySlug(ctxcontext.Context, org, slugstring, discussionNumber, commentNumberint, commentDiscussionComment) (*DiscussionComment, *Response,error)
EditCommentBySlug edits the body text of a discussion comment by team slug.Authenticated user must grant write:discussion scope.User is allowed to edit body of a comment only.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#update-a-discussion-comment
func (*TeamsService)EditDiscussionByID¶
func (s *TeamsService) EditDiscussionByID(ctxcontext.Context, orgID, teamIDint64, discussionNumberint, discussionTeamDiscussion) (*TeamDiscussion, *Response,error)
EditDiscussionByID edits the title and body text of a discussion post given Organization and Team ID.Authenticated user must grant write:discussion scope.User is allowed to change Title and Body of a discussion only.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#update-a-discussion
func (*TeamsService)EditDiscussionBySlug¶
func (s *TeamsService) EditDiscussionBySlug(ctxcontext.Context, org, slugstring, discussionNumberint, discussionTeamDiscussion) (*TeamDiscussion, *Response,error)
EditDiscussionBySlug edits the title and body text of a discussion post given Organization name and Team's slug.Authenticated user must grant write:discussion scope.User is allowed to change Title and Body of a discussion only.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#update-a-discussion
func (*TeamsService)EditTeamByID¶
func (s *TeamsService) EditTeamByID(ctxcontext.Context, orgID, teamIDint64, teamNewTeam, removeParentbool) (*Team, *Response,error)
EditTeamByID edits a team, given an organization ID, selected by ID.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#update-a-team
func (*TeamsService)EditTeamBySlug¶
func (s *TeamsService) EditTeamBySlug(ctxcontext.Context, org, slugstring, teamNewTeam, removeParentbool) (*Team, *Response,error)
EditTeamBySlug edits a team, given an organization name, by slug.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#update-a-team
func (*TeamsService)GetCommentByID¶
func (s *TeamsService) GetCommentByID(ctxcontext.Context, orgID, teamIDint64, discussionNumber, commentNumberint) (*DiscussionComment, *Response,error)
GetCommentByID gets a specific comment on a team discussion by team ID.Authenticated user must grant read:discussion scope.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#get-a-discussion-comment
func (*TeamsService)GetCommentBySlug¶
func (s *TeamsService) GetCommentBySlug(ctxcontext.Context, org, slugstring, discussionNumber, commentNumberint) (*DiscussionComment, *Response,error)
GetCommentBySlug gets a specific comment on a team discussion by team slug.Authenticated user must grant read:discussion scope.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#get-a-discussion-comment
func (*TeamsService)GetDiscussionByID¶
func (s *TeamsService) GetDiscussionByID(ctxcontext.Context, orgID, teamIDint64, discussionNumberint) (*TeamDiscussion, *Response,error)
GetDiscussionByID gets a specific discussion on a team's page given Organization and Team ID.Authenticated user must grant read:discussion scope.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#get-a-discussion
func (*TeamsService)GetDiscussionBySlug¶
func (s *TeamsService) GetDiscussionBySlug(ctxcontext.Context, org, slugstring, discussionNumberint) (*TeamDiscussion, *Response,error)
GetDiscussionBySlug gets a specific discussion on a team's page given Organization name and Team's slug.Authenticated user must grant read:discussion scope.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#get-a-discussion
func (*TeamsService)GetExternalGroup¶
func (s *TeamsService) GetExternalGroup(ctxcontext.Context, orgstring, groupIDint64) (*ExternalGroup, *Response,error)
GetExternalGroup fetches an external group.
GitHub API docs:https://docs.github.com/en/enterprise-cloud@latest/rest/reference/teams#get-an-external-group
func (*TeamsService)GetTeamByID¶
GetTeamByID fetches a team, given a specified organization ID, by ID.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#get-a-team-by-name
func (*TeamsService)GetTeamBySlug¶
GetTeamBySlug fetches a team, given a specified organization name, by slug.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#get-a-team-by-name
func (*TeamsService)GetTeamMembershipByID¶
func (s *TeamsService) GetTeamMembershipByID(ctxcontext.Context, orgID, teamIDint64, userstring) (*Membership, *Response,error)
GetTeamMembershipByID returns the membership status for a user in a team, given a specifiedorganization ID, by team ID.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#get-team-membership-for-a-user
func (*TeamsService)GetTeamMembershipBySlug¶
func (s *TeamsService) GetTeamMembershipBySlug(ctxcontext.Context, org, slug, userstring) (*Membership, *Response,error)
GetTeamMembershipBySlug returns the membership status for a user in a team, given a specifiedorganization name, by team slug.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#get-team-membership-for-a-user
func (*TeamsService)IsTeamRepoByID¶
func (s *TeamsService) IsTeamRepoByID(ctxcontext.Context, orgID, teamIDint64, owner, repostring) (*Repository, *Response,error)
IsTeamRepoByID checks if a team, given its ID, manages the specified repository. If therepository is managed by team, a Repository is returned which includes thepermissions team has for that repo.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#check-team-permissions-for-a-repository
func (*TeamsService)IsTeamRepoBySlug¶
func (s *TeamsService) IsTeamRepoBySlug(ctxcontext.Context, org, slug, owner, repostring) (*Repository, *Response,error)
IsTeamRepoBySlug checks if a team, given its slug, manages the specified repository. If therepository is managed by team, a Repository is returned which includes thepermissions team has for that repo.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#check-team-permissions-for-a-repository
func (*TeamsService)ListChildTeamsByParentID¶
func (s *TeamsService) ListChildTeamsByParentID(ctxcontext.Context, orgID, teamIDint64, opts *ListOptions) ([]*Team, *Response,error)
ListChildTeamsByParentID lists child teams for a parent team given parent ID.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#list-child-teams
func (*TeamsService)ListChildTeamsByParentSlug¶
func (s *TeamsService) ListChildTeamsByParentSlug(ctxcontext.Context, org, slugstring, opts *ListOptions) ([]*Team, *Response,error)
ListChildTeamsByParentSlug lists child teams for a parent team given parent slug.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#list-child-teams
func (*TeamsService)ListCommentsByID¶
func (s *TeamsService) ListCommentsByID(ctxcontext.Context, orgID, teamIDint64, discussionNumberint, options *DiscussionCommentListOptions) ([]*DiscussionComment, *Response,error)
ListCommentsByID lists all comments on a team discussion by team ID.Authenticated user must grant read:discussion scope.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#list-discussion-comments
func (*TeamsService)ListCommentsBySlug¶
func (s *TeamsService) ListCommentsBySlug(ctxcontext.Context, org, slugstring, discussionNumberint, options *DiscussionCommentListOptions) ([]*DiscussionComment, *Response,error)
ListCommentsBySlug lists all comments on a team discussion by team slug.Authenticated user must grant read:discussion scope.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#list-discussion-comments
func (*TeamsService)ListDiscussionsByID¶
func (s *TeamsService) ListDiscussionsByID(ctxcontext.Context, orgID, teamIDint64, opts *DiscussionListOptions) ([]*TeamDiscussion, *Response,error)
ListDiscussionsByID lists all discussions on team's page given Organization and Team ID.Authenticated user must grant read:discussion scope.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#list-discussions
func (*TeamsService)ListDiscussionsBySlug¶
func (s *TeamsService) ListDiscussionsBySlug(ctxcontext.Context, org, slugstring, opts *DiscussionListOptions) ([]*TeamDiscussion, *Response,error)
ListDiscussionsBySlug lists all discussions on team's page given Organization name and Team's slug.Authenticated user must grant read:discussion scope.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#list-discussions
func (*TeamsService)ListExternalGroups¶
func (s *TeamsService) ListExternalGroups(ctxcontext.Context, orgstring, opts *ListExternalGroupsOptions) (*ExternalGroupList, *Response,error)
ListExternalGroups lists external groups connected to a team on GitHub.
GitHub API docs:https://docs.github.com/en/enterprise-cloud@latest/rest/reference/teams#list-external-groups-in-an-organization
func (*TeamsService)ListIDPGroupsForTeamByID¶
func (s *TeamsService) ListIDPGroupsForTeamByID(ctxcontext.Context, orgID, teamIDint64) (*IDPGroupList, *Response,error)
ListIDPGroupsForTeamByID lists IDP groups connected to a team on GitHubgiven organization and team IDs.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#list-idp-groups-for-a-team
func (*TeamsService)ListIDPGroupsForTeamBySlug¶
func (s *TeamsService) ListIDPGroupsForTeamBySlug(ctxcontext.Context, org, slugstring) (*IDPGroupList, *Response,error)
ListIDPGroupsForTeamBySlug lists IDP groups connected to a team on GitHubgiven organization name and team slug.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#list-idp-groups-for-a-team
func (*TeamsService)ListIDPGroupsInOrganization¶
func (s *TeamsService) ListIDPGroupsInOrganization(ctxcontext.Context, orgstring, opts *ListCursorOptions) (*IDPGroupList, *Response,error)
ListIDPGroupsInOrganization lists IDP groups available in an organization.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#list-idp-groups-for-an-organization
func (*TeamsService)ListPendingTeamInvitationsByID¶
func (s *TeamsService) ListPendingTeamInvitationsByID(ctxcontext.Context, orgID, teamIDint64, opts *ListOptions) ([]*Invitation, *Response,error)
ListPendingTeamInvitationsByID gets pending invitation list of a team, given a specifiedorganization ID, by team ID.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#list-pending-team-invitations
func (*TeamsService)ListPendingTeamInvitationsBySlug¶
func (s *TeamsService) ListPendingTeamInvitationsBySlug(ctxcontext.Context, org, slugstring, opts *ListOptions) ([]*Invitation, *Response,error)
ListPendingTeamInvitationsBySlug get pending invitation list of a team, given a specifiedorganization name, by team slug.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#list-pending-team-invitations
func (*TeamsService)ListTeamMembersByID¶
func (s *TeamsService) ListTeamMembersByID(ctxcontext.Context, orgID, teamIDint64, opts *TeamListTeamMembersOptions) ([]*User, *Response,error)
ListTeamMembersByID lists all of the users who are members of a team, given a specifiedorganization ID, by team ID.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#list-team-members
func (*TeamsService)ListTeamMembersBySlug¶
func (s *TeamsService) ListTeamMembersBySlug(ctxcontext.Context, org, slugstring, opts *TeamListTeamMembersOptions) ([]*User, *Response,error)
ListTeamMembersBySlug lists all of the users who are members of a team, given a specifiedorganization name, by team slug.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#list-team-members
func (*TeamsService)ListTeamProjectsByID¶
func (s *TeamsService) ListTeamProjectsByID(ctxcontext.Context, orgID, teamIDint64) ([]*Project, *Response,error)
ListTeamProjectsByID lists the organization projects for a team given the team ID.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#list-team-projects
func (*TeamsService)ListTeamProjectsBySlug¶
func (s *TeamsService) ListTeamProjectsBySlug(ctxcontext.Context, org, slugstring) ([]*Project, *Response,error)
ListTeamProjectsBySlug lists the organization projects for a team given the team slug.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#list-team-projects
func (*TeamsService)ListTeamReposByID¶
func (s *TeamsService) ListTeamReposByID(ctxcontext.Context, orgID, teamIDint64, opts *ListOptions) ([]*Repository, *Response,error)
ListTeamReposByID lists the repositories given a team ID that the specified team has access to.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#list-team-repositories
func (*TeamsService)ListTeamReposBySlug¶
func (s *TeamsService) ListTeamReposBySlug(ctxcontext.Context, org, slugstring, opts *ListOptions) ([]*Repository, *Response,error)
ListTeamReposBySlug lists the repositories given a team slug that the specified team has access to.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#list-team-repositories
func (*TeamsService)ListTeams¶
func (s *TeamsService) ListTeams(ctxcontext.Context, orgstring, opts *ListOptions) ([]*Team, *Response,error)
ListTeams lists all of the teams for an organization.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#list-teams
Example¶
package mainimport ("context""fmt""github.com/google/go-github/v43/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-Authenticationclient := 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 (*TeamsService)ListUserTeams¶
func (s *TeamsService) ListUserTeams(ctxcontext.Context, opts *ListOptions) ([]*Team, *Response,error)
ListUserTeams lists a user's teamsGitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#list-teams-for-the-authenticated-user
func (*TeamsService)RemoveConnectedExternalGroup¶
func (s *TeamsService) RemoveConnectedExternalGroup(ctxcontext.Context, org, slugstring) (*Response,error)
RemoveConnectedExternalGroup removes the connection between an external group and a team.
GitHub API docs:https://docs.github.com/en/enterprise-cloud@latest/rest/reference/teams#remove-the-connection-between-an-external-group-and-a-team
func (*TeamsService)RemoveTeamMembershipByID¶
func (s *TeamsService) RemoveTeamMembershipByID(ctxcontext.Context, orgID, teamIDint64, userstring) (*Response,error)
RemoveTeamMembershipByID removes a user from a team, given a specifiedorganization ID, by team ID.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#remove-team-membership-for-a-user
func (*TeamsService)RemoveTeamMembershipBySlug¶
func (s *TeamsService) RemoveTeamMembershipBySlug(ctxcontext.Context, org, slug, userstring) (*Response,error)
RemoveTeamMembershipBySlug removes a user from a team, given a specifiedorganization name, by team slug.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#remove-team-membership-for-a-user
func (*TeamsService)RemoveTeamProjectByID¶
func (s *TeamsService) RemoveTeamProjectByID(ctxcontext.Context, orgID, teamID, projectIDint64) (*Response,error)
RemoveTeamProjectByID removes an organization project from a team given team ID.An organization owner or a team maintainer can remove any project from the team.To remove a project from a team as an organization member, the authenticated usermust have "read" access to both the team and project, or "admin" access to the teamor project.Note: This endpoint removes the project from the team, but does not delete it.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#remove-a-project-from-a-team
func (*TeamsService)RemoveTeamProjectBySlug¶
func (s *TeamsService) RemoveTeamProjectBySlug(ctxcontext.Context, org, slugstring, projectIDint64) (*Response,error)
RemoveTeamProjectBySlug removes an organization project from a team given team slug.An organization owner or a team maintainer can remove any project from the team.To remove a project from a team as an organization member, the authenticated usermust have "read" access to both the team and project, or "admin" access to the teamor project.Note: This endpoint removes the project from the team, but does not delete it.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#remove-a-project-from-a-team
func (*TeamsService)RemoveTeamRepoByID¶
func (s *TeamsService) RemoveTeamRepoByID(ctxcontext.Context, orgID, teamIDint64, owner, repostring) (*Response,error)
RemoveTeamRepoByID removes a repository from being managed by the specifiedteam given the team ID. Note that this does not delete the repository, itjust removes it from the team.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#remove-a-repository-from-a-team
func (*TeamsService)RemoveTeamRepoBySlug¶
func (s *TeamsService) RemoveTeamRepoBySlug(ctxcontext.Context, org, slug, owner, repostring) (*Response,error)
RemoveTeamRepoBySlug removes a repository from being managed by the specifiedteam given the team slug. Note that this does not delete the repository, itjust removes it from the team.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#remove-a-repository-from-a-team
func (*TeamsService)ReviewTeamProjectsByID¶
func (s *TeamsService) ReviewTeamProjectsByID(ctxcontext.Context, orgID, teamID, projectIDint64) (*Project, *Response,error)
ReviewTeamProjectsByID checks whether a team, given its ID, has read, write, or adminpermissions for an organization project.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#check-team-permissions-for-a-project
func (*TeamsService)ReviewTeamProjectsBySlug¶
func (s *TeamsService) ReviewTeamProjectsBySlug(ctxcontext.Context, org, slugstring, projectIDint64) (*Project, *Response,error)
ReviewTeamProjectsBySlug checks whether a team, given its slug, has read, write, or adminpermissions for an organization project.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/teams/#check-team-permissions-for-a-project
func (*TeamsService)UpdateConnectedExternalGroup¶
func (s *TeamsService) UpdateConnectedExternalGroup(ctxcontext.Context, org, slugstring, eg *ExternalGroup) (*ExternalGroup, *Response,error)
UpdateConnectedExternalGroup updates the connection between an external group and a team.
GitHub API docs:https://docs.github.com/en/enterprise-cloud@latest/rest/reference/teams#update-the-connection-between-an-external-group-and-a-team
typeTemplateRepoRequest¶
type TemplateRepoRequest struct {// Name is required when creating a repo.Name *string `json:"name,omitempty"`Owner *string `json:"owner,omitempty"`Description *string `json:"description,omitempty"`IncludeAllBranches *bool `json:"include_all_branches,omitempty"`Private *bool `json:"private,omitempty"`}
TemplateRepoRequest represents a request to create a repository from a template.
func (*TemplateRepoRequest)GetDescription¶
func (t *TemplateRepoRequest) GetDescription()string
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (*TemplateRepoRequest)GetIncludeAllBranches¶
func (t *TemplateRepoRequest) GetIncludeAllBranches()bool
GetIncludeAllBranches returns the IncludeAllBranches field if it's non-nil, zero value otherwise.
func (*TemplateRepoRequest)GetName¶
func (t *TemplateRepoRequest) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*TemplateRepoRequest)GetOwner¶
func (t *TemplateRepoRequest) GetOwner()string
GetOwner returns the Owner field if it's non-nil, zero value otherwise.
func (*TemplateRepoRequest)GetPrivate¶
func (t *TemplateRepoRequest) GetPrivate()bool
GetPrivate returns the Private field if it's non-nil, zero value otherwise.
typeTextMatch¶
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 (*TextMatch)GetFragment¶
GetFragment returns the Fragment field if it's non-nil, zero value otherwise.
func (*TextMatch)GetObjectType¶
GetObjectType returns the ObjectType field if it's non-nil, zero value otherwise.
func (*TextMatch)GetObjectURL¶
GetObjectURL returns the ObjectURL field if it's non-nil, zero value otherwise.
func (*TextMatch)GetProperty¶
GetProperty returns the Property field if it's non-nil, zero value otherwise.
typeTimeline¶
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"`// The person who commented on the issue.User *User `json:"user,omitempty"`// The person who authored the commit.Author *CommitAuthor `json:"author,omitempty"`// The person who committed the commit on behalf of the author.Committer *CommitAuthor `json:"committer,omitempty"`// The SHA of the commit in the pull request.SHA *string `json:"sha,omitempty"`// The commit message.Message *string `json:"message,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.//// reviewed// The pull request was reviewed.//// 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"`Assigner *User `json:"assigner,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"`ProjectCard *ProjectCard `json:"project_card,omitempty"`// The state of a submitted review. Can be one of: 'commented',// 'changes_requested' or 'approved'.// Only provided for 'reviewed' events.State *string `json:"state,omitempty"`// The person requested to review the pull request.Reviewer *User `json:"requested_reviewer,omitempty"`// The person who requested a review.Requester *User `json:"review_requester,omitempty"`// The review summary text.Body *string `json:"body,omitempty"`SubmittedAt *time.Time `json:"submitted_at,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://docs.github.com/en/developers/webhooks-and-events/events/issue-event-types
func (*Timeline)GetAssignee¶
GetAssignee returns the Assignee field.
func (*Timeline)GetAssigner¶
GetAssigner returns the Assigner field.
func (*Timeline)GetAuthor¶
func (t *Timeline) GetAuthor() *CommitAuthor
GetAuthor returns the Author field.
func (*Timeline)GetCommitID¶
GetCommitID returns the CommitID field if it's non-nil, zero value otherwise.
func (*Timeline)GetCommitURL¶
GetCommitURL returns the CommitURL field if it's non-nil, zero value otherwise.
func (*Timeline)GetCommitter¶
func (t *Timeline) GetCommitter() *CommitAuthor
GetCommitter returns the Committer field.
func (*Timeline)GetCreatedAt¶
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*Timeline)GetMessage¶
GetMessage returns the Message field if it's non-nil, zero value otherwise.
func (*Timeline)GetMilestone¶
GetMilestone returns the Milestone field.
func (*Timeline)GetProjectCard¶
func (t *Timeline) GetProjectCard() *ProjectCard
GetProjectCard returns the ProjectCard field.
func (*Timeline)GetRequester¶
GetRequester returns the Requester field.
func (*Timeline)GetReviewer¶
GetReviewer returns the Reviewer field.
func (*Timeline)GetSubmittedAt¶
GetSubmittedAt returns the SubmittedAt field if it's non-nil, zero value otherwise.
typeTimestamp¶
Timestamp represents a time that can be unmarshalled from a JSON stringformatted as either an RFC3339 or Unix timestamp. This is necessary for somefields since the GitHub API is inconsistent in how it represents times. Allexported methods of time.Time can be called on Timestamp.
func (*Timestamp)UnmarshalJSON¶
UnmarshalJSON implements the json.Unmarshaler interface.Time is expected in RFC3339 or Unix format.
typeTool¶
type Tool struct {Name *string `json:"name,omitempty"`GUID *string `json:"guid,omitempty"`Version *string `json:"version,omitempty"`}
Tool represents the tool used to generate a GitHub Code Scanning Alert.
func (*Tool)GetVersion¶
GetVersion returns the Version field if it's non-nil, zero value otherwise.
typeTopicResult¶
type TopicResult struct {Name *string `json:"name,omitempty"`DisplayName *string `json:"display_name,omitempty"`ShortDescription *string `json:"short_description,omitempty"`Description *string `json:"description,omitempty"`CreatedBy *string `json:"created_by,omitempty"`CreatedAt *Timestamp `json:"created_at,omitempty"`UpdatedAt *string `json:"updated_at,omitempty"`Featured *bool `json:"featured,omitempty"`Curated *bool `json:"curated,omitempty"`Score *float64 `json:"score,omitempty"`}
func (*TopicResult)GetCreatedAt¶
func (t *TopicResult) GetCreatedAt()Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*TopicResult)GetCreatedBy¶
func (t *TopicResult) GetCreatedBy()string
GetCreatedBy returns the CreatedBy field if it's non-nil, zero value otherwise.
func (*TopicResult)GetCurated¶
func (t *TopicResult) GetCurated()bool
GetCurated returns the Curated field if it's non-nil, zero value otherwise.
func (*TopicResult)GetDescription¶
func (t *TopicResult) GetDescription()string
GetDescription returns the Description field if it's non-nil, zero value otherwise.
func (*TopicResult)GetDisplayName¶
func (t *TopicResult) GetDisplayName()string
GetDisplayName returns the DisplayName field if it's non-nil, zero value otherwise.
func (*TopicResult)GetFeatured¶
func (t *TopicResult) GetFeatured()bool
GetFeatured returns the Featured field if it's non-nil, zero value otherwise.
func (*TopicResult)GetName¶
func (t *TopicResult) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*TopicResult)GetScore¶
func (t *TopicResult) GetScore() *float64
GetScore returns the Score field.
func (*TopicResult)GetShortDescription¶
func (t *TopicResult) GetShortDescription()string
GetShortDescription returns the ShortDescription field if it's non-nil, zero value otherwise.
func (*TopicResult)GetUpdatedAt¶
func (t *TopicResult) GetUpdatedAt()string
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
typeTopicsSearchResult¶
type TopicsSearchResult struct {Total *int `json:"total_count,omitempty"`IncompleteResults *bool `json:"incomplete_results,omitempty"`Topics []*TopicResult `json:"items,omitempty"`}
TopicsSearchResult represents the result of a topics search.
func (*TopicsSearchResult)GetIncompleteResults¶
func (t *TopicsSearchResult) GetIncompleteResults()bool
GetIncompleteResults returns the IncompleteResults field if it's non-nil, zero value otherwise.
func (*TopicsSearchResult)GetTotal¶
func (t *TopicsSearchResult) GetTotal()int
GetTotal returns the Total field if it's non-nil, zero value otherwise.
typeTrafficBreakdownOptions¶
type TrafficBreakdownOptions struct {Perstring `url:"per,omitempty"`}
TrafficBreakdownOptions specifies the parameters to methods that support breakdown per day or week.Can be one of: day, week. Default: day.
typeTrafficClones¶
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 (*TrafficClones)GetCount¶
func (t *TrafficClones) GetCount()int
GetCount returns the Count field if it's non-nil, zero value otherwise.
func (*TrafficClones)GetUniques¶
func (t *TrafficClones) GetUniques()int
GetUniques returns the Uniques field if it's non-nil, zero value otherwise.
typeTrafficData¶
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 (*TrafficData)GetCount¶
func (t *TrafficData) GetCount()int
GetCount returns the Count field if it's non-nil, zero value otherwise.
func (*TrafficData)GetTimestamp¶
func (t *TrafficData) GetTimestamp()Timestamp
GetTimestamp returns the Timestamp field if it's non-nil, zero value otherwise.
func (*TrafficData)GetUniques¶
func (t *TrafficData) GetUniques()int
GetUniques returns the Uniques field if it's non-nil, zero value otherwise.
typeTrafficPath¶
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 (*TrafficPath)GetCount¶
func (t *TrafficPath) GetCount()int
GetCount returns the Count field if it's non-nil, zero value otherwise.
func (*TrafficPath)GetPath¶
func (t *TrafficPath) GetPath()string
GetPath returns the Path field if it's non-nil, zero value otherwise.
func (*TrafficPath)GetTitle¶
func (t *TrafficPath) GetTitle()string
GetTitle returns the Title field if it's non-nil, zero value otherwise.
func (*TrafficPath)GetUniques¶
func (t *TrafficPath) GetUniques()int
GetUniques returns the Uniques field if it's non-nil, zero value otherwise.
typeTrafficReferrer¶
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 (*TrafficReferrer)GetCount¶
func (t *TrafficReferrer) GetCount()int
GetCount returns the Count field if it's non-nil, zero value otherwise.
func (*TrafficReferrer)GetReferrer¶
func (t *TrafficReferrer) GetReferrer()string
GetReferrer returns the Referrer field if it's non-nil, zero value otherwise.
func (*TrafficReferrer)GetUniques¶
func (t *TrafficReferrer) GetUniques()int
GetUniques returns the Uniques field if it's non-nil, zero value otherwise.
typeTrafficViews¶
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 (*TrafficViews)GetCount¶
func (t *TrafficViews) GetCount()int
GetCount returns the Count field if it's non-nil, zero value otherwise.
func (*TrafficViews)GetUniques¶
func (t *TrafficViews) GetUniques()int
GetUniques returns the Uniques field if it's non-nil, zero value otherwise.
typeTransferRequest¶
type TransferRequest struct {NewOwnerstring `json:"new_owner"`TeamID []int64 `json:"team_ids,omitempty"`}
TransferRequest represents a request to transfer a repository.
typeTree¶
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 (*Tree)GetTruncated¶
GetTruncated returns the Truncated field if it's non-nil, zero value otherwise.
typeTreeEntry¶
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 canrepresent either a blob, a commit (in the case of a submodule), or anothertree.
func (*TreeEntry)GetContent¶
GetContent returns the Content field if it's non-nil, zero value otherwise.
func (*TreeEntry)MarshalJSON¶
typeTwoFactorAuthError¶
type TwoFactorAuthErrorErrorResponse
TwoFactorAuthError occurs when using HTTP Basic Authentication for a userthat has two-factor authentication enabled. The request can be reattemptedby providing a one-time password in the request.
func (*TwoFactorAuthError)Error¶
func (r *TwoFactorAuthError) Error()string
typeUnauthenticatedRateLimitedTransport¶
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.ClientIDstring// ClientSecret is the GitHub OAuth client secret of the current// application.ClientSecretstring// Transport is the underlying HTTP transport to use when making requests.// It will default to http.DefaultTransport if nil.Transporthttp.RoundTripper}
UnauthenticatedRateLimitedTransport allows you to make unauthenticated callsthat 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 add the client id and secret as a base64-encoded string in the formatClientID:ClientSecret and apply it as an "Authorization": "Basic" header.
Seehttps://docs.github.com/en/free-pro-team@latest/rest/reference/#unauthenticated-rate-limited-requests formore information.
func (*UnauthenticatedRateLimitedTransport)Client¶
func (t *UnauthenticatedRateLimitedTransport) Client() *http.Client
Client returns an *http.Client that makes requests which are subject to therate limit of your OAuth application.
typeUpdateAttributeForSCIMUserOperations¶
type UpdateAttributeForSCIMUserOperations struct {Opstring `json:"op"`// (Required.)Path *string `json:"path,omitempty"`// (Optional.)Valuejson.RawMessage `json:"value,omitempty"`// (Optional.)}
UpdateAttributeForSCIMUserOperations represents operations for UpdateAttributeForSCIMUser.
func (*UpdateAttributeForSCIMUserOperations)GetPath¶
func (u *UpdateAttributeForSCIMUserOperations) GetPath()string
GetPath returns the Path field if it's non-nil, zero value otherwise.
typeUpdateAttributeForSCIMUserOptions¶
type UpdateAttributeForSCIMUserOptions struct {Schemas []string `json:"schemas,omitempty"`// (Optional.)OperationsUpdateAttributeForSCIMUserOperations `json:"operations"`// Set of operations to be performed. (Required.)}
UpdateAttributeForSCIMUserOptions represents options for UpdateAttributeForSCIMUser.
GitHub API docs:https://docs.github.com/en/rest/reference/scim#update-an-attribute-for-a-scim-user--parameters
typeUpdateCheckRunOptions¶
type UpdateCheckRunOptions struct {Namestring `json:"name"`// The name of the check (e.g., "code-coverage"). (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", "skipped", "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)Actions []*CheckRunAction `json:"actions,omitempty"`// Possible further actions the integrator can perform, which a user may trigger. (Optional.)}
UpdateCheckRunOptions sets up parameters needed to update a CheckRun.
func (*UpdateCheckRunOptions)GetCompletedAt¶
func (u *UpdateCheckRunOptions) GetCompletedAt()Timestamp
GetCompletedAt returns the CompletedAt field if it's non-nil, zero value otherwise.
func (*UpdateCheckRunOptions)GetConclusion¶
func (u *UpdateCheckRunOptions) GetConclusion()string
GetConclusion returns the Conclusion field if it's non-nil, zero value otherwise.
func (*UpdateCheckRunOptions)GetDetailsURL¶
func (u *UpdateCheckRunOptions) GetDetailsURL()string
GetDetailsURL returns the DetailsURL field if it's non-nil, zero value otherwise.
func (*UpdateCheckRunOptions)GetExternalID¶
func (u *UpdateCheckRunOptions) GetExternalID()string
GetExternalID returns the ExternalID field if it's non-nil, zero value otherwise.
func (*UpdateCheckRunOptions)GetOutput¶
func (u *UpdateCheckRunOptions) GetOutput() *CheckRunOutput
GetOutput returns the Output field.
func (*UpdateCheckRunOptions)GetStatus¶
func (u *UpdateCheckRunOptions) GetStatus()string
GetStatus returns the Status field if it's non-nil, zero value otherwise.
typeUpdateRunnerGroupRequest¶
type UpdateRunnerGroupRequest struct {Name *string `json:"name,omitempty"`Visibility *string `json:"visibility,omitempty"`AllowsPublicRepositories *bool `json:"allows_public_repositories,omitempty"`}
UpdateRunnerGroupRequest represents a request to update a Runner group for an organization.
func (*UpdateRunnerGroupRequest)GetAllowsPublicRepositories¶
func (u *UpdateRunnerGroupRequest) GetAllowsPublicRepositories()bool
GetAllowsPublicRepositories returns the AllowsPublicRepositories field if it's non-nil, zero value otherwise.
func (*UpdateRunnerGroupRequest)GetName¶
func (u *UpdateRunnerGroupRequest) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*UpdateRunnerGroupRequest)GetVisibility¶
func (u *UpdateRunnerGroupRequest) GetVisibility()string
GetVisibility returns the Visibility field if it's non-nil, zero value otherwise.
typeUploadOptions¶
type UploadOptions struct {Namestring `url:"name,omitempty"`Labelstring `url:"label,omitempty"`MediaTypestring `url:"-"`}
UploadOptions specifies the parameters to methods that support uploads.
typeUser¶
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"`TwitterUsername *string `json:"twitter_username,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"`TwoFactorAuthentication *bool `json:"two_factor_authentication,omitempty"`Plan *Plan `json:"plan,omitempty"`LdapDn *string `json:"ldap_dn,omitempty"`// API URLsURL *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 andhttps://docs.github.com/en/free-pro-team@latest/rest/reference/search/#text-match-metadataTextMatches []*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 (*User)GetAvatarURL¶
GetAvatarURL returns the AvatarURL field if it's non-nil, zero value otherwise.
func (*User)GetCollaborators¶
GetCollaborators returns the Collaborators field if it's non-nil, zero value otherwise.
func (*User)GetCompany¶
GetCompany returns the Company field if it's non-nil, zero value otherwise.
func (*User)GetCreatedAt¶
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*User)GetDiskUsage¶
GetDiskUsage returns the DiskUsage field if it's non-nil, zero value otherwise.
func (*User)GetEventsURL¶
GetEventsURL returns the EventsURL field if it's non-nil, zero value otherwise.
func (*User)GetFollowers¶
GetFollowers returns the Followers field if it's non-nil, zero value otherwise.
func (*User)GetFollowersURL¶
GetFollowersURL returns the FollowersURL field if it's non-nil, zero value otherwise.
func (*User)GetFollowing¶
GetFollowing returns the Following field if it's non-nil, zero value otherwise.
func (*User)GetFollowingURL¶
GetFollowingURL returns the FollowingURL field if it's non-nil, zero value otherwise.
func (*User)GetGistsURL¶
GetGistsURL returns the GistsURL field if it's non-nil, zero value otherwise.
func (*User)GetGravatarID¶
GetGravatarID returns the GravatarID field if it's non-nil, zero value otherwise.
func (*User)GetHTMLURL¶
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*User)GetHireable¶
GetHireable returns the Hireable field if it's non-nil, zero value otherwise.
func (*User)GetLocation¶
GetLocation returns the Location field if it's non-nil, zero value otherwise.
func (*User)GetOrganizationsURL¶
GetOrganizationsURL returns the OrganizationsURL field if it's non-nil, zero value otherwise.
func (*User)GetOwnedPrivateRepos¶
GetOwnedPrivateRepos returns the OwnedPrivateRepos field if it's non-nil, zero value otherwise.
func (*User)GetPermissions¶
GetPermissions returns the Permissions map if it's non-nil, an empty map otherwise.
func (*User)GetPrivateGists¶
GetPrivateGists returns the PrivateGists field if it's non-nil, zero value otherwise.
func (*User)GetPublicGists¶
GetPublicGists returns the PublicGists field if it's non-nil, zero value otherwise.
func (*User)GetPublicRepos¶
GetPublicRepos returns the PublicRepos field if it's non-nil, zero value otherwise.
func (*User)GetReceivedEventsURL¶
GetReceivedEventsURL returns the ReceivedEventsURL field if it's non-nil, zero value otherwise.
func (*User)GetReposURL¶
GetReposURL returns the ReposURL field if it's non-nil, zero value otherwise.
func (*User)GetSiteAdmin¶
GetSiteAdmin returns the SiteAdmin field if it's non-nil, zero value otherwise.
func (*User)GetStarredURL¶
GetStarredURL returns the StarredURL field if it's non-nil, zero value otherwise.
func (*User)GetSubscriptionsURL¶
GetSubscriptionsURL returns the SubscriptionsURL field if it's non-nil, zero value otherwise.
func (*User)GetSuspendedAt¶
GetSuspendedAt returns the SuspendedAt field if it's non-nil, zero value otherwise.
func (*User)GetTotalPrivateRepos¶
GetTotalPrivateRepos returns the TotalPrivateRepos field if it's non-nil, zero value otherwise.
func (*User)GetTwitterUsername¶
GetTwitterUsername returns the TwitterUsername field if it's non-nil, zero value otherwise.
func (*User)GetTwoFactorAuthentication¶
GetTwoFactorAuthentication returns the TwoFactorAuthentication field if it's non-nil, zero value otherwise.
func (*User)GetUpdatedAt¶
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
typeUserAuthorization¶
type UserAuthorization struct {ID *int64 `json:"id,omitempty"`URL *string `json:"url,omitempty"`Scopes []string `json:"scopes,omitempty"`Token *string `json:"token,omitempty"`TokenLastEight *string `json:"token_last_eight,omitempty"`HashedToken *string `json:"hashed_token,omitempty"`App *OAuthAPP `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"`}
UserAuthorization represents the impersonation response.
func (*UserAuthorization)GetApp¶
func (u *UserAuthorization) GetApp() *OAuthAPP
GetApp returns the App field.
func (*UserAuthorization)GetCreatedAt¶
func (u *UserAuthorization) GetCreatedAt()Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*UserAuthorization)GetFingerprint¶
func (u *UserAuthorization) GetFingerprint()string
GetFingerprint returns the Fingerprint field if it's non-nil, zero value otherwise.
func (*UserAuthorization)GetHashedToken¶
func (u *UserAuthorization) GetHashedToken()string
GetHashedToken returns the HashedToken field if it's non-nil, zero value otherwise.
func (*UserAuthorization)GetID¶
func (u *UserAuthorization) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*UserAuthorization)GetNote¶
func (u *UserAuthorization) GetNote()string
GetNote returns the Note field if it's non-nil, zero value otherwise.
func (*UserAuthorization)GetNoteURL¶
func (u *UserAuthorization) GetNoteURL()string
GetNoteURL returns the NoteURL field if it's non-nil, zero value otherwise.
func (*UserAuthorization)GetToken¶
func (u *UserAuthorization) GetToken()string
GetToken returns the Token field if it's non-nil, zero value otherwise.
func (*UserAuthorization)GetTokenLastEight¶
func (u *UserAuthorization) GetTokenLastEight()string
GetTokenLastEight returns the TokenLastEight field if it's non-nil, zero value otherwise.
func (*UserAuthorization)GetURL¶
func (u *UserAuthorization) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (*UserAuthorization)GetUpdatedAt¶
func (u *UserAuthorization) GetUpdatedAt()Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
typeUserContext¶
type UserContext struct {Message *string `json:"message,omitempty"`Octicon *string `json:"octicon,omitempty"`}
UserContext represents the contextual information about user.
func (*UserContext)GetMessage¶
func (u *UserContext) GetMessage()string
GetMessage returns the Message field if it's non-nil, zero value otherwise.
func (*UserContext)GetOcticon¶
func (u *UserContext) GetOcticon()string
GetOcticon returns the Octicon field if it's non-nil, zero value otherwise.
typeUserEmail¶
type UserEmail struct {Email *string `json:"email,omitempty"`Primary *bool `json:"primary,omitempty"`Verified *bool `json:"verified,omitempty"`Visibility *string `json:"visibility,omitempty"`}
UserEmail represents user's email address
func (*UserEmail)GetPrimary¶
GetPrimary returns the Primary field if it's non-nil, zero value otherwise.
func (*UserEmail)GetVerified¶
GetVerified returns the Verified field if it's non-nil, zero value otherwise.
func (*UserEmail)GetVisibility¶
GetVisibility returns the Visibility field if it's non-nil, zero value otherwise.
typeUserEvent¶
type UserEvent struct {User *User `json:"user,omitempty"`// The action performed. Possible values are: "created" or "deleted".Action *string `json:"action,omitempty"`Enterprise *Enterprise `json:"enterprise,omitempty"`Sender *User `json:"sender,omitempty"`// The following fields are only populated by Webhook events.Installation *Installation `json:"installation,omitempty"`}
UserEvent is triggered when a user is created or deleted.The Webhook event name is "user".
Only global webhooks can subscribe to this event type.
GitHub API docs:https://developer.github.com/enterprise/v3/activity/events/types/#userevent-enterprise
func (*UserEvent)GetAction¶
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*UserEvent)GetEnterprise¶
func (u *UserEvent) GetEnterprise() *Enterprise
GetEnterprise returns the Enterprise field.
func (*UserEvent)GetInstallation¶
func (u *UserEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
typeUserLDAPMapping¶
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 (*UserLDAPMapping)GetAvatarURL¶
func (u *UserLDAPMapping) GetAvatarURL()string
GetAvatarURL returns the AvatarURL field if it's non-nil, zero value otherwise.
func (*UserLDAPMapping)GetEventsURL¶
func (u *UserLDAPMapping) GetEventsURL()string
GetEventsURL returns the EventsURL field if it's non-nil, zero value otherwise.
func (*UserLDAPMapping)GetFollowersURL¶
func (u *UserLDAPMapping) GetFollowersURL()string
GetFollowersURL returns the FollowersURL field if it's non-nil, zero value otherwise.
func (*UserLDAPMapping)GetFollowingURL¶
func (u *UserLDAPMapping) GetFollowingURL()string
GetFollowingURL returns the FollowingURL field if it's non-nil, zero value otherwise.
func (*UserLDAPMapping)GetGistsURL¶
func (u *UserLDAPMapping) GetGistsURL()string
GetGistsURL returns the GistsURL field if it's non-nil, zero value otherwise.
func (*UserLDAPMapping)GetGravatarID¶
func (u *UserLDAPMapping) GetGravatarID()string
GetGravatarID returns the GravatarID field if it's non-nil, zero value otherwise.
func (*UserLDAPMapping)GetID¶
func (u *UserLDAPMapping) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*UserLDAPMapping)GetLDAPDN¶
func (u *UserLDAPMapping) GetLDAPDN()string
GetLDAPDN returns the LDAPDN field if it's non-nil, zero value otherwise.
func (*UserLDAPMapping)GetLogin¶
func (u *UserLDAPMapping) GetLogin()string
GetLogin returns the Login field if it's non-nil, zero value otherwise.
func (*UserLDAPMapping)GetOrganizationsURL¶
func (u *UserLDAPMapping) GetOrganizationsURL()string
GetOrganizationsURL returns the OrganizationsURL field if it's non-nil, zero value otherwise.
func (*UserLDAPMapping)GetReceivedEventsURL¶
func (u *UserLDAPMapping) GetReceivedEventsURL()string
GetReceivedEventsURL returns the ReceivedEventsURL field if it's non-nil, zero value otherwise.
func (*UserLDAPMapping)GetReposURL¶
func (u *UserLDAPMapping) GetReposURL()string
GetReposURL returns the ReposURL field if it's non-nil, zero value otherwise.
func (*UserLDAPMapping)GetSiteAdmin¶
func (u *UserLDAPMapping) GetSiteAdmin()bool
GetSiteAdmin returns the SiteAdmin field if it's non-nil, zero value otherwise.
func (*UserLDAPMapping)GetStarredURL¶
func (u *UserLDAPMapping) GetStarredURL()string
GetStarredURL returns the StarredURL field if it's non-nil, zero value otherwise.
func (*UserLDAPMapping)GetSubscriptionsURL¶
func (u *UserLDAPMapping) GetSubscriptionsURL()string
GetSubscriptionsURL returns the SubscriptionsURL field if it's non-nil, zero value otherwise.
func (*UserLDAPMapping)GetType¶
func (u *UserLDAPMapping) GetType()string
GetType returns the Type field if it's non-nil, zero value otherwise.
func (*UserLDAPMapping)GetURL¶
func (u *UserLDAPMapping) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (UserLDAPMapping)String¶
func (mUserLDAPMapping) String()string
typeUserListOptions¶
type UserListOptions struct {// ID of the last user seenSinceint64 `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.ListAllmethod.
typeUserMigration¶
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 (*UserMigration)GetCreatedAt¶
func (u *UserMigration) GetCreatedAt()string
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*UserMigration)GetExcludeAttachments¶
func (u *UserMigration) GetExcludeAttachments()bool
GetExcludeAttachments returns the ExcludeAttachments field if it's non-nil, zero value otherwise.
func (*UserMigration)GetGUID¶
func (u *UserMigration) GetGUID()string
GetGUID returns the GUID field if it's non-nil, zero value otherwise.
func (*UserMigration)GetID¶
func (u *UserMigration) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*UserMigration)GetLockRepositories¶
func (u *UserMigration) GetLockRepositories()bool
GetLockRepositories returns the LockRepositories field if it's non-nil, zero value otherwise.
func (*UserMigration)GetState¶
func (u *UserMigration) GetState()string
GetState returns the State field if it's non-nil, zero value otherwise.
func (*UserMigration)GetURL¶
func (u *UserMigration) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (*UserMigration)GetUpdatedAt¶
func (u *UserMigration) GetUpdatedAt()string
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (UserMigration)String¶
func (mUserMigration) String()string
typeUserMigrationOptions¶
type UserMigrationOptions struct {// LockRepositories indicates whether repositories should be locked (to prevent// manipulation) while migrating data.LockRepositoriesbool// ExcludeAttachments indicates whether attachments should be excluded from// the migration (to reduce migration archive file size).ExcludeAttachmentsbool}
UserMigrationOptions specifies the optional parameters to Migration methods.
typeUserStats¶
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 (*UserStats)GetAdminUsers¶
GetAdminUsers returns the AdminUsers field if it's non-nil, zero value otherwise.
func (*UserStats)GetSuspendedUsers¶
GetSuspendedUsers returns the SuspendedUsers field if it's non-nil, zero value otherwise.
func (*UserStats)GetTotalUsers¶
GetTotalUsers returns the TotalUsers field if it's non-nil, zero value otherwise.
typeUserSuspendOptions¶
type UserSuspendOptions struct {Reason *string `json:"reason,omitempty"`}
UserSuspendOptions represents the reason a user is being suspended.
func (*UserSuspendOptions)GetReason¶
func (u *UserSuspendOptions) GetReason()string
GetReason returns the Reason field if it's non-nil, zero value otherwise.
typeUsersSearchResult¶
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 (*UsersSearchResult)GetIncompleteResults¶
func (u *UsersSearchResult) GetIncompleteResults()bool
GetIncompleteResults returns the IncompleteResults field if it's non-nil, zero value otherwise.
func (*UsersSearchResult)GetTotal¶
func (u *UsersSearchResult) GetTotal()int
GetTotal returns the Total field if it's non-nil, zero value otherwise.
typeUsersService¶
type UsersService service
UsersService handles communication with the user relatedmethods of the GitHub API.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/users/
func (*UsersService)AcceptInvitation¶
AcceptInvitation accepts the currently-open repository invitation for theauthenticated user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#accept-a-repository-invitation
func (*UsersService)AddEmails¶
func (s *UsersService) AddEmails(ctxcontext.Context, emails []string) ([]*UserEmail, *Response,error)
AddEmails adds email addresses of the authenticated user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/users/#add-an-email-address-for-the-authenticated-user
func (*UsersService)BlockUser¶
BlockUser blocks specified user for the authenticated user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/users/#block-a-user
func (*UsersService)CreateGPGKey¶
func (s *UsersService) CreateGPGKey(ctxcontext.Context, armoredPublicKeystring) (*GPGKey, *Response,error)
CreateGPGKey creates a GPG key. It requires authenticatation via Basic Author OAuth with at least write:gpg_key scope.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/users/#create-a-gpg-key
func (*UsersService)CreateKey¶
CreateKey adds a public key for the authenticated user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/users/#create-a-public-ssh-key-for-the-authenticated-user
func (*UsersService)CreateProject¶
func (s *UsersService) CreateProject(ctxcontext.Context, opts *CreateUserProjectOptions) (*Project, *Response,error)
CreateProject creates a GitHub Project for the current user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/projects/#create-a-user-project
func (*UsersService)DeclineInvitation¶
DeclineInvitation declines the currently-open repository invitation for theauthenticated user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#decline-a-repository-invitation
func (*UsersService)DeleteEmails¶
DeleteEmails deletes email addresses from authenticated user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/users/#delete-an-email-address-for-the-authenticated-user
func (*UsersService)DeleteGPGKey¶
DeleteGPGKey deletes a GPG key. It requires authentication via Basic Auth orvia OAuth with at least admin:gpg_key scope.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/users/#delete-a-gpg-key-for-the-authenticated-user
func (*UsersService)DeleteKey¶
DeleteKey deletes a public key.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/users/#delete-a-public-ssh-key-for-the-authenticated-user
func (*UsersService)DeletePackage¶
func (s *UsersService) DeletePackage(ctxcontext.Context, user, packageType, packageNamestring) (*Response,error)
Delete a package from a user. Passing the empty string for "user" willdelete the package for the authenticated user.
GitHub API docs:https://docs.github.com/en/rest/reference/packages#delete-a-package-for-the-authenticated-userGitHub API docs:https://docs.github.com/en/rest/reference/packages#delete-a-package-for-a-user
func (*UsersService)DemoteSiteAdmin¶
DemoteSiteAdmin demotes a user from site administrator of a GitHub Enterprise instance.
GitHub API docs:https://developer.github.com/enterprise/v3/enterprise-admin/users/#demote-a-site-administrator-to-an-ordinary-user
func (*UsersService)Edit¶
Edit the authenticated user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/users/#update-the-authenticated-user
func (*UsersService)Follow¶
Follow will cause the authenticated user to follow the specified user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/users/#follow-a-user
func (*UsersService)Get¶
Get fetches a user. Passing the empty string will fetch the authenticateduser.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/users/#get-the-authenticated-userGitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/users/#get-a-user
func (*UsersService)GetByID¶
GetByID fetches a user.
Note: GetByID uses the undocumented GitHub API endpoint /user/:id.
func (*UsersService)GetGPGKey¶
GetGPGKey gets extended details for a single GPG key. It requires authenticationvia Basic Auth or via OAuth with at least read:gpg_key scope.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/users/#get-a-gpg-key-for-the-authenticated-user
func (*UsersService)GetHovercard¶
func (s *UsersService) GetHovercard(ctxcontext.Context, userstring, opts *HovercardOptions) (*Hovercard, *Response,error)
GetHovercard fetches contextual information about user. It requires authenticationvia Basic Auth or via OAuth with the repo scope.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/users/#get-contextual-information-for-a-user
func (*UsersService)GetKey¶
GetKey fetches a single public key.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/users/#get-a-public-ssh-key-for-the-authenticated-user
func (*UsersService)GetPackage¶
func (s *UsersService) GetPackage(ctxcontext.Context, user, packageType, packageNamestring) (*Package, *Response,error)
Get a package by name for a user. Passing the empty string for "user" willget the package for the authenticated user.
GitHub API docs:https://docs.github.com/en/rest/reference/packages#get-a-package-for-the-authenticated-userGitHub API docs:https://docs.github.com/en/rest/reference/packages#get-a-package-for-a-user
func (*UsersService)IsBlocked¶
IsBlocked reports whether specified user is blocked by the authenticated user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/users/#check-if-a-user-is-blocked-by-the-authenticated-user
func (*UsersService)IsFollowing¶
IsFollowing checks if "user" is following "target". Passing the emptystring for "user" will check if the authenticated user is following "target".
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/users/#check-if-a-person-is-followed-by-the-authenticated-userGitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/users/#check-if-a-user-follows-another-user
func (*UsersService)ListAll¶
func (s *UsersService) ListAll(ctxcontext.Context, opts *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://docs.github.com/en/free-pro-team@latest/rest/reference/users/#list-users
Example¶
package mainimport ("context""log""github.com/google/go-github/v43/github")func main() {client := github.NewClient(nil)opts := &github.UserListOptions{}for {ctx := context.Background()users, _, err := client.Users.ListAll(ctx, 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 (*UsersService)ListBlockedUsers¶
func (s *UsersService) ListBlockedUsers(ctxcontext.Context, opts *ListOptions) ([]*User, *Response,error)
ListBlockedUsers lists all the blocked users by the authenticated user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/users/#list-users-blocked-by-the-authenticated-user
func (*UsersService)ListEmails¶
func (s *UsersService) ListEmails(ctxcontext.Context, opts *ListOptions) ([]*UserEmail, *Response,error)
ListEmails lists all email addresses for the authenticated user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/users/#list-email-addresses-for-the-authenticated-user
func (*UsersService)ListFollowers¶
func (s *UsersService) ListFollowers(ctxcontext.Context, userstring, opts *ListOptions) ([]*User, *Response,error)
ListFollowers lists the followers for a user. Passing the empty string willfetch followers for the authenticated user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/users/#list-followers-of-the-authenticated-userGitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/users/#list-followers-of-a-user
func (*UsersService)ListFollowing¶
func (s *UsersService) ListFollowing(ctxcontext.Context, userstring, opts *ListOptions) ([]*User, *Response,error)
ListFollowing lists the people that a user is following. Passing the emptystring will list people the authenticated user is following.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/users/#list-the-people-the-authenticated-user-followsGitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/users/#list-the-people-a-user-follows
func (*UsersService)ListGPGKeys¶
func (s *UsersService) ListGPGKeys(ctxcontext.Context, userstring, opts *ListOptions) ([]*GPGKey, *Response,error)
ListGPGKeys lists the public GPG keys for a user. Passing the emptystring will fetch keys for the authenticated user. It requires authenticationvia Basic Auth or via OAuth with at least read:gpg_key scope.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/users/#list-gpg-keys-for-the-authenticated-userGitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/users/#list-gpg-keys-for-a-user
func (*UsersService)ListInvitations¶
func (s *UsersService) ListInvitations(ctxcontext.Context, opts *ListOptions) ([]*RepositoryInvitation, *Response,error)
ListInvitations lists all currently-open repository invitations for theauthenticated user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#list-repository-invitations-for-the-authenticated-user
func (*UsersService)ListKeys¶
func (s *UsersService) ListKeys(ctxcontext.Context, userstring, opts *ListOptions) ([]*Key, *Response,error)
ListKeys lists the verified public keys for a user. Passing the emptystring will fetch keys for the authenticated user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/users/#list-public-ssh-keys-for-the-authenticated-userGitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/users/#list-public-keys-for-a-user
func (*UsersService)ListPackages¶
func (s *UsersService) ListPackages(ctxcontext.Context, userstring, opts *PackageListOptions) ([]*Package, *Response,error)
List the packages for a user. Passing the empty string for "user" willlist packages for the authenticated user.
GitHub API docs:https://docs.github.com/en/rest/reference/packages#list-packages-for-the-authenticated-users-namespaceGitHub API docs:https://docs.github.com/en/rest/reference/packages#list-packages-for-a-user
func (*UsersService)ListProjects¶
func (s *UsersService) ListProjects(ctxcontext.Context, userstring, opts *ProjectListOptions) ([]*Project, *Response,error)
ListProjects lists the projects for the specified user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/projects/#list-user-projects
func (*UsersService)PackageDeleteVersion¶
func (s *UsersService) PackageDeleteVersion(ctxcontext.Context, user, packageType, packageNamestring, packageVersionIDint64) (*Response,error)
Delete a package version for a user. Passing the empty string for "user" willdelete the version for the authenticated user.
GitHub API docs:https://docs.github.com/en/rest/reference/packages#delete-a-package-version-for-the-authenticated-userGitHub API docs:https://docs.github.com/en/rest/reference/packages#delete-package-version-for-a-user
func (*UsersService)PackageGetAllVersions¶
func (s *UsersService) PackageGetAllVersions(ctxcontext.Context, user, packageType, packageNamestring, opts *PackageListOptions) ([]*PackageVersion, *Response,error)
Get all versions of a package for a user. Passing the empty string for "user" willget versions for the authenticated user.
GitHub API docs:https://docs.github.com/en/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-userGitHub API docs:https://docs.github.com/en/rest/reference/users#delete-an-email-address-for-the-authenticated-user
func (*UsersService)PackageGetVersion¶
func (s *UsersService) PackageGetVersion(ctxcontext.Context, user, packageType, packageNamestring, packageVersionIDint64) (*PackageVersion, *Response,error)
Get a specific version of a package for a user. Passing the empty string for "user" willget the version for the authenticated user.
GitHub API docs:https://docs.github.com/en/rest/reference/packages#get-a-package-version-for-the-authenticated-userGitHub API docs:https://docs.github.com/en/rest/reference/packages#get-a-package-version-for-a-user
func (*UsersService)PackageRestoreVersion¶
func (s *UsersService) PackageRestoreVersion(ctxcontext.Context, user, packageType, packageNamestring, packageVersionIDint64) (*Response,error)
Restore a package version to a user. Passing the empty string for "user" willrestore the version for the authenticated user.
GitHub API docs:https://docs.github.com/en/rest/reference/packages#restore-a-package-version-for-the-authenticated-userGitHub API docs:https://docs.github.com/en/rest/reference/packages#restore-package-version-for-a-user
func (*UsersService)PromoteSiteAdmin¶
PromoteSiteAdmin promotes a user to a site administrator of a GitHub Enterprise instance.
GitHub API docs:https://developer.github.com/enterprise/v3/enterprise-admin/users/#promote-an-ordinary-user-to-a-site-administrator
func (*UsersService)RestorePackage¶
func (s *UsersService) RestorePackage(ctxcontext.Context, user, packageType, packageNamestring) (*Response,error)
Restore a package to a user. Passing the empty string for "user" willrestore the package for the authenticated user.
GitHub API docs:https://docs.github.com/en/rest/reference/packages#restore-a-package-for-the-authenticated-userGitHub API docs:https://docs.github.com/en/rest/reference/packages#restore-a-package-for-a-user
func (*UsersService)Suspend¶
func (s *UsersService) Suspend(ctxcontext.Context, userstring, opts *UserSuspendOptions) (*Response,error)
Suspend a user on a GitHub Enterprise instance.
GitHub API docs:https://developer.github.com/enterprise/v3/enterprise-admin/users/#suspend-a-user
func (*UsersService)UnblockUser¶
UnblockUser unblocks specified user for the authenticated user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/users/#unblock-a-user
func (*UsersService)Unfollow¶
Unfollow will cause the authenticated user to unfollow the specified user.
GitHub API docs:https://docs.github.com/en/free-pro-team@latest/rest/reference/users/#unfollow-a-user
func (*UsersService)Unsuspend¶
Unsuspend a user on a GitHub Enterprise instance.
GitHub API docs:https://developer.github.com/enterprise/v3/enterprise-admin/users/#unsuspend-a-user
typeWatchEvent¶
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 APIblog 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’srepository is the repository that was starred.
GitHub API docs:https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#watch
func (*WatchEvent)GetAction¶
func (w *WatchEvent) GetAction()string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*WatchEvent)GetInstallation¶
func (w *WatchEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*WatchEvent)GetSender¶
func (w *WatchEvent) GetSender() *User
GetSender returns the Sender field.
typeWebHookAuthor¶
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 specifiedin a WebHookCommit. The commit author may not correspond to a GitHub User.
func (*WebHookAuthor)GetEmail¶
func (w *WebHookAuthor) GetEmail()string
GetEmail returns the Email field if it's non-nil, zero value otherwise.
func (*WebHookAuthor)GetName¶
func (w *WebHookAuthor) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*WebHookAuthor)GetUsername¶
func (w *WebHookAuthor) GetUsername()string
GetUsername returns the Username field if it's non-nil, zero value otherwise.
func (WebHookAuthor)String¶
func (wWebHookAuthor) String()string
typeWebHookCommit¶
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 aWebHookPayload.
func (*WebHookCommit)GetAuthor¶
func (w *WebHookCommit) GetAuthor() *WebHookAuthor
GetAuthor returns the Author field.
func (*WebHookCommit)GetCommitter¶
func (w *WebHookCommit) GetCommitter() *WebHookAuthor
GetCommitter returns the Committer field.
func (*WebHookCommit)GetDistinct¶
func (w *WebHookCommit) GetDistinct()bool
GetDistinct returns the Distinct field if it's non-nil, zero value otherwise.
func (*WebHookCommit)GetID¶
func (w *WebHookCommit) GetID()string
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*WebHookCommit)GetMessage¶
func (w *WebHookCommit) GetMessage()string
GetMessage returns the Message field if it's non-nil, zero value otherwise.
func (*WebHookCommit)GetTimestamp¶
func (w *WebHookCommit) GetTimestamp()time.Time
GetTimestamp returns the Timestamp field if it's non-nil, zero value otherwise.
func (WebHookCommit)String¶
func (wWebHookCommit) String()string
typeWebHookPayload¶
type WebHookPayload struct {Action *string `json:"action,omitempty"`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"`Installation *Installation `json:"installation,omitempty"`Organization *Organization `json:"organization,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 pushevent hook is triggered. The format of these payloads pre-date most of theGitHub v3 API, so there are lots of minor incompatibilities with the typesdefined in the rest of the API. Therefore, several types are duplicatedhere to account for these differences.
GitHub API docs:https://help.github.com/articles/post-receive-hooks
func (*WebHookPayload)GetAction¶
func (w *WebHookPayload) GetAction()string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*WebHookPayload)GetAfter¶
func (w *WebHookPayload) GetAfter()string
GetAfter returns the After field if it's non-nil, zero value otherwise.
func (*WebHookPayload)GetBefore¶
func (w *WebHookPayload) GetBefore()string
GetBefore returns the Before field if it's non-nil, zero value otherwise.
func (*WebHookPayload)GetCompare¶
func (w *WebHookPayload) GetCompare()string
GetCompare returns the Compare field if it's non-nil, zero value otherwise.
func (*WebHookPayload)GetCreated¶
func (w *WebHookPayload) GetCreated()bool
GetCreated returns the Created field if it's non-nil, zero value otherwise.
func (*WebHookPayload)GetDeleted¶
func (w *WebHookPayload) GetDeleted()bool
GetDeleted returns the Deleted field if it's non-nil, zero value otherwise.
func (*WebHookPayload)GetForced¶
func (w *WebHookPayload) GetForced()bool
GetForced returns the Forced field if it's non-nil, zero value otherwise.
func (*WebHookPayload)GetHeadCommit¶
func (w *WebHookPayload) GetHeadCommit() *WebHookCommit
GetHeadCommit returns the HeadCommit field.
func (*WebHookPayload)GetInstallation¶
func (w *WebHookPayload) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*WebHookPayload)GetOrganization¶
func (w *WebHookPayload) GetOrganization() *Organization
GetOrganization returns the Organization field.
func (*WebHookPayload)GetPusher¶
func (w *WebHookPayload) GetPusher() *User
GetPusher returns the Pusher field.
func (*WebHookPayload)GetRef¶
func (w *WebHookPayload) GetRef()string
GetRef returns the Ref field if it's non-nil, zero value otherwise.
func (*WebHookPayload)GetRepo¶
func (w *WebHookPayload) GetRepo() *Repository
GetRepo returns the Repo field.
func (*WebHookPayload)GetSender¶
func (w *WebHookPayload) GetSender() *User
GetSender returns the Sender field.
func (WebHookPayload)String¶
func (wWebHookPayload) String()string
typeWeeklyCommitActivity¶
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 (*WeeklyCommitActivity)GetTotal¶
func (w *WeeklyCommitActivity) GetTotal()int
GetTotal returns the Total field if it's non-nil, zero value otherwise.
func (*WeeklyCommitActivity)GetWeek¶
func (w *WeeklyCommitActivity) GetWeek()Timestamp
GetWeek returns the Week field if it's non-nil, zero value otherwise.
func (WeeklyCommitActivity)String¶
func (wWeeklyCommitActivity) String()string
typeWeeklyStats¶
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 commitsa Contributor made in a given week.
func (*WeeklyStats)GetAdditions¶
func (w *WeeklyStats) GetAdditions()int
GetAdditions returns the Additions field if it's non-nil, zero value otherwise.
func (*WeeklyStats)GetCommits¶
func (w *WeeklyStats) GetCommits()int
GetCommits returns the Commits field if it's non-nil, zero value otherwise.
func (*WeeklyStats)GetDeletions¶
func (w *WeeklyStats) GetDeletions()int
GetDeletions returns the Deletions field if it's non-nil, zero value otherwise.
func (*WeeklyStats)GetWeek¶
func (w *WeeklyStats) GetWeek()Timestamp
GetWeek returns the Week field if it's non-nil, zero value otherwise.
func (WeeklyStats)String¶
func (wWeeklyStats) String()string
typeWorkflow¶
type Workflow struct {ID *int64 `json:"id,omitempty"`NodeID *string `json:"node_id,omitempty"`Name *string `json:"name,omitempty"`Path *string `json:"path,omitempty"`State *string `json:"state,omitempty"`CreatedAt *Timestamp `json:"created_at,omitempty"`UpdatedAt *Timestamp `json:"updated_at,omitempty"`URL *string `json:"url,omitempty"`HTMLURL *string `json:"html_url,omitempty"`BadgeURL *string `json:"badge_url,omitempty"`}
Workflow represents a repository action workflow.
func (*Workflow)GetBadgeURL¶
GetBadgeURL returns the BadgeURL field if it's non-nil, zero value otherwise.
func (*Workflow)GetCreatedAt¶
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*Workflow)GetHTMLURL¶
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*Workflow)GetUpdatedAt¶
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
typeWorkflowBill¶
type WorkflowBill struct {TotalMS *int64 `json:"total_ms,omitempty"`}
WorkflowBill specifies billable time for a specific environment in a workflow.
func (*WorkflowBill)GetTotalMS¶
func (w *WorkflowBill) GetTotalMS()int64
GetTotalMS returns the TotalMS field if it's non-nil, zero value otherwise.
typeWorkflowDispatchEvent¶
type WorkflowDispatchEvent struct {Inputsjson.RawMessage `json:"inputs,omitempty"`Ref *string `json:"ref,omitempty"`Workflow *string `json:"workflow,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"`}
WorkflowDispatchEvent is triggered when someone triggers a workflow run on GitHub orsends a POST request to the create a workflow dispatch event endpoint.
GitHub API docs:https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch
func (*WorkflowDispatchEvent)GetInstallation¶
func (w *WorkflowDispatchEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*WorkflowDispatchEvent)GetOrg¶
func (w *WorkflowDispatchEvent) GetOrg() *Organization
GetOrg returns the Org field.
func (*WorkflowDispatchEvent)GetRef¶
func (w *WorkflowDispatchEvent) GetRef()string
GetRef returns the Ref field if it's non-nil, zero value otherwise.
func (*WorkflowDispatchEvent)GetRepo¶
func (w *WorkflowDispatchEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (*WorkflowDispatchEvent)GetSender¶
func (w *WorkflowDispatchEvent) GetSender() *User
GetSender returns the Sender field.
func (*WorkflowDispatchEvent)GetWorkflow¶
func (w *WorkflowDispatchEvent) GetWorkflow()string
GetWorkflow returns the Workflow field if it's non-nil, zero value otherwise.
typeWorkflowEnvironment¶
type WorkflowEnvironment struct {Ubuntu *WorkflowBill `json:"UBUNTU,omitempty"`MacOS *WorkflowBill `json:"MACOS,omitempty"`Windows *WorkflowBill `json:"WINDOWS,omitempty"`}
WorkflowEnvironment represents different runner environments available for a workflow.
func (*WorkflowEnvironment)GetMacOS¶
func (w *WorkflowEnvironment) GetMacOS() *WorkflowBill
GetMacOS returns the MacOS field.
func (*WorkflowEnvironment)GetUbuntu¶
func (w *WorkflowEnvironment) GetUbuntu() *WorkflowBill
GetUbuntu returns the Ubuntu field.
func (*WorkflowEnvironment)GetWindows¶
func (w *WorkflowEnvironment) GetWindows() *WorkflowBill
GetWindows returns the Windows field.
typeWorkflowJob¶
type WorkflowJob struct {ID *int64 `json:"id,omitempty"`RunID *int64 `json:"run_id,omitempty"`RunURL *string `json:"run_url,omitempty"`NodeID *string `json:"node_id,omitempty"`HeadSHA *string `json:"head_sha,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"`Name *string `json:"name,omitempty"`Steps []*TaskStep `json:"steps,omitempty"`CheckRunURL *string `json:"check_run_url,omitempty"`// Labels represents runner labels from the `runs-on:` key from a GitHub Actions workflow.Labels []string `json:"labels,omitempty"`RunnerID *int64 `json:"runner_id,omitempty"`RunnerName *string `json:"runner_name,omitempty"`RunnerGroupID *int64 `json:"runner_group_id,omitempty"`RunnerGroupName *string `json:"runner_group_name,omitempty"`}
WorkflowJob represents a repository action workflow job.
func (*WorkflowJob)GetCheckRunURL¶
func (w *WorkflowJob) GetCheckRunURL()string
GetCheckRunURL returns the CheckRunURL field if it's non-nil, zero value otherwise.
func (*WorkflowJob)GetCompletedAt¶
func (w *WorkflowJob) GetCompletedAt()Timestamp
GetCompletedAt returns the CompletedAt field if it's non-nil, zero value otherwise.
func (*WorkflowJob)GetConclusion¶
func (w *WorkflowJob) GetConclusion()string
GetConclusion returns the Conclusion field if it's non-nil, zero value otherwise.
func (*WorkflowJob)GetHTMLURL¶
func (w *WorkflowJob) GetHTMLURL()string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*WorkflowJob)GetHeadSHA¶
func (w *WorkflowJob) GetHeadSHA()string
GetHeadSHA returns the HeadSHA field if it's non-nil, zero value otherwise.
func (*WorkflowJob)GetID¶
func (w *WorkflowJob) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*WorkflowJob)GetName¶
func (w *WorkflowJob) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*WorkflowJob)GetNodeID¶
func (w *WorkflowJob) GetNodeID()string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (*WorkflowJob)GetRunID¶
func (w *WorkflowJob) GetRunID()int64
GetRunID returns the RunID field if it's non-nil, zero value otherwise.
func (*WorkflowJob)GetRunURL¶
func (w *WorkflowJob) GetRunURL()string
GetRunURL returns the RunURL field if it's non-nil, zero value otherwise.
func (*WorkflowJob)GetRunnerGroupID¶
func (w *WorkflowJob) GetRunnerGroupID()int64
GetRunnerGroupID returns the RunnerGroupID field if it's non-nil, zero value otherwise.
func (*WorkflowJob)GetRunnerGroupName¶
func (w *WorkflowJob) GetRunnerGroupName()string
GetRunnerGroupName returns the RunnerGroupName field if it's non-nil, zero value otherwise.
func (*WorkflowJob)GetRunnerID¶
func (w *WorkflowJob) GetRunnerID()int64
GetRunnerID returns the RunnerID field if it's non-nil, zero value otherwise.
func (*WorkflowJob)GetRunnerName¶
func (w *WorkflowJob) GetRunnerName()string
GetRunnerName returns the RunnerName field if it's non-nil, zero value otherwise.
func (*WorkflowJob)GetStartedAt¶
func (w *WorkflowJob) GetStartedAt()Timestamp
GetStartedAt returns the StartedAt field if it's non-nil, zero value otherwise.
func (*WorkflowJob)GetStatus¶
func (w *WorkflowJob) GetStatus()string
GetStatus returns the Status field if it's non-nil, zero value otherwise.
func (*WorkflowJob)GetURL¶
func (w *WorkflowJob) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
typeWorkflowJobEvent¶
type WorkflowJobEvent struct {WorkflowJob *WorkflowJob `json:"workflow_job,omitempty"`Action *string `json:"action,omitempty"`// Org is not nil when the webhook is configured for an organization or the event// occurs from activity in a repository owned by an organization.Org *Organization `json:"organization,omitempty"`Repo *Repository `json:"repository,omitempty"`Sender *User `json:"sender,omitempty"`Installation *Installation `json:"installation,omitempty"`}
WorkflowJobEvent is triggered when a job is queued, started or completed.
GitHub API docs:https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#workflow_job
func (*WorkflowJobEvent)GetAction¶
func (w *WorkflowJobEvent) GetAction()string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*WorkflowJobEvent)GetInstallation¶
func (w *WorkflowJobEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*WorkflowJobEvent)GetOrg¶
func (w *WorkflowJobEvent) GetOrg() *Organization
GetOrg returns the Org field.
func (*WorkflowJobEvent)GetRepo¶
func (w *WorkflowJobEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (*WorkflowJobEvent)GetSender¶
func (w *WorkflowJobEvent) GetSender() *User
GetSender returns the Sender field.
func (*WorkflowJobEvent)GetWorkflowJob¶
func (w *WorkflowJobEvent) GetWorkflowJob() *WorkflowJob
GetWorkflowJob returns the WorkflowJob field.
typeWorkflowRun¶
type WorkflowRun struct {ID *int64 `json:"id,omitempty"`Name *string `json:"name,omitempty"`NodeID *string `json:"node_id,omitempty"`HeadBranch *string `json:"head_branch,omitempty"`HeadSHA *string `json:"head_sha,omitempty"`RunNumber *int `json:"run_number,omitempty"`RunAttempt *int `json:"run_attempt,omitempty"`Event *string `json:"event,omitempty"`Status *string `json:"status,omitempty"`Conclusion *string `json:"conclusion,omitempty"`WorkflowID *int64 `json:"workflow_id,omitempty"`CheckSuiteID *int64 `json:"check_suite_id,omitempty"`CheckSuiteNodeID *string `json:"check_suite_node_id,omitempty"`URL *string `json:"url,omitempty"`HTMLURL *string `json:"html_url,omitempty"`PullRequests []*PullRequest `json:"pull_requests,omitempty"`CreatedAt *Timestamp `json:"created_at,omitempty"`UpdatedAt *Timestamp `json:"updated_at,omitempty"`RunStartedAt *Timestamp `json:"run_started_at,omitempty"`JobsURL *string `json:"jobs_url,omitempty"`LogsURL *string `json:"logs_url,omitempty"`CheckSuiteURL *string `json:"check_suite_url,omitempty"`ArtifactsURL *string `json:"artifacts_url,omitempty"`CancelURL *string `json:"cancel_url,omitempty"`RerunURL *string `json:"rerun_url,omitempty"`PreviousAttemptURL *string `json:"previous_attempt_url,omitempty"`HeadCommit *HeadCommit `json:"head_commit,omitempty"`WorkflowURL *string `json:"workflow_url,omitempty"`Repository *Repository `json:"repository,omitempty"`HeadRepository *Repository `json:"head_repository,omitempty"`}
WorkflowRun represents a repository action workflow run.
func (*WorkflowRun)GetArtifactsURL¶
func (w *WorkflowRun) GetArtifactsURL()string
GetArtifactsURL returns the ArtifactsURL field if it's non-nil, zero value otherwise.
func (*WorkflowRun)GetCancelURL¶
func (w *WorkflowRun) GetCancelURL()string
GetCancelURL returns the CancelURL field if it's non-nil, zero value otherwise.
func (*WorkflowRun)GetCheckSuiteID¶
func (w *WorkflowRun) GetCheckSuiteID()int64
GetCheckSuiteID returns the CheckSuiteID field if it's non-nil, zero value otherwise.
func (*WorkflowRun)GetCheckSuiteNodeID¶
func (w *WorkflowRun) GetCheckSuiteNodeID()string
GetCheckSuiteNodeID returns the CheckSuiteNodeID field if it's non-nil, zero value otherwise.
func (*WorkflowRun)GetCheckSuiteURL¶
func (w *WorkflowRun) GetCheckSuiteURL()string
GetCheckSuiteURL returns the CheckSuiteURL field if it's non-nil, zero value otherwise.
func (*WorkflowRun)GetConclusion¶
func (w *WorkflowRun) GetConclusion()string
GetConclusion returns the Conclusion field if it's non-nil, zero value otherwise.
func (*WorkflowRun)GetCreatedAt¶
func (w *WorkflowRun) GetCreatedAt()Timestamp
GetCreatedAt returns the CreatedAt field if it's non-nil, zero value otherwise.
func (*WorkflowRun)GetEvent¶
func (w *WorkflowRun) GetEvent()string
GetEvent returns the Event field if it's non-nil, zero value otherwise.
func (*WorkflowRun)GetHTMLURL¶
func (w *WorkflowRun) GetHTMLURL()string
GetHTMLURL returns the HTMLURL field if it's non-nil, zero value otherwise.
func (*WorkflowRun)GetHeadBranch¶
func (w *WorkflowRun) GetHeadBranch()string
GetHeadBranch returns the HeadBranch field if it's non-nil, zero value otherwise.
func (*WorkflowRun)GetHeadCommit¶
func (w *WorkflowRun) GetHeadCommit() *HeadCommit
GetHeadCommit returns the HeadCommit field.
func (*WorkflowRun)GetHeadRepository¶
func (w *WorkflowRun) GetHeadRepository() *Repository
GetHeadRepository returns the HeadRepository field.
func (*WorkflowRun)GetHeadSHA¶
func (w *WorkflowRun) GetHeadSHA()string
GetHeadSHA returns the HeadSHA field if it's non-nil, zero value otherwise.
func (*WorkflowRun)GetID¶
func (w *WorkflowRun) GetID()int64
GetID returns the ID field if it's non-nil, zero value otherwise.
func (*WorkflowRun)GetJobsURL¶
func (w *WorkflowRun) GetJobsURL()string
GetJobsURL returns the JobsURL field if it's non-nil, zero value otherwise.
func (*WorkflowRun)GetLogsURL¶
func (w *WorkflowRun) GetLogsURL()string
GetLogsURL returns the LogsURL field if it's non-nil, zero value otherwise.
func (*WorkflowRun)GetName¶
func (w *WorkflowRun) GetName()string
GetName returns the Name field if it's non-nil, zero value otherwise.
func (*WorkflowRun)GetNodeID¶
func (w *WorkflowRun) GetNodeID()string
GetNodeID returns the NodeID field if it's non-nil, zero value otherwise.
func (*WorkflowRun)GetPreviousAttemptURL¶
func (w *WorkflowRun) GetPreviousAttemptURL()string
GetPreviousAttemptURL returns the PreviousAttemptURL field if it's non-nil, zero value otherwise.
func (*WorkflowRun)GetRepository¶
func (w *WorkflowRun) GetRepository() *Repository
GetRepository returns the Repository field.
func (*WorkflowRun)GetRerunURL¶
func (w *WorkflowRun) GetRerunURL()string
GetRerunURL returns the RerunURL field if it's non-nil, zero value otherwise.
func (*WorkflowRun)GetRunAttempt¶
func (w *WorkflowRun) GetRunAttempt()int
GetRunAttempt returns the RunAttempt field if it's non-nil, zero value otherwise.
func (*WorkflowRun)GetRunNumber¶
func (w *WorkflowRun) GetRunNumber()int
GetRunNumber returns the RunNumber field if it's non-nil, zero value otherwise.
func (*WorkflowRun)GetRunStartedAt¶
func (w *WorkflowRun) GetRunStartedAt()Timestamp
GetRunStartedAt returns the RunStartedAt field if it's non-nil, zero value otherwise.
func (*WorkflowRun)GetStatus¶
func (w *WorkflowRun) GetStatus()string
GetStatus returns the Status field if it's non-nil, zero value otherwise.
func (*WorkflowRun)GetURL¶
func (w *WorkflowRun) GetURL()string
GetURL returns the URL field if it's non-nil, zero value otherwise.
func (*WorkflowRun)GetUpdatedAt¶
func (w *WorkflowRun) GetUpdatedAt()Timestamp
GetUpdatedAt returns the UpdatedAt field if it's non-nil, zero value otherwise.
func (*WorkflowRun)GetWorkflowID¶
func (w *WorkflowRun) GetWorkflowID()int64
GetWorkflowID returns the WorkflowID field if it's non-nil, zero value otherwise.
func (*WorkflowRun)GetWorkflowURL¶
func (w *WorkflowRun) GetWorkflowURL()string
GetWorkflowURL returns the WorkflowURL field if it's non-nil, zero value otherwise.
typeWorkflowRunAttemptOptions¶
type WorkflowRunAttemptOptions struct {ExcludePullRequests *bool `url:"exclude_pull_requests,omitempty"`}
WorkflowRunAttemptOptions specifies optional parameters to GetWorkflowRunAttempt.
func (*WorkflowRunAttemptOptions)GetExcludePullRequests¶
func (w *WorkflowRunAttemptOptions) GetExcludePullRequests()bool
GetExcludePullRequests returns the ExcludePullRequests field if it's non-nil, zero value otherwise.
typeWorkflowRunBill¶
type WorkflowRunBill struct {TotalMS *int64 `json:"total_ms,omitempty"`Jobs *int `json:"jobs,omitempty"`JobRuns []*WorkflowRunJobRun `json:"job_runs,omitempty"`}
WorkflowRunBill specifies billable time for a specific environment in a workflow run.
func (*WorkflowRunBill)GetJobs¶
func (w *WorkflowRunBill) GetJobs()int
GetJobs returns the Jobs field if it's non-nil, zero value otherwise.
func (*WorkflowRunBill)GetTotalMS¶
func (w *WorkflowRunBill) GetTotalMS()int64
GetTotalMS returns the TotalMS field if it's non-nil, zero value otherwise.
typeWorkflowRunEnvironment¶
type WorkflowRunEnvironment struct {Ubuntu *WorkflowRunBill `json:"UBUNTU,omitempty"`MacOS *WorkflowRunBill `json:"MACOS,omitempty"`Windows *WorkflowRunBill `json:"WINDOWS,omitempty"`}
WorkflowRunEnvironment represents different runner environments available for a workflow run.
func (*WorkflowRunEnvironment)GetMacOS¶
func (w *WorkflowRunEnvironment) GetMacOS() *WorkflowRunBill
GetMacOS returns the MacOS field.
func (*WorkflowRunEnvironment)GetUbuntu¶
func (w *WorkflowRunEnvironment) GetUbuntu() *WorkflowRunBill
GetUbuntu returns the Ubuntu field.
func (*WorkflowRunEnvironment)GetWindows¶
func (w *WorkflowRunEnvironment) GetWindows() *WorkflowRunBill
GetWindows returns the Windows field.
typeWorkflowRunEvent¶
type WorkflowRunEvent struct {Action *string `json:"action,omitempty"`Workflow *Workflow `json:"workflow,omitempty"`WorkflowRun *WorkflowRun `json:"workflow_run,omitempty"`// The following fields are only populated by Webhook events.Org *Organization `json:"organization,omitempty"`Repo *Repository `json:"repository,omitempty"`Sender *User `json:"sender,omitempty"`Installation *Installation `json:"installation,omitempty"`}
WorkflowRunEvent is triggered when a GitHub Actions workflow run is requested or completed.
GitHub API docs:https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#workflow_run
func (*WorkflowRunEvent)GetAction¶
func (w *WorkflowRunEvent) GetAction()string
GetAction returns the Action field if it's non-nil, zero value otherwise.
func (*WorkflowRunEvent)GetInstallation¶
func (w *WorkflowRunEvent) GetInstallation() *Installation
GetInstallation returns the Installation field.
func (*WorkflowRunEvent)GetOrg¶
func (w *WorkflowRunEvent) GetOrg() *Organization
GetOrg returns the Org field.
func (*WorkflowRunEvent)GetRepo¶
func (w *WorkflowRunEvent) GetRepo() *Repository
GetRepo returns the Repo field.
func (*WorkflowRunEvent)GetSender¶
func (w *WorkflowRunEvent) GetSender() *User
GetSender returns the Sender field.
func (*WorkflowRunEvent)GetWorkflow¶
func (w *WorkflowRunEvent) GetWorkflow() *Workflow
GetWorkflow returns the Workflow field.
func (*WorkflowRunEvent)GetWorkflowRun¶
func (w *WorkflowRunEvent) GetWorkflowRun() *WorkflowRun
GetWorkflowRun returns the WorkflowRun field.
typeWorkflowRunJobRun¶
type WorkflowRunJobRun struct {JobID *int `json:"job_id,omitempty"`DurationMS *int64 `json:"duration_ms,omitempty"`}
WorkflowRunJobRun represents a usage of individual jobs of a specific workflow run.
func (*WorkflowRunJobRun)GetDurationMS¶
func (w *WorkflowRunJobRun) GetDurationMS()int64
GetDurationMS returns the DurationMS field if it's non-nil, zero value otherwise.
func (*WorkflowRunJobRun)GetJobID¶
func (w *WorkflowRunJobRun) GetJobID()int
GetJobID returns the JobID field if it's non-nil, zero value otherwise.
typeWorkflowRunUsage¶
type WorkflowRunUsage struct {Billable *WorkflowRunEnvironment `json:"billable,omitempty"`RunDurationMS *int64 `json:"run_duration_ms,omitempty"`}
WorkflowRunUsage represents a usage of a specific workflow run.
func (*WorkflowRunUsage)GetBillable¶
func (w *WorkflowRunUsage) GetBillable() *WorkflowRunEnvironment
GetBillable returns the Billable field.
func (*WorkflowRunUsage)GetRunDurationMS¶
func (w *WorkflowRunUsage) GetRunDurationMS()int64
GetRunDurationMS returns the RunDurationMS field if it's non-nil, zero value otherwise.
typeWorkflowRuns¶
type WorkflowRuns struct {TotalCount *int `json:"total_count,omitempty"`WorkflowRuns []*WorkflowRun `json:"workflow_runs,omitempty"`}
WorkflowRuns represents a slice of repository action workflow run.
func (*WorkflowRuns)GetTotalCount¶
func (w *WorkflowRuns) GetTotalCount()int
GetTotalCount returns the TotalCount field if it's non-nil, zero value otherwise.
typeWorkflowUsage¶
type WorkflowUsage struct {Billable *WorkflowEnvironment `json:"billable,omitempty"`}
WorkflowUsage represents a usage of a specific workflow.
func (*WorkflowUsage)GetBillable¶
func (w *WorkflowUsage) GetBillable() *WorkflowEnvironment
GetBillable returns the Billable field.
typeWorkflows¶
type Workflows struct {TotalCount *int `json:"total_count,omitempty"`Workflows []*Workflow `json:"workflows,omitempty"`}
Workflows represents a slice of repository action workflows.
func (*Workflows)GetTotalCount¶
GetTotalCount returns the TotalCount field if it's non-nil, zero value otherwise.
Source Files¶
- actions.go
- actions_artifacts.go
- actions_runner_groups.go
- actions_runners.go
- actions_secrets.go
- actions_workflow_jobs.go
- actions_workflow_runs.go
- actions_workflows.go
- activity.go
- activity_events.go
- activity_notifications.go
- activity_star.go
- activity_watching.go
- admin.go
- admin_orgs.go
- admin_stats.go
- admin_users.go
- apps.go
- apps_hooks.go
- apps_hooks_deliveries.go
- apps_installation.go
- apps_manifest.go
- apps_marketplace.go
- authorizations.go
- billing.go
- checks.go
- code-scanning.go
- dependabot.go
- dependabot_secrets.go
- doc.go
- enterprise.go
- enterprise_actions_runners.go
- enterprise_audit_log.go
- event.go
- event_types.go
- gists.go
- gists_comments.go
- git.go
- git_blobs.go
- git_commits.go
- git_refs.go
- git_tags.go
- git_trees.go
- github-accessors.go
- github.go
- gitignore.go
- interactions.go
- interactions_orgs.go
- interactions_repos.go
- issue_import.go
- issues.go
- issues_assignees.go
- issues_comments.go
- issues_events.go
- issues_labels.go
- issues_milestones.go
- issues_timeline.go
- licenses.go
- messages.go
- migrations.go
- migrations_source_import.go
- migrations_user.go
- misc.go
- orgs.go
- orgs_actions_allowed.go
- orgs_actions_permissions.go
- orgs_audit_log.go
- orgs_hooks.go
- orgs_hooks_deliveries.go
- orgs_members.go
- orgs_outside_collaborators.go
- orgs_packages.go
- orgs_projects.go
- orgs_users_blocking.go
- packages.go
- projects.go
- pulls.go
- pulls_comments.go
- pulls_reviewers.go
- pulls_reviews.go
- reactions.go
- repos.go
- repos_autolinks.go
- repos_collaborators.go
- repos_comments.go
- repos_commits.go
- repos_community_health.go
- repos_contents.go
- repos_deployments.go
- repos_environments.go
- repos_forks.go
- repos_hooks.go
- repos_hooks_deliveries.go
- repos_invitations.go
- repos_keys.go
- repos_merging.go
- repos_pages.go
- repos_prereceive_hooks.go
- repos_projects.go
- repos_releases.go
- repos_stats.go
- repos_statuses.go
- repos_traffic.go
- scim.go
- search.go
- secret_scanning.go
- strings.go
- teams.go
- teams_discussion_comments.go
- teams_discussions.go
- teams_members.go
- timestamp.go
- users.go
- users_administration.go
- users_blocking.go
- users_emails.go
- users_followers.go
- users_gpg_keys.go
- users_keys.go
- users_packages.go
- users_projects.go
- without_appengine.go