gitoperationslib

package module

Go to main page

Versions in this module

v1

v1.9.0

Nov 12, 2026

Changes in this version

type Account

+ Webhooks func() UserWebhooks

type BranchProtections

+ Edit func(ctx context.Context, owner, repo, pattern string, rule BranchProtection) (*BranchProtection, error)

type CI

+ Artifacts func() WorkflowArtifacts

+ Runners func() Runners

+ Runs func() WorkflowRuns

type Capability

+ const CapCommitStatuses

type Client

+ Account func() Account

+ CI func() CI

+ Collaborators func() Collaborators

+ Commits func() Commits

+ GitHooks func() GitHooks

+ Mirrors func() Mirrors

+ Orgs func() Orgs

+ Site func() Site

+ Teams func() Teams

+ Users func() Users

type Collaborators

+ Add func(ctx context.Context, owner, repo, user string, ...) (invited bool, err error)

+ Get func(ctx context.Context, owner, repo, user string) (*Collaborator, error)

+ List func(ctx context.Context, owner, repo string, opts ListOptions) (Page[Collaborator], error)

+ ListInvitations func(ctx context.Context, owner, repo string, opts ListOptions) (Page[CollaboratorInvitation], error)

+ Remove func(ctx context.Context, owner, repo, user string) error

+ type CombinedStatus struct

+ SHA string

+ State StatusState

+ Statuses []CommitStatus

+ type CommitStatus struct

+ Check bool

+ Context string

+ CreatedAt time.Time

+ Description string

+ State StatusState

+ TargetURL string

+ UpdatedAt time.Time

type Commits

+ Diff func(ctx context.Context, owner, repo, ref string, format DiffFormat) (io.ReadCloser, error)

+ SetStatus func(ctx context.Context, owner, repo, sha string, status CommitStatus) error

+ Status func(ctx context.Context, owner, repo, ref string) (*CombinedStatus, error)

type GitHooks

+ Delete func(ctx context.Context, owner, repo, name string) error

+ Get func(ctx context.Context, owner, repo, name string) (*GitHook, error)

+ List func(ctx context.Context, owner, repo string) ([]GitHook, error)

+ Set func(ctx context.Context, owner, repo, name, content string) (*GitHook, error)

type Issues

+ Lock func(ctx context.Context, owner, repo string, number int, reason LockReason) error

+ Unlock func(ctx context.Context, owner, repo string, number int) error

type Labels

+ DeleteByID func(ctx context.Context, owner, repo string, id int64) error

+ EditByID func(ctx context.Context, owner, repo string, id int64, opts EditLabelOptions) (*Label, error)

type Mirrors

+ CreatePush func(ctx context.Context, owner, repo string, opts CreatePushMirrorOptions) (*PushMirror, error)

+ DeletePush func(ctx context.Context, owner, repo, name string) error

+ GetPush func(ctx context.Context, owner, repo, name string) (*PushMirror, error)

+ ListPush func(ctx context.Context, owner, repo string, opts ListOptions) (Page[PushMirror], error)

+ Sync func(ctx context.Context, owner, repo string) error

+ SyncPush func(ctx context.Context, owner, repo string) error

type OrgLabels

+ Create func(ctx context.Context, org string, label Label) (*Label, error)

+ Delete func(ctx context.Context, org string, id int64) error

+ Edit func(ctx context.Context, org string, id int64, opts EditLabelOptions) (*Label, error)

+ Get func(ctx context.Context, org string, id int64) (*Label, error)

+ List func(ctx context.Context, org string, opts ListOptions) (Page[Label], error)

type Orgs

+ DeleteAvatar func(ctx context.Context, org string) error

+ Info func(ctx context.Context, name string) (*OrgInfo, error)

+ Labels func() OrgLabels

+ SetAvatar func(ctx context.Context, org string, image io.Reader) error

type PullRequests

+ Commits func(ctx context.Context, owner, repo string, number int, opts ListOptions) (Page[Commit], error)

+ CreateReviewComment func(ctx context.Context, owner, repo string, number int, ...) (*ReviewComment, error)

+ DeleteReviewComment func(ctx context.Context, owner, repo string, number int, id int64) error

+ Diff func(ctx context.Context, owner, repo string, number int, format DiffFormat) (io.ReadCloser, error)

+ Files func(ctx context.Context, owner, repo string, number int, opts ListOptions) (Page[ChangedFile], error)

+ ListReviewComments func(ctx context.Context, owner, repo string, number int, opts ListOptions) (Page[ReviewComment], error)

type Releases

+ AddExternalAsset func(ctx context.Context, owner, repo string, releaseID int64, name, url string) (*Asset, error)

type Runners

+ Delete func(ctx context.Context, scope RunnerScope, id int64) error

+ Get func(ctx context.Context, scope RunnerScope, id int64) (*Runner, error)

+ List func(ctx context.Context, scope RunnerScope, opts ListRunnersOptions) (Page[Runner], error)

+ Register func(ctx context.Context, scope RunnerScope, opts RegisterRunnerOptions) (*RegisteredRunner, error)

+ RegistrationToken func(ctx context.Context, scope RunnerScope) (*RunnerToken, error)

type Secrets

+ GetAccess func(ctx context.Context, org, name string) (*SecretAccess, error)

+ SetRepos func(ctx context.Context, org, name string, repos []string) error

+ SetWithAccess func(ctx context.Context, org, name, value string, access SecretAccess) error

+ type Site interface

+ DefaultWebhooks func() DefaultWebhooks

+ SystemWebhooks func() SystemWebhooks

+ type StatusState string

+ const StatusError

+ const StatusFailure

+ const StatusPending

+ const StatusSuccess

+ const StatusWarning

+ func CombineStates(states ...StatusState) StatusState

type TagProtections

+ Edit func(ctx context.Context, owner, repo, pattern string, rule TagProtection) (*TagProtection, error)

type Teams

+ Info func(ctx context.Context, org, name string) (*TeamInfo, error)

type Users

+ Info func(ctx context.Context, login string) (*UserInfo, error)

+ Me func(ctx context.Context) (*CurrentUser, error)

+ Search func(ctx context.Context, filter UserFilter, opts ListOptions) (Page[User], error)

+ Tokens func(login string) Tokens

type Webhooks

+ GetDelivery func(ctx context.Context, scope HookScope, hookID, id int64) (*HookDelivery, error)

+ ListDeliveries func(ctx context.Context, scope HookScope, hookID int64, ...) (HookDeliveryPage, error)

+ Redeliver func(ctx context.Context, scope HookScope, hookID, id int64) error

type WorkflowArtifacts

+ Delete func(ctx context.Context, owner, repo string, id int64) error

+ Download func(ctx context.Context, owner, repo string, id int64) (io.ReadCloser, error)

+ Get func(ctx context.Context, owner, repo string, id int64) (*WorkflowArtifact, error)

+ List func(ctx context.Context, owner, repo string, opts ListWorkflowArtifactsOptions) (Page[WorkflowArtifact], error)

+ ListForRun func(ctx context.Context, owner, repo string, runID int64, ...) (Page[WorkflowArtifact], error)

type WorkflowRuns

+ Cancel func(ctx context.Context, owner, repo string, id int64) error

+ Delete func(ctx context.Context, owner, repo string, id int64) error

+ FollowJobLog func(ctx context.Context, owner, repo string, jobID int64, out io.Writer, ...) error

+ Get func(ctx context.Context, owner, repo string, id int64) (*WorkflowRun, error)

+ GetJob func(ctx context.Context, owner, repo string, jobID int64) (*WorkflowJob, error)

