# 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.
DeliveryID returns the unique delivery ID of webhook request r.
Int is a helper routine that allocates a new int value to store v and returns a pointer to it.
Int64 is a helper routine that allocates a new int64 value to store v and returns a pointer to it.
NewBranchNamePatternRule creates a rule to restrict branch patterns from being merged into matching branches.
NewClient returns a new GitHub API client.
NewClientWithEnvProxy enhances NewClient with the HttpProxy env.
NewCommitAuthorEmailPatternRule creates a rule to restrict commits with author email patterns being merged into matching branches.
NewCommitMessagePatternRule creates a rule to restrict commit message patterns being pushed to matching branches.
NewCommitterEmailPatternRule creates a rule to restrict commits with committer email patterns being merged into matching branches.
NewCreationRule creates a rule to only allow users with bypass permission to create matching refs.
NewDeletionRule creates a rule to only allow users with bypass permissions to delete matching refs.
NewEnterpriseClient returns a new GitHub API client with provided base URL and upload URL (often is your GitHub Enterprise hostname).
NewNonFastForwardRule creates a rule as part to prevent users with push access from force pushing to matching branches.
NewPullRequestRule creates a rule to require all commits be made to a non-target branch and submitted via a pull request before they can be merged.
NewRequiredDeploymentsRule creates a rule to require environments to be successfully deployed before they can be merged into the matching branches.
NewRequiredLinearHistoryRule creates a rule to prevent merge commits from being pushed to matching branches.
NewRequiredSignaturesRule creates a rule a to require commits pushed to matching branches to have verified signatures.
NewRequiredStatusChecksRule creates a rule to require which status checks must pass before branches can be merged into a branch rule.
NewTagNamePatternRule creates a rule to restrict tag patterns contained in non-target branches from being merged into matching branches.
NewTokenClient returns a new GitHub API client authenticated with the provided token.
NewUpdateRule creates a rule to only allow users with bypass permission to update matching refs.
ParseWebHook parses the event payload.
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.
ValidatePayload validates an incoming GitHub Webhook event request and returns the (JSON) payload.
ValidatePayloadFromBody validates an incoming GitHub Webhook event request body and returns the (JSON) payload.
ValidateSignature validates the signature for the given payload.
WebHookType returns the event type of webhook request r.
WithVersion overrides the GitHub v3 API version for this individual request.
# Constants
DeliveryIDHeader is the GitHub header key used to pass the unique ID for the webhook event.
Diff format.
EventTypeHeader is the GitHub header key used to pass the event type.
Patch format.
This is the set of scopes for GitHub API V3.
This is the set of scopes for GitHub API V3.
This is the set of scopes for GitHub API V3.
This is the set of scopes for GitHub API V3.
This is the set of scopes for GitHub API V3.
This is the set of scopes for GitHub API V3.
This is the set of scopes for GitHub API V3.
REVISIT: is this actually returned, or just a documentation artifact?.
This is the set of scopes for GitHub API V3.
This is the set of scopes for GitHub API V3.
This is the set of scopes for GitHub API V3.
This is the set of scopes for GitHub API V3.
This is the set of scopes for GitHub API V3.
This is the set of scopes for GitHub API V3.
This is the set of scopes for GitHub API V3.
This is the set of scopes for GitHub API V3.
This is the set of scopes for GitHub API V3.
This is the set of scopes for GitHub API V3.
This is the set of scopes for GitHub API V3.
This is the set of scopes for GitHub API V3.
This is the set of scopes for GitHub API V3.
This is the set of scopes for GitHub API V3.
This is the set of scopes for GitHub API V3.
This is the set of scopes for GitHub API V3.
This is the set of scopes for GitHub API V3.
SHA1SignatureHeader is the GitHub header key used to pass the HMAC-SHA1 hexdigest.
SHA256SignatureHeader is the GitHub header key used to pass the HMAC-SHA256 hexdigest.
Tarball specifies an archive in gzipped tar format.
No description provided by the author
Zipball specifies an archive in zip format.
# Variables
No description provided by the author
No description provided by the author
# Structs
AbuseRateLimitError occurs when GitHub returns 403 Forbidden response with the "documentation_url" field value equal to "https://docs.github.com/en/rest/overview/resources-in-the-rest-api#secondary-rate-limits".
AcceptedError occurs when GitHub returns 202 Accepted response with an empty body, which means a job was scheduled on the GitHub side to process the information needed and cache it.
ActionBilling represents a GitHub Action billing.
ActionsAllowed represents selected actions that are allowed.
ActionsCache represents a GitHub action cache.
ActionsCacheList represents a list of GitHub actions Cache.
ActionsCacheListOptions represents a list of all possible optional Query parameters for ListCaches method.
ActionsCacheUsage represents a GitHub Actions Cache Usage object.
ActionsCacheUsageList represents a list of repositories with GitHub Actions cache usage for an organization.
ActionsEnabledOnOrgRepos represents all the repositories in an organization for which Actions is enabled.
ActionsPermissions represents a policy for repositories and allowed actions in an organization.
ActionsPermissionsRepository represents a policy for repositories and allowed actions in a repository.
ActionsVariable represents a repository action variable.
ActionsVariables represents one item from the ListVariables response.
ActiveCommitters represents the total active committers across all repositories in an Organization.
ActivityListStarredOptions specifies the optional parameters to the ActivityService.ListStarred method.
ActorLocation contains information about reported location for an actor.
AdminEnforcedChanges represents the changes made to the AdminEnforced policy.
AdminEnforcement represents the configuration to enforce required status checks for repository administrators.
AdminStats represents a variety of stats of a GitHub Enterprise installation.
AdvancedSecurity specifies the state of advanced security on a repository.
AdvancedSecurityCommittersBreakdown represents the user activity breakdown for ActiveCommitters.
AdvisoryCVSs represents the advisory pertaining to the Common Vulnerability Scoring System.
AdvisoryCWEs reprensent the advisory pertaining to Common Weakness Enumeration.
AdvisoryIdentifier represents the identifier for a Security Advisory.
AdvisoryReference represents the reference url for the security advisory.
AdvisoryVulnerability represents the vulnerability object for a Security Advisory.
Alert represents an individual GitHub Code Scanning Alert on a single repository.
AlertListOptions specifies optional parameters to the CodeScanningService.ListAlerts method.
AllowDeletions represents the configuration to accept deletion of protected branches.
AllowDeletionsEnforcementLevelChanges represents the changes made to the AllowDeletionsEnforcementLevel policy.
AllowForcePushes represents the configuration to accept forced pushes on protected branches.
AllowForkSyncing represents whether users can pull changes from upstream when the branch is locked.
AnalysesListOptions specifies optional parameters to the CodeScanningService.ListAnalysesForRepo method.
APIMeta represents metadata about the GitHub API.
App represents a GitHub App.
AppConfig describes the configuration of a GitHub App.
Artifact represents a GitHub artifact.
ArtifactList represents a list of GitHub artifacts.
ArtifactWorkflowRun represents a GitHub artifact's workflow run.
Attachment represents a GitHub Apps attachment.
AuditEntry describes the fields that may be represented by various audit-log "action" entries.
Authorization represents an individual GitHub authorization.
AuthorizationApp represents an individual GitHub app (in the context of authorization).
AuthorizationRequest represents a request to create an authorization.
AuthorizationUpdateRequest represents a request to update an authorization.
AuthorizedActorNames represents who are authorized to edit the branch protection rules.
AuthorizedActorsOnly represents if the branch rule can be edited by authorized actors only.
AuthorizedDismissalActorsOnlyChanges represents the changes made to the AuthorizedDismissalActorsOnly policy.
Autolink represents autolinks to external resources like JIRA issues and Zendesk tickets.
AutolinkOptions specifies parameters for RepositoriesService.AddAutolink method.
AutoTriggerCheck enables or disables automatic creation of CheckSuite events upon pushes to the repository.
BasicAuthTransport is an http.RoundTripper that authenticates all requests using HTTP Basic Authentication with the provided username and password.
Blob represents a blob object.
BlockCreations represents whether users can push changes that create branches.
Branch represents a repository branch.
BranchCommit is the result of listing branches with commit SHA.
BranchListOptions specifies the optional parameters to the RepositoriesService.ListBranches method.
BranchPolicy represents the options for whether a branch deployment policy is applied to this environment.
BranchProtectionRule represents the rule applied to a repositories branch.
BranchProtectionRuleEvent triggered when a check suite is "created", "edited", or "deleted".
BranchRestrictions represents the restriction that only certain users or teams may push to a branch.
BranchRestrictionsRequest represents the request to create/edit the restriction that only certain users or teams may push to a branch.
BypassActor represents the bypass actors from a ruleset.
BypassPullRequestAllowances represents the people, teams, or apps who are allowed to bypass required pull requests.
BypassPullRequestAllowancesRequest represents the people, teams, or apps who are allowed to bypass required pull requests.
CheckRun represents a GitHub check run on a repository associated with a GitHub app.
CheckRunAction exposes further actions the integrator can perform, which a user may trigger.
CheckRunAnnotation represents an annotation object for a CheckRun output.
CheckRunEvent is triggered when a check run is "created", "completed", or "rerequested".
CheckRunImage represents an image object for a CheckRun output.
CheckRunOutput represents the output of a CheckRun.
CheckSuite represents a suite of check runs.
CheckSuiteEvent is triggered when a check suite is "completed", "requested", or "rerequested".
CheckSuitePreferenceOptions set options for check suite preferences for a repository.
CheckSuitePreferenceResults represents the results of the preference set operation.
A Client manages communication with the GitHub API.
CodeOfConduct represents a code of conduct.
CodeownersError represents a syntax error detected in the CODEOWNERS file.
CodeownersErrors represents a list of syntax errors detected in the CODEOWNERS file.
CodeResult represents a single search result.
CodeScanningAlertEvent is triggered when a code scanning finds a potential vulnerability or error in your code.
CodeScanningAlertState specifies the state of a code scanning alert.
CodeSearchResult represents the result of a code search.
Codespace represents a codespace.
CodespacesGitStatus represents the git status of a codespace.
CodespacesMachine represents the machine type of a codespace.
CodespacesRuntimeConstraints represents the runtime constraints of a codespace.
CollaboratorInvitation represents an invitation created when adding a collaborator.
CombinedStatus represents the combined status of a repository at a particular reference.
Comment represents comments of issue to import.
CommentDiscussion represents a comment in a GitHub DiscussionCommentEvent.
CommentStats represents the number of total comments on commits, gists, issues and pull requests.
Commit represents a GitHub commit.
CommitAuthor represents the author or committer of a commit.
CommitCommentEvent is triggered when a commit comment is created.
CommitFile represents a file modified in a commit.
CommitResult represents a commit object as returned in commit search endpoint response.
CommitsComparison is the result of comparing two commits.
CommitsListOptions specifies the optional parameters to the RepositoriesService.ListCommits method.
CommitsSearchResult represents the result of a commits search.
CommitStats represents the number of additions / deletions from a file in a given RepositoryCommit or GistCommit.
CommunityHealthFiles represents the different files in the community health metrics response.
CommunityHealthMetrics represents a response containing the community metrics of a repository.
ContentReference represents a reference to a URL in an issue or pull request.
ContentReferenceEvent is triggered when the body or comment of an issue or pull request includes a URL that matches a configured content reference domain.
Contributor represents a repository contributor.
ContributorStats represents a contributor to a repository and their weekly contributions to a given repo.
CreateCheckRunOptions sets up parameters needed to create a CheckRun.
CreateCheckSuiteOptions sets up parameters to manually create a check suites.
CreateCodespaceOptions represents options for the creation of a codespace in a repository.
CreateEvent represents a created repository, branch, or tag.
CreateOrgInvitationOptions specifies the parameters to the OrganizationService.Invite method.
CreateOrUpdateCustomRoleOptions represents options required to create or update a custom repository role.
CreateProtectedChanges represents the changes made to the CreateProtected policy.
CreateRunnerGroupRequest represents a request to create a Runner group for an organization.
CreateUpdateEnvironment represents the fields required for the create/update operation following the Create/Update release example.
CreateUpdateRequiredWorkflowOptions represents the input object used to create or update required workflows.
CreateUserProjectOptions specifies the parameters to the UsersService.CreateProject method.
CreateWorkflowDispatchEventRequest represents a request to create a workflow dispatch event.
CustomRepoRoles represents custom repository roles for an organization.
DefaultSetupConfiguration represents a code scanning default setup configuration.
DeleteEvent represents a deleted branch or tag.
DependabotAlert represents a Dependabot alert.
DependabotEncryptedSecret represents a secret that is encrypted using a public key for Dependabot.
DependabotSecurityAdvisory represents the GitHub Security Advisory.
Dependency reprensents the vulnerable dependency.
DeployKeyEvent is triggered when a deploy key is added or removed from a repository.
Deployment represents a deployment in a repo.
DeploymentBranchPolicy represents a single deployment branch policy for an environment.
DeploymentBranchPolicyRequest represents a deployment branch policy request.
DeploymentBranchPolicyResponse represents the slightly different format of response that comes back when you list deployment branch policies.
DeploymentEvent represents a deployment.
DeploymentProtectionRuleEvent represents a deployment protection rule event.
DeploymentRequest represents a deployment request.
DeploymentsListOptions specifies the optional parameters to the RepositoriesService.ListDeployments method.
DeploymentStatus represents the status of a particular deployment.
DeploymentStatusEvent represents a deployment status.
DeploymentStatusRequest represents a deployment request.
Discussion represents a discussion in a GitHub DiscussionEvent.
DiscussionCategory represents a discussion category in a GitHub DiscussionEvent.
DiscussionComment represents a GitHub dicussion in a team.
DiscussionCommentEvent represents a webhook event for a comment on discussion.
DiscussionCommentListOptions specifies optional parameters to the TeamServices.ListComments method.
DiscussionEvent represents a webhook event for a discussion.
DiscussionListOptions specifies optional parameters to the TeamServices.ListDiscussions method.
DismissalRestrictions specifies which users and teams can dismiss pull request reviews.
DismissalRestrictionsRequest represents the request to create/edit the restriction to allows only specific users, teams or apps to dimiss pull request reviews.
DismissedReview represents details for 'dismissed_review' events.
DismissStaleReviewsOnPushChanges represents the changes made to the DismissStaleReviewsOnPushChanges policy.
DispatchRequestOptions represents a request to trigger a repository_dispatch event.
DraftReviewComment represents a comment part of the review.
EditBase represents the change of a pull-request base branch.
EditBody represents a change of pull-request body.
EditChange represents the changes when an issue, pull request, comment, or repository has been edited.
EditOwner represents a change of repository ownership.
EditRef represents a ref change of a pull-request.
EditRepo represents a change of repository name.
EditSHA represents a sha change of a pull-request.
EditTitle represents a pull-request title change.
EncryptedSecret represents a secret that is encrypted using a public key.
Enterprise represents the GitHub enterprise profile.
EnterpriseSecurityAnalysisSettings represents security analysis settings for an enterprise.
Environment represents a single environment in a repository.
EnvironmentListOptions specifies the optional parameters to the RepositoriesService.ListEnvironments method.
EnvResponse represents the slightly different format of response that comes back when you list an environment.
EnvReviewers represents a single environment reviewer entry.
An Error reports more details on an individual error in an ErrorResponse.
ErrorBlock contains a further explanation for the reason of an error.
An ErrorResponse reports one or more errors caused by an API request.
Event represents a GitHub event.
ExternalGroup represents an external group.
ExternalGroupList represents a list of external groups.
ExternalGroupMember represents a member of an external group.
ExternalGroupTeam represents a team connected to an external group.
FeedLink represents a link to a related resource.
FeedLinks represents the links in a Feed.
Feeds represents timeline resources in Atom format.
FirstPatchedVersion represents the identifier for the first patched version of that vulnerability.
ForkEvent is triggered when a user forks a repository.
GenerateJITConfigRequest specifies body parameters to GenerateRepoJITConfig.
GenerateNotesOptions represents the options to generate release notes.
GetAuditLogOptions sets up optional parameters to query audit-log endpoint.
Gist represents a GitHub's gist.
GistComment represents a Gist comment.
GistCommit represents a commit on a gist.
GistFile represents a file on a gist.
GistFork represents a fork of a gist.
GistListOptions specifies the optional parameters to the GistsService.List, GistsService.ListAll, and GistsService.ListStarred methods.
GistStats represents the number of total, private and public gists.
GitHubAppAuthorizationEvent is triggered when a user's authorization for a GitHub Application is revoked.
Gitignore represents a .gitignore file as returned by the GitHub API.
GitObject represents a Git object.
GollumEvent is triggered when a Wiki page is created or updated.
GPGEmail represents an email address associated to a GPG key.
GPGKey represents a GitHub user's public GPG key used to verify GPG signed commits and tags.
Grant represents an OAuth application that has been granted access to an account.
HeadCommit represents a git commit in a GitHub PushEvent.
Hook represents a GitHub (web and service) hook for a repository.
HookConfig describes metadata about a webhook configuration.
HookDelivery represents the data that is received from GitHub's Webhook Delivery API
GitHub API docs: - https://docs.github.com/en/rest/webhooks/repo-deliveries#list-deliveries-for-a-repository-webhook - https://docs.github.com/en/rest/webhooks/repo-deliveries#get-a-delivery-for-a-repository-webhook.
HookRequest is a part of HookDelivery that contains the HTTP headers and the JSON payload of the webhook request.
HookResponse is a part of HookDelivery that contains the HTTP headers and the response body served by the webhook endpoint.
HookStats represents the number of total, active and inactive hooks.
Hovercard represents hovercard information about a user.
HovercardOptions specifies optional parameters to the UsersService.GetHovercard method.
IDPGroup represents an external identity provider (IDP) group.
IDPGroupList represents a list of external identity provider (IDP) groups.
ImpersonateUserOptions represents the scoping for the OAuth token.
Import represents a repository import request.
Installation represents a GitHub Apps installation.
InstallationEvent is triggered when a GitHub App has been installed, uninstalled, suspend, unsuspended or new permissions have been accepted.
InstallationPermissions lists the repository and organization permissions for an installation.
InstallationRepositoriesEvent is triggered when a repository is added or removed from an installation.
InstallationToken represents an installation token.
InstallationTokenOptions allow restricting a token's access to specific repositories.
InteractionRestriction represents the interaction restrictions for repository and organization.
Invitation represents a team member's invitation status.
Issue represents a GitHub issue on a repository.
IssueComment represents a comment left on an issue.
IssueCommentEvent is triggered when an issue comment is created on an issue or pull request.
IssueEvent represents an event that occurred around an Issue or Pull Request.
IssueImport represents body of issue to import.
IssueImportError represents errors of an issue import create request.
IssueImportRequest represents a request to create an issue.
IssueImportResponse represents the response of an issue import create 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.
IssuesEvent is triggered when an issue is opened, edited, deleted, transferred, pinned, unpinned, closed, reopened, assigned, unassigned, labeled, unlabeled, locked, unlocked, milestoned, or demilestoned.
IssuesSearchResult represents the result of an issues search.
IssueStats represents the number of total, open and closed issues.
JITRunnerConfig represents encoded JIT configuration that can be used to bootstrap a self-hosted runner.
Jobs represents a slice of repository action workflow job.
Key represents a public SSH key used to authenticate a user or deploy script.
Label represents a GitHub label on an Issue.
LabelEvent is triggered when a repository's label is created, edited, or deleted.
LabelResult represents a single search result.
LabelsSearchResult represents the result of a code search.
LargeFile identifies a file larger than 100MB found during a repository import.
License represents an open source license.
LinearHistoryRequirementEnforcementLevelChanges represents the changes made to the LinearHistoryRequirementEnforcementLevel policy.
ListAlertsOptions specifies the optional parameters to the DependabotService.ListRepoAlerts and DependabotService.ListOrgAlerts methods.
ListCheckRunsOptions represents parameters to list check runs.
ListCheckRunsResults represents the result of a check run list.
ListCheckSuiteOptions represents parameters to list check suites.
ListCheckSuiteResults represents the result of a check run list.
ListCodespaces represents the response from the list codespaces endpoints.
ListOptions represents the options for listing codespaces for a user.
ListCollaboratorOptions specifies the optional parameters to the ProjectsService.ListProjectCollaborators method.
ListCollaboratorsOptions specifies the optional parameters to the RepositoriesService.ListCollaborators method.
ListCommentReactionOptions specifies the optional parameters to the ReactionsService.ListCommentReactions method.
ListContributorsOptions specifies the optional parameters to the RepositoriesService.ListContributors method.
ListCursorOptions specifies the optional parameters to various List methods that support cursor pagination.
ListExternalGroupsOptions specifies the optional parameters to the TeamsService.ListExternalGroups method.
ListMembersOptions specifies optional parameters to the OrganizationsService.ListMembers method.
ListOptions specifies the optional parameters to various List methods that support offset pagination.
ListOrgMembershipsOptions specifies optional parameters to the OrganizationsService.ListOrgMemberships method.
ListOrgRunnerGroupOptions extend ListOptions to have the optional parameters VisibleToRepository.
ListOutsideCollaboratorsOptions specifies optional parameters to the OrganizationsService.ListOutsideCollaborators method.
ListRepositories represents the response from the list repos endpoints.
ListSCIMProvisionedIdentitiesOptions represents options for ListSCIMProvisionedIdentities.
ListWorkflowJobsOptions specifies optional parameters to ListWorkflowJobs.
ListWorkflowRunsOptions specifies optional parameters to ListWorkflowRuns.
Location represents the exact location of the GitHub Code Scanning Alert in the scanned project.
LockBranch represents if the branch is marked as read-only.
LockIssueOptions specifies the optional parameters to the IssuesService.Lock method.
MarkdownOptions specifies optional parameters to the Markdown method.
MarketplacePendingChange represents a pending change to a GitHub Apps Marketplace Plan.
MarketplacePlan represents a GitHub Apps Marketplace Listing Plan.
MarketplacePlanAccount represents a GitHub Account (user or organization) on a specific plan.
MarketplacePurchase represents a GitHub Apps Marketplace Purchase.
MarketplacePurchaseAccount represents a GitHub Account (user or organization) for a Purchase.
MarketplacePurchaseEvent is triggered when a user purchases, cancels, or changes their GitHub Marketplace plan.
MarketplaceService handles communication with the marketplace related methods of the GitHub API.
Match represents a single text match.
MemberEvent is triggered when a user is added as a collaborator to a repository.
Membership represents the status of a user's membership in an organization or team.
MembershipEvent is triggered when a user is added or removed from a team.
MergeGroup represents the merge group in a merge queue.
MergeGroupEvent represents activity related to merge groups in a merge queue.
Message is a part of MostRecentInstance struct which provides the appropriate message when any action is performed on the analysis object.
MetaEvent is triggered when the webhook that this event is configured on is deleted.
Metric represents the different fields for one file in community health files.
Migration represents a GitHub migration (archival).
MigrationOptions specifies the optional parameters to Migration methods.
Milestone represents a GitHub repository milestone.
MilestoneEvent is triggered when a milestone is created, closed, opened, edited, or deleted.
MilestoneListOptions specifies the optional parameters to the IssuesService.ListMilestones method.
MilestoneStats represents the number of total, open and close milestones.
MostRecentInstance provides details of the most recent instance of this alert for the default branch or for the specified Git reference.
NewPullRequest represents a new pull request to be created.
NewTeam represents a team to be created or modified.
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.
OAuthAPP represents the GitHub Site Administrator OAuth app.
OIDCSubjectClaimCustomTemplate represents an OIDC subject claim customization template.
Organization represents a GitHub organization account.
OrganizationCustomRepoRoles represents custom repository roles available in specified organization.
OrganizationEvent is triggered when an organization is deleted and renamed, and when a user is added, removed, or invited to an organization.
OrganizationInstallations represents GitHub app installations for an organization.
OrganizationsListOptions specifies the optional parameters to the OrganizationsService.ListAll method.
OrgBlockEvent is triggered when an organization blocks or unblocks a user.
OrgRequiredWorkflow represents a required workflow object at the org level.
OrgRequiredWorkflows represents the required workflows for the org.
OrgStats represents the number of total, disabled organizations and the team and team member count.
OwnerInfo represents the account info of the owner of the repo (could be User or Organization but both are User structs).
Package represents a GitHub package.
PackageBilling represents a GitHub Package billing.
PackageContainerMetadata represents container metadata for docker container packages.
PackageEvent represents activity related to GitHub Packages.
PackageFile represents a GitHub package version release file.
PackageListOptions represents the optional list options for a package.
PackageMetadata represents metadata from a package.
PackageRegistry represents a GitHub package registry.
PackageRelease represents a GitHub package version release.
PackageVersion represents a GitHub package version.
Page represents a single Wiki page.
PageBuildEvent represents an attempted build of a GitHub Pages site, whether successful or not.
Pages represents a GitHub Pages site configuration.
PagesBuild represents the build information for a GitHub Pages site.
PagesDomain represents a domain associated with a GitHub Pages site.
PagesError represents a build error for a GitHub Pages site.
PagesHealthCheckResponse represents the response given for the health check of a GitHub Pages site.
PagesHTTPSCertificate represents the HTTPS Certificate information for a GitHub Pages site.
PagesSource represents a GitHub page's source.
PageStats represents the total number of github pages.
PagesUpdate sets up parameters needed to update a GitHub Pages site.
PendingDeploymentsRequest specifies body parameters to PendingDeployments.
PingEvent is triggered when a Webhook is added to GitHub.
Plan represents the payment plan for an account.
PolicyOverrideReason contains user-supplied information about why a policy was overridden.
PreferenceList represents a list of auto trigger checks for repository.
PreReceiveHook represents a GitHub pre-receive hook for a repository.
PRLink represents a single link object from GitHub pull request _links.
PRLinks represents the "_links" object in a GitHub pull request.
Project represents a GitHub Project.
ProjectBody represents a project body change.
ProjectCard represents a card in a column of a GitHub Project.
ProjectCardChange represents the changes when a project card has been edited.
ProjectCardEvent is triggered when a project card is created, updated, moved, converted to an issue, or deleted.
ProjectCardListOptions specifies the optional parameters to the ProjectsService.ListProjectCards method.
ProjectCardMoveOptions specifies the parameters to the ProjectsService.MoveProjectCard method.
ProjectCardNote represents a change of a note of a project card.
ProjectCardOptions specifies the parameters to the ProjectsService.CreateProjectCard and ProjectsService.UpdateProjectCard methods.
ProjectChange represents the changes when a project has been edited.
ProjectCollaboratorOptions specifies the optional parameters to the ProjectsService.AddProjectCollaborator method.
ProjectColumn represents a column of a GitHub Project.
ProjectColumnChange represents the changes when a project column has been edited.
ProjectColumnEvent is triggered when a project column is created, updated, moved, or deleted.
ProjectColumnMoveOptions specifies the parameters to the ProjectsService.MoveProjectColumn method.
ProjectColumnName represents a project column name change.
ProjectColumnOptions specifies the parameters to the ProjectsService.CreateProjectColumn and ProjectsService.UpdateProjectColumn methods.
ProjectEvent is triggered when project is created, modified or deleted.
ProjectListOptions specifies the optional parameters to the OrganizationsService.ListProjects and RepositoriesService.ListProjects methods.
ProjectName represents a project name change.
ProjectOptions specifies the parameters to the RepositoriesService.CreateProject and ProjectsService.UpdateProject methods.
ProjectPermissionLevel represents the permission level an organization member has for a given project.
Protection represents a repository branch's protection.
ProtectionChanges represents the changes to the rule if the BranchProtection was edited.
ProtectionRequest represents a request to create/edit a branch's protection.
ProtectionRule represents a single protection rule applied to the environment.
PublicEvent is triggered when a private repository is open sourced.
PublicKey represents the public key that should be used to encrypt secrets.
PullRequest represents a GitHub pull request on a repository.
PullRequestAutoMerge represents the "auto_merge" response for a PullRequest.
PullRequestBranch represents a base or head branch in a GitHub pull request.
PullRequestBranchUpdateOptions specifies the optional parameters to the PullRequestsService.UpdateBranch method.
PullRequestBranchUpdateResponse specifies the response of pull request branch update.
PullRequestComment represents a comment left on a pull request.
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.
PullRequestLinks object is added to the Issue object when it's an issue included in the IssueCommentEvent webhook payload, if the webhook is fired by a comment on a PR.
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.
PullRequestOptions lets you define how a pull request will be merged.
PullRequestReview represents a review of a pull request.
PullRequestReviewCommentEvent is triggered when a comment is created on a portion of the unified diff of a pull request.
PullRequestReviewDismissalRequest represents a request to dismiss a review.
PullRequestReviewEvent is triggered when a review is submitted on a pull request.
PullRequestReviewRequest represents a request to create a review.
PullRequestReviewsEnforcement represents the pull request reviews enforcement of a protected branch.
PullRequestReviewsEnforcementLevelChanges represents the changes made to the PullRequestReviewsEnforcementLevel policy.
PullRequestReviewsEnforcementRequest represents request to set the pull request review enforcement of a protected branch.
PullRequestReviewsEnforcementUpdate represents request to patch the pull request review enforcement of a protected branch.
PullRequestReviewThreadEvent is triggered when a comment made as part of a review of a pull request is marked resolved or unresolved.
PullRequestRuleParameters represents the pull_request rule parameters.
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.
PullRequestThread represents a thread of comments on a pull request.
PullStats represents the number of total, merged, mergable and unmergeable pull-requests.
PunchCard represents the number of commits made during a given hour of a day of the week.
PushEvent represents a git push to a GitHub repository.
PushEventRepoOwner is a basic representation of user/org in a PushEvent payload.
PushEventRepository represents the repo object in a PushEvent payload.
Rate represents the rate limit for the current client.
RateLimitError occurs when GitHub returns 403 Forbidden response with a rate limit remaining value of 0.
RateLimits represents the rate limits for the current client.
RawOptions specifies parameters when user wants to get raw format of a response instead of JSON.
Reaction represents a GitHub reaction.
Reactions represents a summary of GitHub reactions.
Reference represents a GitHub reference.
ReferenceListOptions specifies optional parameters to the GitService.ListMatchingRefs method.
RegistrationToken represents a token that can be used to add a self-hosted runner to a repository.
ReleaseAsset represents a GitHub release asset in a repository.
ReleaseEvent is triggered when a release is published, unpublished, created, edited, deleted, or prereleased.
RemoveToken represents a token that can be used to remove a self-hosted runner from a repository.
Rename contains details for 'renamed' events.
RenameOrgResponse is the response given when renaming an Organization.
RepoMergeUpstreamRequest represents a request to sync a branch of a forked repository to keep it up-to-date with the upstream repository.
RepoMergeUpstreamResult represents the result of syncing a branch of a forked repository with the upstream repository.
RepoName represents a change of repository name.
RepoRequiredWorkflow represents a required workflow object at the repo level.
RepoRequiredWorkflows represents the required workflows for a repo.
RepositoriesSearchResult represents the result of a repositories search.
Repository represents a GitHub repository.
RepositoryActionsAccessLevel represents the repository actions access level.
RepositoryActiveCommitters represents active committers on each repository.
RepositoryAddCollaboratorOptions specifies the optional parameters to the RepositoriesService.AddCollaborator method.
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.
RepositoryDispatchEvent is triggered when a client sends a POST request to the repository dispatch event endpoint.
RepositoryEvent is triggered when a repository is created, archived, unarchived, renamed, edited, transferred, made public, or made private.
RepositoryImportEvent represents the activity related to a repository being imported to GitHub.
RepositoryInvitation represents an invitation to collaborate on a repo.
RepositoryLicense represents the license for a repository.
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.
RepositoryPermissionLevel represents the permission level an organization member has for a given repository.
RepositoryRelease represents a GitHub release in a repository.
RepositoryReleaseNotes represents a GitHub-generated release notes.
RepositoryRule represents a GitHub Rule.
RepositoryTag represents a repository tag.
RepositoryVulnerabilityAlert represents a repository security alert.
RepositoryVulnerabilityAlertEvent is triggered when a security alert is created, dismissed, or resolved.
RepoStats represents the number of total, root, fork, organization repositories together with the total number of pushes and wikis.
RepoStatus represents the status of a repository at a particular reference.
RequestedAction is included in a CheckRunEvent when a user has invoked an action, i.e.
RequireCodeOwnerReviewChanges represents the changes made to the RequireCodeOwnerReview policy.
RequiredConversationResolution, if enabled, requires all comments on the pull request to be resolved before it can be merged to a protected branch.
RequiredConversationResolutionLevelChanges represents the changes made to the RequiredConversationResolutionLevel policy.
RequiredDeploymentEnvironmentsRuleParameters represents the required_deployments rule parameters.
RequiredDeploymentsEnforcementLevelChanges represents the changes made to the RequiredDeploymentsEnforcementLevel policy.
RequiredReviewer represents a required reviewer.
RequiredStatusCheck represents a status check of a protected branch.
RequiredStatusChecks represents the protection status of a individual branch.
RequiredStatusChecksChanges represents the changes made to the RequiredStatusChecks policy.
RequiredStatusChecksEnforcementLevelChanges represents the changes made to the RequiredStatusChecksEnforcementLevel policy.
RequiredStatusChecksRequest represents a request to edit a protected branch's status checks.
RequiredStatusChecksRuleParameters represents the required_status_checks rule parameters.
RequiredWorkflowSelectedRepos represents the repos that a required workflow is applied to.
RequireLinearHistory represents the configuration to enforce branches with no merge commit.
Response is a GitHub API response.
Reviewers represents reviewers of a pull request.
ReviewersRequest specifies users and teams for a pull request review request.
Rule represents the complete details of GitHub Code Scanning alert type.
RulePatternParameters represents the rule pattern parameters.
RuleRequiredStatusChecks represents the RequiredStatusChecks for the RequiredStatusChecksRuleParameters object.
Ruleset represents a GitHub ruleset object.
RulesetCondition represents the conditions object in a ruleset.
RulesetLink represents a single link object from GitHub ruleset request _links.
RulesetLinks represents the "_links" object in a Ruleset.
RulesetRefConditionParameters represents the conditions object for ref_names.
RulesetRepositoryConditionParameters represents the conditions object for repository_names.
Runner represents a self-hosted runner registered with a repository.
RunnerApplicationDownload represents a binary for the self-hosted runner application that can be downloaded.
RunnerGroup represents a self-hosted runner group configured in an organization.
RunnerGroups represents a collection of self-hosted runner groups configured for an organization.
RunnerLabels represents a collection of labels attached to each runner.
Runners represents a collection of self-hosted runners for a repository.
SarifAnalysis specifies the results of a code scanning job.
SarifID identifies a sarif analysis upload.
ScanningAnalysis represents an individual GitHub Code Scanning ScanningAnalysis on a single repository.
SCIMMeta represents metadata about the SCIM resource.
SCIMProvisionedIdentities represents the result of calling ListSCIMProvisionedIdentities.
SCIMUserAttributes represents supported SCIM User attributes.
SCIMUserEmail represents SCIM user email.
SCIMUserName represents SCIM user information.
SearchOptions specifies optional parameters to the SearchService methods.
Secret represents a repository action secret.
Secrets represents one item from the ListSecrets response.
SecretScanning specifies the state of secret scanning on a repository.
SecretScanningAlert represents a GitHub secret scanning alert.
SecretScanningAlertEvent is triggered when a secret scanning alert occurs in a repository.
SecretScanningAlertListOptions specifies optional parameters to the SecretScanningService.ListAlertsForEnterprise method.
SecretScanningAlertLocation represents the location for a secret scanning alert.
SecretScanningAlertLocationDetails represents the location details for a secret scanning alert.
SecretScanningAlertUpdateOptions specifies optional parameters to the SecretScanningService.UpdateAlert method.
SecretScanningPushProtection specifies the state of secret scanning push protection on a repository.
SecurityAdvisory represents the advisory object in SecurityAdvisoryEvent payload.
SecurityAdvisoryEvent is triggered when a security-related vulnerability is found in software on GitHub.
SecurityAndAnalysis specifies the optional advanced security features that are enabled on a given repository.
SelectedReposList represents the list of repositories selected for an organization secret.
ServiceHook represents a hook that has configuration settings, a list of available events, and default events.
SetRepoAccessRunnerGroupRequest represents a request to replace the list of repositories that can access a self-hosted runner group configured in an organization.
SetRunnerGroupRunnersRequest represents a request to replace the list of self-hosted runners that are part of an organization runner group.
SignatureRequirementEnforcementLevelChanges represents the changes made to the SignatureRequirementEnforcementLevel policy.
SignaturesProtectedBranch represents the protection status of an individual branch.
SignatureVerification represents GPG signature verification.
Source represents a reference's source.
SourceImportAuthor identifies an author imported from a source repository.
SSHSigningKey represents a public SSH key used to sign git commits.
StarEvent is triggered when a star is added or removed from a repository.
Stargazer represents a user that has starred a repository.
StarredRepository is returned by ListStarred.
StatusEvent is triggered when the status of a Git commit changes.
StorageBilling represents a GitHub Storage billing.
Subscription identifies a repository or thread subscription.
Tag represents a tag object.
TagProtection represents a repository tag protection.
TaskStep represents a single task step from a sequence of tasks of a job.
Team represents a team within a GitHub organization.
TeamAddEvent is triggered when a repository is added to a team.
TeamAddTeamMembershipOptions specifies the optional parameters to the TeamsService.AddTeamMembership method.
TeamAddTeamRepoOptions specifies the optional parameters to the TeamsService.AddTeamRepoByID and TeamsService.AddTeamRepoBySlug methods.
TeamChange represents the changes when a team has been edited.
TeamDescription represents a team description change.
TeamDiscussion represents a GitHub dicussion in a team.
TeamEvent is triggered when an organization's team is created, modified or deleted.
TeamLDAPMapping represents the mapping between a GitHub team and an LDAP group.
TeamListTeamMembersOptions specifies the optional parameters to the TeamsService.ListTeamMembers method.
TeamName represents a team name change.
TeamPermissions represents a team permission change.
TeamPermissionsFrom represents a team permission change.
TeamPrivacy represents a team privacy change.
TeamProjectOptions specifies the optional parameters to the TeamsService.AddTeamProject method.
TeamRepository represents a team repository permission change.
TemplateRepoRequest represents a request to create a repository from a template.
TextMatch represents a text match for a SearchResult.
Timeline represents an event that occurred around an Issue or Pull Request.
Timestamp represents a time that can be unmarshalled from a JSON string formatted as either an RFC3339 or Unix timestamp.
Tool represents the tool used to generate a GitHub Code Scanning Alert.
No description provided by the author
TopicsSearchResult represents the result of a topics search.
TotalCacheUsage represents total GitHub actions cache usage of an organization or enterprise.
TrafficBreakdownOptions specifies the parameters to methods that support breakdown per day or week.
TrafficClones represent information about the number of clones in the last 14 days.
TrafficData represent information about a specific timestamp in views or clones list.
TrafficPath represent information about the traffic on a path of the repo.
TrafficReferrer represent information about traffic from a referrer .
TrafficViews represent information about the number of views in the last 14 days.
TransferRequest represents a request to transfer a repository.
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.
UpdateAllowsFetchAndMergeRuleParameters represents the update rule parameters.
UpdateAttributeForSCIMUserOperations represents operations for UpdateAttributeForSCIMUser.
UpdateAttributeForSCIMUserOptions represents options for UpdateAttributeForSCIMUser.
UpdateCheckRunOptions sets up parameters needed to update a CheckRun.
UpdateDefaultSetupConfigurationOptions specifies parameters to the CodeScanningService.UpdateDefaultSetupConfiguration method.
UpdateDefaultSetupConfigurationResponse represents a response from updating a code scanning default setup configuration.
UpdateRunnerGroupRequest represents a request to update a Runner group for an organization.
UploadOptions specifies the parameters to methods that support uploads.
User represents a GitHub user.
UserAuthorization represents the impersonation response.
UserContext represents the contextual information about user.
UserEmail represents user's email address.
UserEvent is triggered when a user is created or deleted.
UserLDAPMapping represents the mapping between a GitHub user and an LDAP user.
UserListOptions specifies optional parameters to the UsersService.ListAll method.
UserMigration represents a GitHub migration (archival).
UserMigrationOptions specifies the optional parameters to Migration methods.
UsersSearchResult represents the result of a users search.
UserStats represents the number of total, admin and suspended users.
UserSuspendOptions represents the reason a user is being suspended.
VulnerabilityPackage represents the package object for an Advisory Vulnerability.
WatchEvent is related to starring a repository, not watching.
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.
Workflow represents a repository action workflow.
WorkflowBill specifies billable time for a specific environment in a workflow.
WorkflowDispatchEvent is triggered when someone triggers a workflow run on GitHub or sends a POST request to the create a workflow dispatch event endpoint.
WorkflowJob represents a repository action workflow job.
WorkflowJobEvent is triggered when a job is queued, started or completed.
WorkflowRun represents a repository action workflow run.
WorkflowRunAttemptOptions specifies optional parameters to GetWorkflowRunAttempt.
WorkflowRunBill specifies billable time for a specific environment in a workflow run.
WorkflowRunEvent is triggered when a GitHub Actions workflow run is requested or completed.
WorkflowRunJobRun represents a usage of individual jobs of a specific workflow run.
WorkflowRuns represents a slice of repository action workflow run.
WorkflowRunUsage represents a usage of a specific workflow run.
Workflows represents a slice of repository action workflows.
WorkflowUsage represents a usage of a specific workflow.
# Type aliases
ActionsService handles communication with the actions related methods of the GitHub API.
ActivityService handles communication with the activity related methods of the GitHub API.
AdminService handles communication with the admin related methods of the GitHub API.
AppsService provides access to the installation related functions in the GitHub API.
ArchiveFormat is used to define the archive type when calling GetArchiveLink.
AuthorizationsService handles communication with the authorization related methods of the GitHub API.
BillingService provides access to the billing related functions in the GitHub API.
ChecksService provides access to the Checks API in the GitHub API.
CodeScanningService handles communication with the code scanning related methods of the GitHub API.
CodespacesService handles communication with the Codespaces related methods of the GitHub API.
DependabotSecretsSelectedRepoIDs are the repository IDs that have access to the dependabot secrets.
DependabotService handles communication with the Dependabot related methods of the GitHub API.
EnterpriseService provides access to the enterprise related functions in the GitHub API.
GistFilename represents filename on a gist.
GistsService handles communication with the Gist related methods of the GitHub API.
GitignoresService provides access to the gitignore related functions in the GitHub API.
GitService handles communication with the git data related methods of the GitHub API.
InteractionsService handles communication with the repository and organization related methods of the GitHub API.
IssueImportService handles communication with the issue import related methods of the Issue Import GitHub API.
IssuesService handles communication with the issue related methods of the GitHub API.
LicensesService handles communication with the license related methods of the GitHub API.
MigrationService provides access to the migration related functions in the GitHub API.
MinutesUsedBreakdown counts the actions minutes used by machine type (e.g.
OrganizationsService provides access to the organization related functions in the GitHub API.
ProjectsService provides access to the projects functions in the GitHub API.
PullRequestsService handles communication with the pull request related methods of the GitHub API.
RawType represents type of raw format of a request instead of JSON.
ReactionsService provides access to the reactions-related functions in the GitHub API.
RepositoriesService handles communication with the repository related methods of the GitHub API.
RequestOption represents an option that can modify an http.Request.
SCIMService provides access to SCIM related functions in the GitHub API.
Scope models a GitHub authorization scope.
SearchService provides access to the search related functions in the GitHub API.
SecretScanningService handles communication with the secret scanning related methods of the GitHub API.
SelectedRepoIDs are the repository IDs that have access to the actions secrets.
TeamsService provides access to the team-related functions in the GitHub API.
TwoFactorAuthError occurs when using HTTP Basic Authentication for a user that has two-factor authentication enabled.
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.
WorkflowBillMap represents different runner environments available for a workflow.
WorkflowRunBillMap represents different runner environments available for a workflow run.