package
0.0.0-20250228223739-f95868010e93
Repository: https://github.com/yext/go-github.git
Documentation: pkg.go.dev
# Functions
Bool is a helper routine that allocates a new bool value to store v and returns a pointer to it.
CheckResponse checks the API response for errors, and returns them if present.
Int is a helper routine that allocates a new int32 value to store v and returns a pointer to it, but unlike Int32 its argument value is an int.
NewClient returns a new GitHub API client.
String is a helper routine that allocates a new string value to store v and returns a pointer to it.
Stringify attempts to create a reasonable string representation of types in the GitHub library.
# Structs
ActivityListStarredOptions specifies the optional parameters to the ActivityService.ListStarred method.
ActivityService handles communication with the activity related methods of the GitHub API.
APIMeta represents metadata about the GitHub API.
Blob represents a blob object.
Branch represents a repository branch.
A Client manages communication with the GitHub API.
CodeResult represents a single search result.
CodeSearchResult represents the result of an code search.
Commit represents a GitHub commit.
CommitAuthor represents the author or committer of a commit.
CommitFile represents a file modified in a commit.
CommitsComparison is the result of comparing two commits.
CommitsListOptions specifies the optional parameters to the RepositoriesService.ListCommits method.
CommitStats represents the number of additions / deletions from a file in a given RepositoryCommit.
Contributor represents a repository contributor.
ContributorStats represents a contributor to a repository and their weekly contributions to a given repo.
An Error reports more details on an individual error in an ErrorResponse.
An ErrorResponse reports one or more errors caused by an API request.
Event represents a GitHub event.
Gist represents a GitHub's gist.
GistComment represents a Gist comment.
GistFile represents a file on a gist.
GistListOptions specifies the optional parameters to the GistsService.List, GistsService.ListAll, and GistsService.ListStarred methods.
GistsService handles communication with the Gist related methods of the GitHub API.
Gitignore represents a .gitignore file as returned by the GitHub API.
GitignoresService provides access to the gitignore related functions in the GitHub API.
GitObject represents a Git object.
GitService handles communication with the git data related methods of the GitHub API.
Hook represents a GitHub (web and service) hook for a repository.
Issue represents a GitHub issue on a repository.
IssueComment represents a comment left on an issue.
IssueEvent represents an event that occurred around an Issue or Pull Request.
IssueListByRepoOptions specifies the optional parameters to the IssuesService.ListByRepo method.
IssueListCommentsOptions specifies the optional parameters to the IssuesService.ListComments method.
IssueListOptions specifies the optional parameters to the IssuesService.List and IssuesService.ListByOrg methods.
IssueRequest represents a request to create/edit an issue.
IssuesSearchResult represents the result of an issues search.
IssuesService handles communication with the issue related methods of the GitHub API.
Key represents a public SSH key used to authenticate a user or deploy script.
Label represents a GitHib label on an Issue.
ListContributorsOptions specifies the optional parameters to the RepositoriesService.ListContributors method.
ListMembersOptions specifies optional parameters to the OrganizationsService.ListMembers method.
ListOptions specifies the optional parameters to various List methods that support pagination.
MarkdownOptions specifies optional parameters to the Markdown method.
Match represents a single text match.
Milestone represents a Github repository milestone.
MilestoneListOptions specifies the optional parameters to the IssuesService.ListMilestones method.
Notification identifies a GitHub notification for a user.
NotificationListOptions specifies the optional parameters to the ActivityService.ListNotifications method.
NotificationSubject identifies the subject of a notification.
Organization represents a GitHub organization account.
OrganizationsService provides access to the organization related functions in the GitHub API.
Pages represents a GitHub Pages site configuration.
PagesBuild represents the build information for a GitHub Pages site.
PagesError represents a build error for a GitHub Pages site.
Plan represents the payment plan for an account.
PullRequest represents a GitHub pull request on a repository.
PullRequestComment represents a comment left on a pull request.
PullRequestListCommentsOptions specifies the optional parameters to the PullRequestsService.ListComments method.
PullRequestListOptions specifies the optional parameters to the PullRequestsService.List method.
PullRequestMergeResult represents the result of merging a pull request.
PullRequestsService handles communication with the pull request related methods of the GitHub API.
PunchCard respresents the number of commits made during a given hour of a day of thew eek.
PushEvent represents a git push to a GitHub repository.
PushEventCommit represents a git commit in a GitHub PushEvent.
Rate represents the rate limit for the current client.
RateLimits represents the rate limits for the current client.
Reference represents a GitHub reference.
ReferenceListOptions specifies optional parameters to the GitService.ListRefs method.
ReleaseAsset represents a Github release asset in a repository.
RepositoriesSearchResult represents the result of a repositories search.
RepositoriesService handles communication with the repository related methods of the GitHub API.
Repository represents a GitHub repository.
RepositoryComment represents a comment for a commit, file, or line in a repository.
RepositoryCommit represents a commit in a repo.
RepositoryContent represents a file or directory in a github repository.
RepositoryContentFileOptions specifies optional parameters for CreateFile, UpdateFile, and DeleteFile.
RepositoryContentGetOptions represents an optional ref parameter, which can be a SHA, branch, or tag.
RepositoryContentResponse holds the parsed response from CreateFile, UpdateFile, and DeleteFile.
RepositoryCreateForkOptions specifies the optional parameters to the RepositoriesService.CreateFork method.
RepositoryListAllOptions specifies the optional parameters to the RepositoriesService.ListAll method.
RepositoryListByOrgOptions specifies the optional parameters to the RepositoriesService.ListByOrg method.
RepositoryListForksOptions specifies the optional parameters to the RepositoriesService.ListForks method.
RepositoryListOptions specifies the optional parameters to the RepositoriesService.List method.
RepositoryMergeRequest represents a request to merge a branch in a repository.
RepositoryParticipation is the number of commits by everyone who has contributed to the repository (including the owner) as well as the number of commits by the owner themself.
RepositoryRelease represents a GitHub release in a repository.
RepositoryTag represents a repository tag.
RepoStatus represents the status of a repository at a particular reference.
Response is a GitHub API response.
SearchOptions specifies optional parameters to the SearchService methods.
SearchService provides access to the search related functions in the GitHub API.
ServiceHook represents a hook that has configuration settings, a list of available events, and default events.
Subscription identifies a repository or thread subscription.
Tag represents a tag object.
Team represents a team within a GitHub organization.
TextMatch represents a text match for a SearchResult.
Timestamp represents a time that can be unmarshalled from a JSON string formatted as either an RFC3339 or Unix timestamp.
Tree represents a GitHub tree.
TreeEntry represents the contents of a tree structure.
UnauthenticatedRateLimitedTransport allows you to make unauthenticated calls
that need to use a higher rate limit associated with your OAuth application.
UploadOptions specifies the parameters to methods that support uploads.
User represents a GitHub user.
UserEmail represents user's email address.
UserListOptions specifies optional parameters to the UsersService.List method.
UsersSearchResult represents the result of an issues search.
UsersService handles communication with the user related methods of the GitHub API.
WebHookAuthor represents the author or committer of a commit, as specified in a WebHookCommit.
WebHookCommit represents the commit variant we receive from GitHub in a WebHookPayload.
WebHookPayload represents the data that is received from GitHub when a push event hook is triggered.
WeeklyCommitActivity represents the weekly commit activity for a repository.
WeeklyStats represents the number of additions, deletions and commits a Contributor made in a given week.
# Type aliases
GistFilename represents filename on a gist.