+ JobLogs func(ctx context.Context, owner, repo string, jobID int64) (io.ReadCloser, error)

+ List func(ctx context.Context, owner, repo string, opts ListWorkflowRunsOptions) (Page[WorkflowRun], error)

+ ListJobs func(ctx context.Context, owner, repo string, runID int64, opts ListOptions) (Page[WorkflowJob], error)

+ Logs func(ctx context.Context, owner, repo string, runID int64) (io.ReadCloser, error)

+ Rerun func(ctx context.Context, owner, repo string, id int64) error

+ RerunJob func(ctx context.Context, owner, repo string, jobID int64) error

v1.8.0

Nov 12, 2026

Changes in this version

type Capability

+ const CapRunners

+ const CapWorkflowLogFollow

+ type FollowLogOptions struct

+ Interval time.Duration

+ type ListRunnersOptions struct

+ Inherited bool

+ type RegisterRunnerOptions struct

+ Description string

+ Ephemeral bool

+ Labels []string

+ Name string

+ type RegisteredRunner struct

+ ID int64

+ JITConfig string

+ Token string

+ UUID string

+ type Runner struct

+ Busy bool

+ Description string

+ Ephemeral bool

+ ID int64

+ Labels []string

+ Name string

+ OS string

+ Online bool

+ Status string

+ UUID string

+ Version string

+ type RunnerScope struct

+ Instance bool

+ Owner string

+ Repo string

+ func InstanceRunners() RunnerScope

+ func OrgRunners(org string) RunnerScope

+ func RepoRunners(owner, repo string) RunnerScope

+ func UserRunners() RunnerScope

+ type RunnerToken struct

+ ExpiresAt time.Time

+ Token string

+ type Runners interface

+ DeleteRunner func(ctx context.Context, scope RunnerScope, id int64) error

+ GetRunner func(ctx context.Context, scope RunnerScope, id int64) (*Runner, error)

+ ListRunners func(ctx context.Context, scope RunnerScope, opts ListRunnersOptions) (Page[Runner], error)

+ RegisterRunner func(ctx context.Context, scope RunnerScope, opts RegisterRunnerOptions) (*RegisteredRunner, error)

+ RunnerRegistrationToken func(ctx context.Context, scope RunnerScope) (*RunnerToken, error)

+ type WorkflowLogFollower interface

+ FollowWorkflowJobLog func(ctx context.Context, owner, repo string, jobID int64, out io.Writer, ...) error

v1.7.0

Nov 10, 2026

Changes in this version

+ type ActionsAllowed string

+ const ActionsAllowedAll

+ const ActionsAllowedLocalOnly

+ const ActionsAllowedSelected

+ type ActionsSettings struct

+ Allowed *ActionsAllowed

+ ApprovePullRequests *bool

+ TokenPermission *ActionsTokenPermission

+ type ActionsTokenPermission string

+ const ActionsTokenRead

+ const ActionsTokenWrite

type CreateRepoOptions

+ Features RepoFeatures

type EditRepoOptions

+ Actions ActionsSettings

+ Features RepoFeatures

+ IssueTracker IssueTrackerSettings

+ Merge MergeSettings

+ Wiki WikiSettings

+ type ExternalIssueStyle string

+ const ExternalIssueAlphanumeric

+ const ExternalIssueNumeric

+ const ExternalIssueRegexp

+ type ExternalTracker struct

+ Format string

+ Pattern string

+ Style ExternalIssueStyle

+ URL string

+ type IssueTrackerSettings struct

+ Dependencies *bool

+ External *ExternalTracker

+ TimeTracking *bool

+ TimeTrackingContributorsOnly *bool

+ type MergeSettings struct

+ AutoMerge *bool

+ DefaultMethod *MergeMethod

+ DeleteBranch *bool

+ FastForwardOnly *bool

+ MergeCommit *bool

+ Rebase *bool

+ RebaseMerge *bool

+ RebaseUpdate *bool

+ Squash *bool

+ UpdateBranch *bool

type Repo

+ Actions ActionsSettings

+ Features RepoFeatures

+ IssueTracker IssueTrackerSettings

+ Merge MergeSettings

+ Wiki WikiSettings

+ type RepoFeatures struct

+ Actions *bool

+ Discussions *bool

+ Issues *bool

+ Packages *bool

+ Projects *bool

+ PullRequests *bool

+ Releases *bool

+ Wiki *bool

+ type WikiSettings struct

+ EditableByAll *bool

+ ExternalURL *string

v1.6.0

Nov 7, 2026

Changes in this version

+ var ErrAmbiguousName = errors.New("several labels have this name")

+ var ErrIsPullRequest = errors.New("the number is a pull request, not an issue")

+ var ErrNameTaken = errors.New("the name is already in use")

+ var ErrWorkflowRunActive = errors.New("the workflow run has not finished")

type Capability

+ const CapLabelsByID

+ const CapOrgLabels

+ const CapWorkflowArtifacts

+ const CapWorkflowRuns

type EditMilestoneOptions

+ ClearDueOn bool

type Issue

+ IsPullRequest bool

+ type LabelsByID interface

+ DeleteLabelByID func(ctx context.Context, owner, repo string, id int64) error

+ EditLabelByID func(ctx context.Context, owner, repo string, id int64, opts EditLabelOptions) (*Label, error)

+ type ListWorkflowArtifactsOptions struct

+ Name string

+ type ListWorkflowRunsOptions struct

+ Branch string

+ Event string

+ Number int64

+ SHA string

+ Status string

+ Workflow string

+ type OrgLabels interface

+ CreateOrgLabel func(ctx context.Context, org string, label Label) (*Label, error)

+ DeleteOrgLabel func(ctx context.Context, org string, id int64) error

+ EditOrgLabel func(ctx context.Context, org string, id int64, opts EditLabelOptions) (*Label, error)

+ GetOrgLabel func(ctx context.Context, org string, id int64) (*Label, error)

+ ListOrgLabels func(ctx context.Context, org string, opts ListOptions) (Page[Label], error)

+ type WorkflowArtifact struct

+ CreatedAt time.Time

+ Expired bool

+ ExpiresAt time.Time

+ ID int64

+ Name string

+ RunID int64

+ Size int64

+ UpdatedAt time.Time

+ type WorkflowArtifacts interface

+ DeleteWorkflowArtifact func(ctx context.Context, owner, repo string, id int64) error

+ DownloadWorkflowArtifact func(ctx context.Context, owner, repo string, id int64) (io.ReadCloser, error)

+ GetWorkflowArtifact func(ctx context.Context, owner, repo string, id int64) (*WorkflowArtifact, error)

+ ListWorkflowArtifacts func(ctx context.Context, owner, repo string, opts ListWorkflowArtifactsOptions) (Page[WorkflowArtifact], error)

+ ListWorkflowRunArtifacts func(ctx context.Context, owner, repo string, runID int64, ...) (Page[WorkflowArtifact], error)

+ type WorkflowJob struct

+ Attempt int

+ CompletedAt time.Time

+ Conclusion string

+ HTMLURL string

+ ID int64

+ Labels []string

+ Name string

+ RunID int64

+ StartedAt time.Time

+ Status string

+ Steps []WorkflowStep

+ type WorkflowRun struct

+ Actor string

+ Branch string

+ Conclusion string

+ CreatedAt time.Time

+ Event string

+ HTMLURL string

+ ID int64

+ Number int64

+ SHA string

+ StartedAt time.Time

+ Status string

+ StoppedAt time.Time

+ Title string

+ UpdatedAt time.Time

+ Workflow string

+ type WorkflowRuns interface

+ CancelWorkflowRun func(ctx context.Context, owner, repo string, id int64) error

+ DeleteWorkflowRun func(ctx context.Context, owner, repo string, id int64) error

+ GetWorkflowJob func(ctx context.Context, owner, repo string, jobID int64) (*WorkflowJob, error)

+ GetWorkflowRun func(ctx context.Context, owner, repo string, id int64) (*WorkflowRun, error)

+ ListWorkflowJobs func(ctx context.Context, owner, repo string, runID int64, opts ListOptions) (Page[WorkflowJob], error)

+ ListWorkflowRuns func(ctx context.Context, owner, repo string, opts ListWorkflowRunsOptions) (Page[WorkflowRun], error)

+ RerunWorkflowJob func(ctx context.Context, owner, repo string, jobID int64) error

+ RerunWorkflowRun func(ctx context.Context, owner, repo string, id int64) error

+ WorkflowJobLogs func(ctx context.Context, owner, repo string, jobID int64) (io.ReadCloser, error)

+ WorkflowRunLogs func(ctx context.Context, owner, repo string, runID int64) (io.ReadCloser, error)

+ type WorkflowStep struct

+ CompletedAt time.Time

+ Conclusion string

+ Name string

+ Number int

+ StartedAt time.Time

+ Status string

v1.5.1

Nov 6, 2026

v1.5.0

Nov 6, 2026

Changes in this version

+ var ErrInvitationPending = errors.New("the user was invited, and is not a member until they accept")

type AccessToken

+ CreatedAt time.Time

+ type AdminTokens interface

+ TokensOf func(login string) Tokens

type Capability

+ const CapAdminTokens

+ const CapIssueLocks

+ const CapUserFilters

type CreateReviewCommentOptions

+ ExtraLines int

+ type IssueLocks interface

+ LockIssue func(ctx context.Context, owner, repo string, number int, reason LockReason) error

+ UnlockIssue func(ctx context.Context, owner, repo string, number int) error

type ListPROptions

+ Base string

+ Head string

+ type LockReason string

+ const LockReasonOffTopic

+ const LockReasonResolved

+ const LockReasonSpam

+ const LockReasonTooHeated

type Org

+ CreatedAt time.Time

type ReviewComment

+ ExtraLines int

type SSHKey

+ UpdatedAt time.Time

+ Verified bool

+ type UserFilter struct

+ TwoFactor *bool

+ type UserFilters interface

+ ListUsersBy func(ctx context.Context, filter UserFilter, opts ListOptions) (Page[User], error)

v1.4.0

Nov 6, 2026

Changes in this version

type CreateWebhookOptions

+ Slack *SlackHookSettings

+ Type HookType

type EditWebhookOptions

+ Slack *SlackHookSettings

type HookEvent

+ const HookEventWorkflowJob

+ const HookEventWorkflowRun

+ type HookType string

+ const HookTypeDingTalk

+ const HookTypeDiscord

+ const HookTypeFeishu

+ const HookTypeForgejo

+ const HookTypeGitea

+ const HookTypeGogs

+ const HookTypeMSTeams

+ const HookTypeMatrix

+ const HookTypePackagist

+ const HookTypeSlack

+ const HookTypeSourceHutBuilds

+ const HookTypeTelegram

+ const HookTypeWeChatWork

+ type SlackHookSettings struct

+ Channel string

+ Color string

+ IconURL string

+ Username string

type SystemWebhooks

+ Create func(ctx context.Context, opts CreateWebhookOptions) (*Webhook, error)

type Webhook

+ HasAuthorizationHeader bool

+ Slack *SlackHookSettings

+ Type HookType

v1.3.0

Nov 5, 2026

Changes in this version

type CIScope

+ Environment string

+ func EnvCI(owner, repo, environment string) CIScope

type Capability

+ const CapCIEnvironments

+ const CapCollaboratorInvitations

+ const CapCollaborators

+ const CapCommitDiffs

+ const CapGitHooks

+ const CapHookDeliveries

+ const CapOrgSecrets

+ const CapPRContents

+ const CapReviewComments

+ const CapUserWebhooks

+ type Collaborator struct

+ AccountID string

+ Login string

+ Permission CollaboratorPermission

+ type CollaboratorInvitation struct

+ CreatedAt time.Time

+ Expired bool

+ HTMLURL string

+ ID int64

+ Login string

+ Permission CollaboratorPermission

+ type CollaboratorInvitations interface

+ ListCollaboratorInvitations func(ctx context.Context, owner, repo string, opts ListOptions) (Page[CollaboratorInvitation], error)

+ type CollaboratorPermission string

+ const CollaboratorAdmin

+ const CollaboratorMaintain

+ const CollaboratorRead

+ const CollaboratorTriage

+ const CollaboratorWrite

+ func (p CollaboratorPermission) Valid() bool

+ type Collaborators interface

+ AddCollaborator func(ctx context.Context, owner, repo, user string, ...) (invited bool, err error)

+ GetCollaborator func(ctx context.Context, owner, repo, user string) (*Collaborator, error)

+ ListCollaborators func(ctx context.Context, owner, repo string, opts ListOptions) (Page[Collaborator], error)

+ RemoveCollaborator func(ctx context.Context, owner, repo, user string) error

+ type CommitDiffs interface

+ CommitDiff func(ctx context.Context, owner, repo, ref string, format DiffFormat) (io.ReadCloser, error)

+ type CreatePushMirrorOptions struct

+ BranchFilter string

+ Interval time.Duration

+ Password string

+ RemoteAddress string

+ SyncOnCommit bool

+ UseSSH bool

+ Username string

+ func (o CreatePushMirrorOptions) Validate() error

+ type CreateReviewCommentOptions struct

+ Body string

+ CommitID string

+ Line int

+ OldLine int

+ Path string

+ func (o CreateReviewCommentOptions) Validate() error

type CreateWebhookOptions

+ InsecureSSL bool

+ type DefaultWebhooks interface

+ Create func(ctx context.Context, opts CreateWebhookOptions) (*Webhook, error)

+ Delete func(ctx context.Context, id int64) error

+ Edit func(ctx context.Context, id int64, opts EditWebhookOptions) (*Webhook, error)

+ Get func(ctx context.Context, id int64) (*Webhook, error)

+ type DiffFormat string

+ const DiffPatch

+ const DiffUnified

+ func (f DiffFormat) Valid() bool

type EditWebhookOptions

+ InsecureSSL *bool

+ type GitHook struct

+ Active bool

+ Content string

+ Name string

+ type GitHooks interface

+ DeleteGitHook func(ctx context.Context, owner, repo, name string) error

+ GetGitHook func(ctx context.Context, owner, repo, name string) (*GitHook, error)

+ ListGitHooks func(ctx context.Context, owner, repo string) ([]GitHook, error)

+ SetGitHook func(ctx context.Context, owner, repo, name, content string) (*GitHook, error)

+ type HookDeliveries interface

+ GetHookDelivery func(ctx context.Context, scope HookScope, hookID, id int64) (*HookDelivery, error)

+ ListHookDeliveries func(ctx context.Context, scope HookScope, hookID int64, ...) (HookDeliveryPage, error)

+ RedeliverHook func(ctx context.Context, scope HookScope, hookID, id int64) error

+ type HookDelivery struct

+ Action string

+ DeliveredAt time.Time

+ Duration time.Duration

+ Event string

+ GUID string

+ ID int64

+ Redelivery bool

+ RequestHeaders map[string]string

+ RequestPayload json.RawMessage

+ ResponseBody string

+ ResponseHeaders map[string]string

+ Status string

+ StatusCode int

+ type HookDeliveryPage struct

+ Items []HookDelivery

+ NextCursor string

type HookEvent

+ const HookEventAll

type ListCommitsOptions

+ Author string

+ Exclude string

+ type ListHookDeliveriesOptions struct

+ Cursor string

+ PerPage int

+ type Mirrors interface

+ CreatePushMirror func(ctx context.Context, owner, repo string, opts CreatePushMirrorOptions) (*PushMirror, error)

+ DeletePushMirror func(ctx context.Context, owner, repo, name string) error

+ GetPushMirror func(ctx context.Context, owner, repo, name string) (*PushMirror, error)

+ ListPushMirrors func(ctx context.Context, owner, repo string, opts ListOptions) (Page[PushMirror], error)

+ SyncMirror func(ctx context.Context, owner, repo string) error

+ SyncPushMirrors func(ctx context.Context, owner, repo string) error

+ type OrgSecrets interface

+ GetOrgSecretAccess func(ctx context.Context, org, name string) (*SecretAccess, error)

+ SetOrgSecret func(ctx context.Context, org, name, value string, access SecretAccess) error

+ SetOrgSecretRepos func(ctx context.Context, org, name string, repos []string) error

+ type PRContents interface

+ PullRequestCommits func(ctx context.Context, owner, repo string, number int, opts ListOptions) (Page[Commit], error)

+ PullRequestDiff func(ctx context.Context, owner, repo string, number int, format DiffFormat) (io.ReadCloser, error)

+ PullRequestFiles func(ctx context.Context, owner, repo string, number int, opts ListOptions) (Page[ChangedFile], error)

+ type PushMirror struct

+ BranchFilter string

+ CreatedAt time.Time

+ Interval time.Duration

+ LastError string

+ LastSync time.Time

+ Name string

+ PublicKey string

+ RemoteAddress string

+ SyncOnCommit bool

+ type ReviewComment struct

+ Author string

+ Body string

+ CommitID string

+ CreatedAt time.Time

+ HTMLURL string

+ ID int64

+ Line int

+ OldLine int

+ Path string

+ ReviewID int64

+ UpdatedAt time.Time

+ type ReviewComments interface

+ CreateReviewComment func(ctx context.Context, owner, repo string, number int, ...) (*ReviewComment, error)

+ DeleteReviewComment func(ctx context.Context, owner, repo string, number int, id int64) error

+ ListReviewComments func(ctx context.Context, owner, repo string, number int, opts ListOptions) (Page[ReviewComment], error)

+ type SecretAccess struct

+ Repos []string

+ Visibility SecretVisibility

+ type SecretVisibility string

+ const SecretVisibleAll

+ const SecretVisiblePrivate

+ const SecretVisibleSelected

+ type SiteHooks interface

+ DefaultWebhooks func() DefaultWebhooks

+ SystemWebhooks func() SystemWebhooks

+ type SystemWebhooks interface

+ Delete func(ctx context.Context, id int64) error

+ Edit func(ctx context.Context, id int64, opts EditWebhookOptions) (*Webhook, error)

+ Get func(ctx context.Context, id int64) (*Webhook, error)

+ List func(ctx context.Context, opts ListOptions) (Page[Webhook], error)

+ type UserHooks interface

+ UserWebhooks func() UserWebhooks

+ type UserWebhooks interface

+ Create func(ctx context.Context, opts CreateWebhookOptions) (*Webhook, error)

+ Delete func(ctx context.Context, id int64) error

+ Edit func(ctx context.Context, id int64, opts EditWebhookOptions) (*Webhook, error)

+ Get func(ctx context.Context, id int64) (*Webhook, error)

+ List func(ctx context.Context, opts ListOptions) (Page[Webhook], error)

type Webhook

+ InsecureSSL bool

v1.2.0

Nov 5, 2026

Changes in this version

type Capability

+ const CapOrgAvatars

+ type OrgAvatars interface

+ DeleteOrgAvatar func(ctx context.Context, org string) error

+ SetOrgAvatar func(ctx context.Context, org string, image io.Reader) error

v1.1.0

Oct 30, 2026

Changes in this version

+ const MaxAvatarSize

+ var DefaultRetryPolicy = RetryPolicy

+ var ErrBranchProtected = errors.New("the branch is protected")

+ var ErrGPGSignature = errors.New("the GPG key needs a valid signature of the verification token")

+ var ErrInvalidOTP = errors.New("two-factor authentication code missing or invalid")

+ var ErrLastOwner = errors.New("cannot remove the last owner of an organisation")

+ var ErrOrgMember = errors.New("the user still belongs to organisations")

+ var ErrOwnsRepos = errors.New("the account still owns repositories")

+ var ErrPasswordRequired = errors.New("the operation needs username and password authentication")

+ var NoRetry = RetryPolicy

type APIError

+ Err error

+ RetryAt time.Time

+ func (e *APIError) Unwrap() error

+ type AccessToken struct

+ ID int64

+ LastEight string

+ Name string

+ Repositories []string

+ Scopes []string

+ Secret string

+ type Account interface

+ Emails func() Emails

+ GPGKeys func() GPGKeys

+ Profile func() Profile

+ SSHKeys func() SSHKeys

+ Tokens func() Tokens

+ type AddSSHKeyOptions struct

+ Key string

+ ReadOnly bool

+ Title string

+ type CI interface

+ Secrets func() Secrets

+ Variables func() Variables

+ type CIScope struct

+ Owner string

+ Repo string

+ func OrgCI(org string) CIScope

+ func RepoCI(owner, repo string) CIScope

+ func UserCI() CIScope

type Capability

+ const CapAccount

+ const CapCommits

+ const CapSecrets

+ const CapTokens

+ type ChangedFile struct

+ Additions int

+ Deletions int

+ Path string

+ PreviousPath string

+ Status FileStatus

+ type Commit struct

+ Author CommitAuthor

+ Committer CommitAuthor

+ Files []ChangedFile

+ HTMLURL string

+ Message string

+ Parents []string

+ SHA string

+ Stats *CommitStats

+ type CommitAuthor struct

+ Date time.Time

+ Email string

+ Login string

+ Name string

+ type CommitStats struct

+ Additions int

+ Deletions int

+ type Commits interface

+ Get func(ctx context.Context, owner, repo, ref string) (*Commit, error)

+ List func(ctx context.Context, owner, repo string, opts ListCommitsOptions) (Page[Commit], error)

+ type CreateTokenOptions struct

+ Name string

+ Repositories []string

+ Scopes []string

+ type EditProfileOptions struct

+ Company *string

+ Description *string

+ FullName *string

+ Hireable *bool

+ Language *string

+ Location *string

+ Pronouns *string

+ PublicEmail *string

+ Settings *EditSettings

+ TwitterUsername *string

+ Website *string

+ type EditSettings struct

+ DiffViewStyle *string

+ EnableRepoUnitHints *bool

+ HideActivity *bool

+ HideEmail *bool

+ HidePronouns *bool

+ Theme *string

+ type Emails interface

+ Add func(ctx context.Context, addresses ...string) ([]Email, error)

+ Delete func(ctx context.Context, addresses ...string) error

+ List func(ctx context.Context) ([]Email, error)

+ type FileStatus string

+ const FileAdded

+ const FileModified

+ const FileRemoved

+ const FileRenamed

+ type GPGKeys interface

+ Add func(ctx context.Context, armoredPublicKey, armoredSignature string) (*GPGKey, error)

+ Delete func(ctx context.Context, id int64) error

+ Get func(ctx context.Context, id int64) (*GPGKey, error)

+ List func(ctx context.Context, opts ListOptions) (Page[GPGKey], error)

+ VerificationToken func(ctx context.Context) (string, error)

+ Verify func(ctx context.Context, keyID, armoredSignature string) (*GPGKey, error)

+ type History interface

+ Commits func() Commits

+ type ListCommitsOptions struct

+ Path string

+ Ref string

+ Since time.Time

+ Until time.Time

+ type Profile interface

+ DeleteAvatar func(ctx context.Context) error

+ Edit func(ctx context.Context, opts EditProfileOptions) (*User, error)

+ SetAvatar func(ctx context.Context, image io.Reader) error

+ type RetryPolicy struct

+ MaxAttempts int

+ MaxWait time.Duration

+ type SSHKeys interface

+ Add func(ctx context.Context, opts AddSSHKeyOptions) (*SSHKey, error)

+ Delete func(ctx context.Context, id int64) error

+ Get func(ctx context.Context, id int64) (*SSHKey, error)

+ List func(ctx context.Context, opts ListOptions) (Page[SSHKey], error)

+ type Secret struct

+ CreatedAt time.Time

+ Name string

+ UpdatedAt time.Time

+ type Secrets interface

+ Delete func(ctx context.Context, scope CIScope, name string) error

+ List func(ctx context.Context, scope CIScope, opts ListOptions) (Page[Secret], error)

+ Set func(ctx context.Context, scope CIScope, name, value string) error

+ type Tokens interface

+ Create func(ctx context.Context, opts CreateTokenOptions) (*AccessToken, error)

+ Delete func(ctx context.Context, id int64) error

+ DeleteByName func(ctx context.Context, name string) error

+ List func(ctx context.Context, opts ListOptions) (Page[AccessToken], error)

+ type Variable struct

+ CreatedAt time.Time

+ Name string

+ UpdatedAt time.Time

+ Value string

+ type Variables interface

+ Delete func(ctx context.Context, scope CIScope, name string) error

+ Get func(ctx context.Context, scope CIScope, name string) (*Variable, error)

+ List func(ctx context.Context, scope CIScope, opts ListOptions) (Page[Variable], error)

+ Set func(ctx context.Context, scope CIScope, name, value string) error

v1.0.0

Oct 30, 2026

v0

v0.4.0

Oct 27, 2026

Changes in this version

type Branch

+ LastCommit *CommitSummary

type Branches

+ Compare func(ctx context.Context, owner, repo, base, head string) (*Comparison, error)

+ type CommitSummary struct

+ Author string

+ Date time.Time

+ Message string

+ type Comparison struct

+ Ahead int

+ Base string

+ Behind int

+ Head string

v0.3.0

Oct 23, 2026

Changes in this version

type CurrentUser

+ Missing []PartError

type OrgInfo

+ Missing []PartError

+ type PartError struct

+ Message string

+ Part string

+ Status int

type TeamInfo

+ Missing []PartError

type UserInfo

+ Missing []PartError

v0.2.1

Oct 23, 2026

Changes in this version

+ type CurrentUser struct

+ AccountID string

+ AuthSourceID int64

+ Collaborators int

+ DiskUsage int

+ Emails []Email

+ GPGKeys []GPGKey

+ Hireable bool

+ Incomplete error

+ LoginName string

+ Orgs []Org

+ OwnedPrivateRepos int64

+ Plan string

+ PrivateGists int

+ PublicGists int

+ PublicRepos int

+ Repos []Repo

+ SSHKeys []SSHKey

+ Settings *UserSettings

+ Teams []Team

+ TotalPrivateRepos int64

+ TwitterUsername string

+ TwoFactorAuth *bool

+ Type string

+ UUID string

+ UpdatedAt time.Time

type Directory

+ Me func(ctx context.Context) (*CurrentUser, error)

+ type Email struct

+ Address string

+ Primary bool

+ Verified bool

+ Visibility string

+ type GPGKey struct

+ CanCertify bool

+ CanEncryptComms bool

+ CanEncryptStorage bool

+ CanSign bool

+ CreatedAt time.Time

+ Emails []GPGKeyEmail

+ ExpiresAt time.Time

+ ID int64

+ KeyID string

+ PublicKey string

+ Subkeys []GPGKey

+ Verified bool

+ type GPGKeyEmail struct

+ Address string

+ Verified bool

+ type SSHKey struct

+ CreatedAt time.Time

+ Fingerprint string

+ ID int64

+ Key string

+ LastUsed time.Time

+ ReadOnly bool

+ Title string

+ type UserSettings struct

+ DiffViewStyle string

+ EnableRepoUnitHints bool

+ HideActivity bool

+ HideEmail bool

+ HidePronouns bool

+ Theme string

v0.2.0

Oct 22, 2026

Changes in this version

type Capability

+ const CapDirectory

type Client

+ Directory func() Directory

+ type Directory interface

+ ListAllOrgs func(ctx context.Context, opts ListOptions) (Page[Org], error)

+ ListOrgs func(ctx context.Context, user string, opts ListOptions) (Page[Org], error)

+ ListTeams func(ctx context.Context, org string, opts ListOptions) (Page[Team], error)

+ Org func(ctx context.Context, name string) (*Org, error)

+ OrgInfo func(ctx context.Context, name string) (*OrgInfo, error)

+ OrgMembers func(ctx context.Context, org string, opts ListOptions) (Page[User], error)

+ Team func(ctx context.Context, org, name string) (*Team, error)

+ TeamInfo func(ctx context.Context, org, name string) (*TeamInfo, error)

+ TeamMembers func(ctx context.Context, org, name string, opts ListOptions) (Page[User], error)

+ TeamRepos func(ctx context.Context, org, name string, opts ListOptions) (Page[Repo], error)

+ User func(ctx context.Context, login string) (*User, error)

+ UserInfo func(ctx context.Context, login string) (*UserInfo, error)

type Org

+ AvatarURL string

+ HTMLURL string

+ type OrgInfo struct

+ Incomplete error

+ Members []User

+ Repos []Repo

+ Teams []Team

type Team

+ Slug string

+ type TeamInfo struct

+ Incomplete error

+ Members []User

+ Repos []Repo

type User

+ AvatarURL string

+ Company string

+ Followers int

+ Following int

+ Language string

+ Pronouns string

+ StarredRepos int

+ type UserInfo struct

+ Incomplete error

+ Orgs []Org

+ Repos []Repo

v0.1.7

Oct 21, 2026

Changes in this version

+ var AllTeamUnits = []TeamUnit

+ var ErrNotSupported = errors.New("operation not supported")

+ var ErrOwnerTeam = errors.New("refusing to delete, rename or change the permissions of an owner team")

+ func All[T any](ctx context.Context, opts ListOptions, ...) iter.Seq2[T, error]

+ func IsForbidden(err error) bool

+ func IsNotFound(err error) bool

+ func IsUnauthorized(err error) bool

+ func NotSupported(backend Backend, operation, reason string) error

+ func Ptr[T any](v T) *T

+ func StatusCode(err error) int

+ type APIError struct

+ Backend Backend

+ Details []string

+ DocumentationURL string

+ Message string

+ StatusCode int

+ func (e *APIError) Error() string

+ type Admin interface

+ Orgs func() Orgs

+ Teams func() Teams

+ Users func() Users

+ type Allowlist struct

+ Teams []string

+ Users []string

+ type Asset struct

+ ContentType string

+ CreatedAt time.Time

+ DownloadCount int64

+ DownloadURL string

+ External bool

+ ID int64

+ Name string

+ Size int64

+ type Backend string

+ const BackendBitbucket

+ const BackendForgejo

+ const BackendGitHub

+ type Branch struct

+ IsDefault bool

+ Name string

+ Protected bool

+ SHA string

+ type BranchProtection struct

+ AllowDeletion bool

+ AllowForcePush bool

+ ApplyToAdmins bool

+ ApprovalsAllowlist *Allowlist

+ BlockOnOfficialReviewRequests bool

+ BlockOnRejectedReviews bool

+ DismissStaleApprovals bool

+ ID int64

+ MergeAllowlist *Allowlist

+ Pattern string

+ ProtectedFilePatterns string

+ PushAllowlist *Allowlist

+ RequireConversationResolution bool

+ RequireLinearHistory bool

+ RequireSignedCommits bool

+ RequireUpToDate bool

+ RequiredApprovals int

+ RequiredStatusChecks []string

+ UnprotectedFilePatterns string

+ type BranchProtections interface

+ Create func(ctx context.Context, owner, repo string, rule BranchProtection) (*BranchProtection, error)

+ Delete func(ctx context.Context, owner, repo, pattern string) error

+ Get func(ctx context.Context, owner, repo, pattern string) (*BranchProtection, error)

+ List func(ctx context.Context, owner, repo string) ([]BranchProtection, error)

+ Update func(ctx context.Context, owner, repo, pattern string, rule BranchProtection) (*BranchProtection, error)

+ type Branches interface

+ Create func(ctx context.Context, owner, repo string, opts CreateBranchOptions) (*Branch, error)

+ Delete func(ctx context.Context, owner, repo, name string) error

+ Get func(ctx context.Context, owner, repo, name string) (*Branch, error)

+ List func(ctx context.Context, owner, repo string, opts ListOptions) (Page[Branch], error)

+ Rename func(ctx context.Context, owner, repo, name, newName string) (*Branch, error)

+ type Capability uint64

+ const CapAdmin

+ const CapBranchProtection

+ const CapBranches

+ const CapExternalAssets

+ const CapIssues

+ const CapMigrate

+ const CapMirrors

+ const CapPullRequests

+ const CapReleases

+ const CapRepos

+ const CapSystemWebhooks

+ const CapTagProtection

+ const CapTags

+ const CapWebhooks

+ func (c Capability) Has(want Capability) bool

+ func (c Capability) String() string

+ type Client interface

+ Backend func() Backend

+ BranchProtections func() BranchProtections

+ Branches func() Branches

+ Capabilities func() Capability

+ Issues func() Issues

+ Labels func() Labels

+ Milestones func() Milestones

+ PullRequests func() PullRequests

+ Releases func() Releases

+ Repos func() Repos

+ TagProtections func() TagProtections

+ Tags func() Tags

+ Webhooks func() Webhooks

+ type Comment struct

+ Author string

+ Body string

+ CreatedAt time.Time

+ HTMLURL string

+ ID int64

+ UpdatedAt time.Time

+ type CreateBranchOptions struct

+ From string

+ Name string

+ type CreateIssueOptions struct

+ Assignees []string

+ Body string

+ Labels []string

+ Milestone int64

+ Title string

+ type CreateMilestoneOptions struct

+ Description string

+ DueOn time.Time

+ Title string

+ type CreateOrgOptions struct

+ Description string

+ Email string

+ FullName string

+ Location string

+ Name string

+ Owner string

+ RepoAdminChangeTeamAccess bool

+ Visibility OwnerVisibility

+ Website string

+ type CreatePROptions struct

+ AllowMaintainerEdit *bool

+ Base string

+ Body string

+ Draft bool

+ Head string

+ Title string

+ type CreateReleaseOptions struct

+ Body string

+ Draft bool

+ GenerateReleaseNotes bool

+ HideArchiveLinks *bool

+ MakeLatest *bool

+ Name string

+ Prerelease bool

+ TagName string

+ TargetCommitish string

+ type CreateRepoOptions struct

+ AutoInit bool

+ DefaultBranch string

+ Description string

+ Gitignores []string

+ License string

+ Name string

+ Owner string

+ Template bool

+ Visibility Visibility

+ type CreateReviewOptions struct

+ Body string

+ CommitID string

+ Event ReviewEvent

+ type CreateTagOptions struct

+ Message string

+ Name string

+ Target string

+ type CreateTeamOptions struct

+ Access TeamAccess

+ CanCreateOrgRepo bool

+ Description string

+ IncludesAllRepos bool

+ Name string

+ type CreateUserOptions struct

+ Email string

+ FullName string

+ Login string

+ MustChangePassword *bool

+ Password string

+ Restricted bool

+ SendNotify bool

+ Visibility OwnerVisibility

+ type CreateWebhookOptions struct

+ Active *bool

+ AuthorizationHeader string

+ BranchFilter string

+ ContentType HookContentType

+ Events []HookEvent

+ Secret string

+ URL string

+ type DeleteUserOptions struct

+ Purge bool

+ type EditAssetOptions struct

+ Name *string

+ type EditIssueOptions struct

+ Assignees *[]string

+ Body *string

+ Labels *[]string

+ Milestone *int64

+ State *IssueState

+ Title *string

+ type EditLabelOptions struct

+ Color *string

+ Description *string

+ Name *string

+ type EditMilestoneOptions struct

+ Description *string

+ DueOn *time.Time

+ State *MilestoneState

+ Title *string

+ type EditOrgOptions struct

+ Description *string

+ Email *string

+ FullName *string

+ Location *string

+ RepoAdminChangeTeamAccess *bool

+ Visibility *OwnerVisibility

+ Website *string

+ type EditPROptions struct

+ AllowMaintainerEdit *bool

+ Base *string

+ Body *string

+ Draft *bool

+ State *PRState

+ Title *string

+ type EditReleaseOptions struct

+ Body *string

+ Draft *bool

+ HideArchiveLinks *bool

+ MakeLatest *bool

+ Name *string

+ Prerelease *bool

+ TagName *string

+ TargetCommitish *string

+ type EditRepoOptions struct

+ Archived *bool

+ DefaultBranch *string

+ Description *string

+ Name *string

+ Template *bool

+ Visibility *Visibility

+ Website *string

+ type EditTeamOptions struct

+ Access *TeamAccess

+ CanCreateOrgRepo *bool

+ Description *string

+ IncludesAllRepos *bool

+ Name *string

+ type EditUserOptions struct

+ Active *bool

+ Admin *bool

+ AllowCreateOrganization *bool

+ Description *string

+ Email *string

+ FullName *string

+ Location *string

+ MaxRepoCreation *int

+ MustChangePassword *bool

+ Password *string

+ ProhibitLogin *bool

+ Restricted *bool

+ Visibility *OwnerVisibility

+ Website *string

+ type EditWebhookOptions struct

+ Active *bool

+ AuthorizationHeader *string

+ BranchFilter *string

+ ContentType *HookContentType

+ Events []HookEvent

+ Secret *string

+ URL *string

+ type ExternalAssets interface

+ AddExternalAsset func(ctx context.Context, owner, repo string, releaseID int64, name, url string) (*Asset, error)

+ type HookContentType string

+ const HookContentForm

+ const HookContentJSON

+ type HookEvent string

+ const HookEventCreate

+ const HookEventDelete

+ const HookEventFork

+ const HookEventIssueComment

+ const HookEventIssues

+ const HookEventPullRequest

+ const HookEventPullRequestReview

+ const HookEventPush

+ const HookEventRelease

+ const HookEventRepository

+ const HookEventWiki

+ type HookScope struct

+ Owner string

+ Repo string

+ func OrgHooks(org string) HookScope

+ func RepoHooks(owner, repo string) HookScope

+ type Issue struct

+ Assignees []string

+ Author string

+ Body string

+ ClosedAt time.Time

+ Comments int

+ CreatedAt time.Time

+ HTMLURL string

+ Labels []string

+ Locked bool

+ Milestone *Milestone

+ Number int

+ State IssueState

+ Title string

+ UpdatedAt time.Time

+ type IssueState string

+ const IssueStateAll

+ const IssueStateClosed

+ const IssueStateOpen

+ type Issues interface

+ AddLabels func(ctx context.Context, owner, repo string, number int, labels []string) error

+ Create func(ctx context.Context, owner, repo string, opts CreateIssueOptions) (*Issue, error)

+ CreateComment func(ctx context.Context, owner, repo string, number int, body string) (*Comment, error)

+ Delete func(ctx context.Context, owner, repo string, number int) error

+ DeleteComment func(ctx context.Context, owner, repo string, id int64) error

+ Edit func(ctx context.Context, owner, repo string, number int, opts EditIssueOptions) (*Issue, error)

+ EditComment func(ctx context.Context, owner, repo string, id int64, body string) (*Comment, error)

+ Get func(ctx context.Context, owner, repo string, number int) (*Issue, error)

+ List func(ctx context.Context, owner, repo string, opts ListIssuesOptions) (Page[Issue], error)

+ ListComments func(ctx context.Context, owner, repo string, number int, opts ListOptions) (Page[Comment], error)

+ RemoveLabel func(ctx context.Context, owner, repo string, number int, label string) error

+ type Label struct

+ Color string

+ Description string

+ ID int64

+ Name string

+ type Labels interface

+ Create func(ctx context.Context, owner, repo string, label Label) (*Label, error)

+ Delete func(ctx context.Context, owner, repo, name string) error

+ Edit func(ctx context.Context, owner, repo, name string, opts EditLabelOptions) (*Label, error)

+ Get func(ctx context.Context, owner, repo, name string) (*Label, error)

+ List func(ctx context.Context, owner, repo string, opts ListOptions) (Page[Label], error)

+ type ListIssuesOptions struct

+ Labels []string

+ State IssueState

+ type ListOptions struct

+ Page int

+ PerPage int

+ type ListPROptions struct

+ State PRState

+ type MergeMethod string

+ const MergeMethodFastForwardOnly

+ const MergeMethodManuallyMerged

+ const MergeMethodMerge

+ const MergeMethodRebase

+ const MergeMethodRebaseMerge

+ const MergeMethodSquash

+ func (m MergeMethod) Valid() bool

+ type MergeOptions struct

+ DeleteBranch bool

+ HeadSHA string

+ Message string

+ Method MergeMethod

+ Title string

+ WhenChecksSucceed bool

+ type Milestone struct

+ ClosedAt time.Time

+ ClosedIssues int

+ Description string

+ DueOn time.Time

+ ID int64

+ OpenIssues int

+ State MilestoneState

+ Title string

+ type MilestoneState string

+ const MilestoneStateAll

+ const MilestoneStateClosed

+ const MilestoneStateOpen

+ type Milestones interface

+ Create func(ctx context.Context, owner, repo string, opts CreateMilestoneOptions) (*Milestone, error)

+ Delete func(ctx context.Context, owner, repo string, id int64) error

+ Edit func(ctx context.Context, owner, repo string, id int64, opts EditMilestoneOptions) (*Milestone, error)

+ Get func(ctx context.Context, owner, repo string, id int64) (*Milestone, error)

+ List func(ctx context.Context, owner, repo string, state MilestoneState, ...) (Page[Milestone], error)

+ type NotSupportedError struct

+ Backend Backend

+ Operation string

+ Reason string

+ func (e *NotSupportedError) Error() string

+ func (e *NotSupportedError) Is(target error) bool

+ type Org struct

+ Description string

+ Email string

+ FullName string

+ ID int64

+ Location string

+ Name string

+ RepoAdminChangeTeamAccess bool

+ Visibility OwnerVisibility

+ Website string

+ type Orgs interface

+ Create func(ctx context.Context, opts CreateOrgOptions) (*Org, error)

+ Delete func(ctx context.Context, name string) error

+ Edit func(ctx context.Context, name string, opts EditOrgOptions) (*Org, error)

+ Get func(ctx context.Context, name string) (*Org, error)

+ IsMember func(ctx context.Context, org, user string) (bool, error)

+ List func(ctx context.Context, user string, opts ListOptions) (Page[Org], error)

+ ListAll func(ctx context.Context, opts ListOptions) (Page[Org], error)

+ Members func(ctx context.Context, org string, opts ListOptions) (Page[User], error)

+ RemoveMember func(ctx context.Context, org, user string) error

+ Rename func(ctx context.Context, name, newName string) error

+ type OwnerVisibility string

+ const OwnerVisibilityLimited

+ const OwnerVisibilityPrivate

+ const OwnerVisibilityPublic

+ func (v OwnerVisibility) Valid() bool

+ type PRBranch struct

+ Ref string

+ Repo string

+ SHA string

+ type PRState string

+ const PRStateAll

+ const PRStateClosed

+ const PRStateOpen

+ type Page struct

+ Items []T

+ NextPage int

+ type PullRequest struct

+ Author string

+ Base PRBranch

+ Body string

+ ClosedAt time.Time

+ CreatedAt time.Time

+ Draft bool

+ HTMLURL string

+ Head PRBranch

+ MergeCommitSHA string

+ Mergeable *bool

+ Merged bool

+ MergedAt time.Time

+ MergedBy string

+ Number int

+ State PRState

+ Title string

+ UpdatedAt time.Time

+ type PullRequests interface

+ CancelAutoMerge func(ctx context.Context, owner, repo string, number int) error

+ Create func(ctx context.Context, owner, repo string, opts CreatePROptions) (*PullRequest, error)

+ CreateReview func(ctx context.Context, owner, repo string, number int, opts CreateReviewOptions) (*Review, error)

+ Edit func(ctx context.Context, owner, repo string, number int, opts EditPROptions) (*PullRequest, error)

+ Get func(ctx context.Context, owner, repo string, number int) (*PullRequest, error)

+ IsMerged func(ctx context.Context, owner, repo string, number int) (bool, error)

+ List func(ctx context.Context, owner, repo string, opts ListPROptions) (Page[PullRequest], error)

+ ListReviews func(ctx context.Context, owner, repo string, number int, opts ListOptions) (Page[Review], error)

+ Merge func(ctx context.Context, owner, repo string, number int, opts MergeOptions) error

+ RemoveReviewers func(ctx context.Context, owner, repo string, number int, users, teams []string) error

+ RequestReviewers func(ctx context.Context, owner, repo string, number int, users, teams []string) error

+ type Release struct

+ Assets []Asset

+ Author string

+ Body string

+ CreatedAt time.Time

+ Draft bool

+ HTMLURL string

+ ID int64

+ Name string

+ Prerelease bool

+ PublishedAt time.Time

+ TagName string

+ TarballURL string

+ TargetCommitish string

+ ZipballURL string

+ type Releases interface

+ Create func(ctx context.Context, owner, repo string, opts CreateReleaseOptions) (*Release, error)

+ Delete func(ctx context.Context, owner, repo string, id int64) error

+ DeleteAsset func(ctx context.Context, owner, repo string, releaseID, assetID int64) error

+ DownloadAsset func(ctx context.Context, owner, repo string, releaseID, assetID int64) (io.ReadCloser, error)

+ Edit func(ctx context.Context, owner, repo string, id int64, opts EditReleaseOptions) (*Release, error)

+ EditAsset func(ctx context.Context, owner, repo string, releaseID, assetID int64, ...) (*Asset, error)

+ Get func(ctx context.Context, owner, repo string, id int64) (*Release, error)

+ GetAsset func(ctx context.Context, owner, repo string, releaseID, assetID int64) (*Asset, error)

+ GetByTag func(ctx context.Context, owner, repo, tag string) (*Release, error)

+ Latest func(ctx context.Context, owner, repo string) (*Release, error)

+ List func(ctx context.Context, owner, repo string, opts ListOptions) (Page[Release], error)

+ ListAssets func(ctx context.Context, owner, repo string, releaseID int64, opts ListOptions) (Page[Asset], error)

+ UploadAsset func(ctx context.Context, owner, repo string, releaseID int64, name string, ...) (*Asset, error)

+ type Repo struct

+ Archived bool

+ CloneURL string

+ CreatedAt time.Time

+ DefaultBranch string

+ Description string

+ Empty bool

+ Fork bool

+ FullName string

+ HTMLURL string

+ ID int64

+ Mirror bool

+ Name string

+ Owner string

+ SSHURL string

+ Template bool

+ UpdatedAt time.Time

+ Visibility Visibility

+ Website string

+ type Repos interface

+ Create func(ctx context.Context, opts CreateRepoOptions) (*Repo, error)

+ Delete func(ctx context.Context, owner, name string) error

+ Edit func(ctx context.Context, owner, name string, opts EditRepoOptions) (*Repo, error)

+ Get func(ctx context.Context, owner, name string) (*Repo, error)

+ List func(ctx context.Context, owner string, opts ListOptions) (Page[Repo], error)

+ type Review struct

+ Body string

+ CommitID string

+ HTMLURL string

+ ID int64

+ Reviewer string

+ State ReviewState

+ SubmittedAt time.Time

+ type ReviewEvent string

+ const ReviewEventApprove

+ const ReviewEventComment

+ const ReviewEventRequestChanges

+ type ReviewState string

+ const ReviewApproved

+ const ReviewChangesRequested

+ const ReviewCommented

+ const ReviewDismissed

+ const ReviewPending

+ const ReviewRequested

+ type Tag struct

+ Message string

+ Name string

+ SHA string

+ TarballURL string

+ ZipballURL string

+ type TagProtection struct

+ Allowlist Allowlist

+ ID int64

+ Pattern string

+ type TagProtections interface

+ Create func(ctx context.Context, owner, repo string, rule TagProtection) (*TagProtection, error)

+ Delete func(ctx context.Context, owner, repo, pattern string) error

+ Get func(ctx context.Context, owner, repo, pattern string) (*TagProtection, error)

+ List func(ctx context.Context, owner, repo string) ([]TagProtection, error)

+ Update func(ctx context.Context, owner, repo, pattern string, rule TagProtection) (*TagProtection, error)

+ type Tags interface

+ Create func(ctx context.Context, owner, repo string, opts CreateTagOptions) (*Tag, error)

+ Delete func(ctx context.Context, owner, repo, name string) error

+ Get func(ctx context.Context, owner, repo, name string) (*Tag, error)

+ List func(ctx context.Context, owner, repo string, opts ListOptions) (Page[Tag], error)

+ type Team struct

+ CanCreateOrgRepo bool

+ Description string

+ ID int64

+ IncludesAllRepos bool

+ Name string

+ Org string

+ Permission TeamPermission

+ Units map[TeamUnit]TeamPermission

+ type TeamAccess struct

+ Permission TeamPermission

+ Units map[TeamUnit]TeamPermission

+ type TeamPermission string

+ const TeamPermissionAdmin

+ const TeamPermissionNone

+ const TeamPermissionOwner

+ const TeamPermissionRead

+ const TeamPermissionWrite

+ type TeamUnit string

+ const TeamUnitActions

+ const TeamUnitCode

+ const TeamUnitExternalIssues

+ const TeamUnitExternalWiki

+ const TeamUnitIssues

+ const TeamUnitPackages

+ const TeamUnitProjects

+ const TeamUnitPulls

+ const TeamUnitReleases

+ const TeamUnitWiki

+ type Teams interface

+ AddMember func(ctx context.Context, id int64, user string) error

+ AddRepo func(ctx context.Context, id int64, owner, repo string) error

+ Create func(ctx context.Context, org string, opts CreateTeamOptions) (*Team, error)

+ Delete func(ctx context.Context, id int64) error

+ Edit func(ctx context.Context, id int64, opts EditTeamOptions) (*Team, error)

+ Get func(ctx context.Context, id int64) (*Team, error)

+ GetByName func(ctx context.Context, org, name string) (*Team, error)

+ IsMember func(ctx context.Context, id int64, user string) (bool, error)

+ List func(ctx context.Context, org string, opts ListOptions) (Page[Team], error)

+ Members func(ctx context.Context, id int64, opts ListOptions) (Page[User], error)

+ RemoveMember func(ctx context.Context, id int64, user string) error

+ RemoveRepo func(ctx context.Context, id int64, owner, repo string) error

+ Repos func(ctx context.Context, id int64, opts ListOptions) (Page[Repo], error)

+ type UnsupportedVersionError struct

+ Backend Backend

+ Minimum string

+ Version string

+ func (e *UnsupportedVersionError) Error() string

+ type User struct

+ Active bool

+ CreatedAt time.Time

+ Description string

+ Email string

+ FullName string

+ HTMLURL string

+ ID int64

+ IsAdmin bool

+ LastLogin time.Time

+ Location string

+ Login string

+ ProhibitLogin bool

+ Restricted bool

+ Visibility OwnerVisibility

+ Website string

+ type Users interface

+ Create func(ctx context.Context, opts CreateUserOptions) (*User, error)

+ Delete func(ctx context.Context, login string, opts DeleteUserOptions) error

+ Edit func(ctx context.Context, login string, opts EditUserOptions) (*User, error)

+ Get func(ctx context.Context, login string) (*User, error)

+ List func(ctx context.Context, opts ListOptions) (Page[User], error)

+ Rename func(ctx context.Context, login, newLogin string) error

+ type Visibility string

+ const VisibilityInternal

+ const VisibilityPrivate

+ const VisibilityPublic

+ func (v Visibility) Valid() bool

+ type Webhook struct

+ Active bool

+ BranchFilter string

+ ContentType HookContentType

+ CreatedAt time.Time

+ Events []HookEvent

+ ID int64

+ URL string

+ UpdatedAt time.Time

+ type Webhooks interface

+ Create func(ctx context.Context, scope HookScope, opts CreateWebhookOptions) (*Webhook, error)

+ Delete func(ctx context.Context, scope HookScope, id int64) error

+ Edit func(ctx context.Context, scope HookScope, id int64, opts EditWebhookOptions) (*Webhook, error)

+ Get func(ctx context.Context, scope HookScope, id int64) (*Webhook, error)

+ List func(ctx context.Context, scope HookScope, opts ListOptions) (Page[Webhook], error)

+ Ping func(ctx context.Context, scope HookScope, id int64) error

v0.1.6

Oct 20, 2026

v0.1.5

Oct 20, 2026

v0.1.0

Oct 18, 2026

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL