github

package

Go to main page

Versions in this module

v0

v0.0.50

Apr 10, 2026

Changes in this version

type CommitListOptions

+ MaxResults int

+ type FileHistoryOptions struct

+ BaseCommit string

+ ForceCutoff bool

+ Limit int

+ LimitDays *int

+ MaxDownloadSize int64

+ MaxWorkers int

+ SizeThresholdKB int

+ type FileHistoryService interface

+ GetFileHistory func(ctx context.Context, session *GitHubSession, owner, repo, path string, ...) ([]*FileRevision, error)

+ type FileRevision struct

+ Commit Commit

+ FileBytes []byte

type GitHubService

+ CreateAnonymousSession func(config *SessionConfig) *GitHubSession

+ CreateSessionWithOptionalToken func(token string, config *SessionConfig) *GitHubSession

type GitHubSession

+ func NewAnonymousGitHubSession(config *SessionConfig) *GitHubSession

v0.0.49

Mar 8, 2026

v0.0.48

Feb 28, 2026

v0.0.47

Feb 24, 2026

Changes in this version

+ const DefaultBufferSize

+ const DefaultPageSize

+ const DefaultRetryAttempts

+ const DefaultRetryDelay

+ const EventSendTimeout

+ const MaxPageSize

+ const MaxProgressEvents

+ const MaxWaitTime

+ const ProgressThreshold

+ const RateLimitWarning

+ func CalculateBackoffDelay(attempt int, baseDelay time.Duration) time.Duration

+ func EstimatePageCapacity(itemSize, targetMemoryMB int) int

+ func ExampleFileOperations()

+ func ExamplePullRequestWorkflow()

+ func ExampleSessionMetadata()

+ func ExampleUsage()

+ func ExampleWithEventStreaming()

+ func FetchCreate[T any, R any](ctx context.Context, rh *RequestHandler, fetcher ResourceSingleFetcher[T], ...) (R, error)

+ func FetchPaginated[T any, R any](ctx context.Context, rh *RequestHandler, fetcher ResourceFetcher[T], ...) ([]R, error)

+ func FetchSingle[T any, R any](ctx context.Context, rh *RequestHandler, fetcher ResourceSingleFetcher[T], ...) (R, error)

+ func LogCritical(msg string, fields ...LogField)

+ func LogDebug(msg string, fields ...LogField)

+ func LogError(msg string, fields ...LogField)

+ func LogInfo(msg string, fields ...LogField)

+ func LogWarn(msg string, fields ...LogField)

+ func SetGlobalLogger(logger Logger)

+ func ValidateGitHubIdentifier(identifier, fieldName string) error

+ func ValidateRepositoryPath(owner, repo string) error

+ func ValidateSession(session *GitHubSession) error

+ type AuthenticationService interface

+ AuthenticateUser func(ctx context.Context, session *GitHubSession) (*User, error)

+ type Branch struct

+ Label string

+ Name string

+ Repo Repository

+ SHA string

+ User User

+ type Comment struct

+ Body string

+ CreatedAt time.Time

+ ID int64

+ URL string

+ UpdatedAt time.Time

+ User User

+ type CommentService interface

+ AddPullRequestComment func(ctx context.Context, session *GitHubSession, owner, repo string, number int, ...) (*Comment, error)

+ EditPullRequestComment func(ctx context.Context, session *GitHubSession, owner, repo string, ...) (*Comment, error)

+ GetPullRequestComments func(ctx context.Context, session *GitHubSession, owner, repo string, number int) ([]Comment, error)

+ type Commit struct

+ Author CommitAuthor

+ Committer CommitAuthor

+ CreatedAt time.Time

+ Files []CommitFile

+ Message string

+ Parents []CommitRef

+ SHA string

+ Stats CommitStats

+ URL string

+ type CommitAuthor struct

+ Date time.Time

+ Email string

+ Name string

+ type CommitFile struct

+ Additions int

+ BlobURL string

+ Changes int

+ Deletions int

+ Filename string

+ Patch string

+ RawURL string

+ Status string

+ type CommitListOptions struct

+ Author string

+ Path string

+ SHA string

+ Since time.Time

+ Until time.Time

+ type CommitRef struct

+ SHA string

+ URL string

+ type CommitService interface

+ GetCommit func(ctx context.Context, session *GitHubSession, owner, repo, sha string) (*Commit, error)

+ GetCommitHistory func(ctx context.Context, session *GitHubSession, owner, repo, sha string, ...) ([]Commit, error)

+ GetCommitList func(ctx context.Context, session *GitHubSession, owner, repo, path string, ...) ([]Commit, error)

+ GetCommitRange func(ctx context.Context, session *GitHubSession, owner, repo, base, head string) ([]Commit, error)

+ type CommitStats struct

+ Additions int

+ Deletions int

+ Total int

+ type CreatePullRequestRequest struct

+ Base string

+ Body string

+ Draft bool

+ Head string

+ Issue int

+ MaintainerCanModify bool

+ Title string

+ type CreateTagRequest struct

+ Message string

+ Object string

+ Tag string

+ Tagger CommitAuthor

+ Type string

+ type DefaultHTTPClientProvider struct

+ func NewDefaultHTTPClientProvider() *DefaultHTTPClientProvider

+ func (p *DefaultHTTPClientProvider) GetClient(token string) *github.Client

+ func (p *DefaultHTTPClientProvider) GetClientWithConfig(token string, config *SessionConfig) *github.Client

+ type DefaultSessionManager struct

+ func NewDefaultSessionManager(httpClientProvider HTTPClientProvider, validationService ValidationService, ...) *DefaultSessionManager

+ func (sm *DefaultSessionManager) CreateSession(token string, config *SessionConfig) GitHubSessionInterface

+ func (sm *DefaultSessionManager) ValidateSession(session GitHubSessionInterface) error

+ type DefaultValidationService struct

+ func NewDefaultValidationService() *DefaultValidationService

+ func (v *DefaultValidationService) ValidateGitHubIdentifier(identifier, fieldName string) error

+ func (v *DefaultValidationService) ValidateOperation(operation string) error

+ func (v *DefaultValidationService) ValidateRepositoryPath(owner, repo string) error

+ func (v *DefaultValidationService) ValidateToken(token string) error

+ type Event struct

+ Duration time.Duration

+ ID string

+ Message string

+ Metadata map[string]interface{}

+ Operation string

+ Owner string

+ Progress *ProgressInfo

+ RateLimit *RateLimitInfo

+ Repository string

+ SessionID string

+ Status EventStatus

+ Timestamp time.Time

+ Type EventType

+ type EventBuilder struct

+ func NewEventBuilder(sessionID, operation string, eventType EventType) *EventBuilder

+ func (eb *EventBuilder) BuildCompleteEvent(message string) Event

+ func (eb *EventBuilder) BuildError(message string, err error, statusCode int) GitHubError

+ func (eb *EventBuilder) BuildProgressEvent(message string) Event

+ func (eb *EventBuilder) BuildStartEvent(message string) Event

+ func (eb *EventBuilder) WithMetadata(key string, value interface{}) *EventBuilder

+ func (eb *EventBuilder) WithProgress(current, total int) *EventBuilder

+ func (eb *EventBuilder) WithRateLimit(limit, remaining int, reset time.Time) *EventBuilder

+ func (eb *EventBuilder) WithRepository(owner, repo string) *EventBuilder

+ type EventChannelManager interface

+ CreateEventChannels func(bufferSize int) *EventChannels

+ SendError func(channels *EventChannels, err GitHubError) error

+ SendEvent func(channels *EventChannels, event Event) error

+ type EventChannels struct

+ Errors chan GitHubError

+ Events chan Event

+ func NewEventChannels(bufferSize int) *EventChannels

+ func (ec *EventChannels) Close()

+ type EventStatus string

+ const EventStatusCompleted

+ const EventStatusFailed

+ const EventStatusInProgress

+ const EventStatusStarted

+ type EventType string

+ const EventTypeAuthUser

+ const EventTypeCommentAdd

+ const EventTypeCommentEdit

+ const EventTypeCommentGet

+ const EventTypeCommitGet

+ const EventTypeCommitList

+ const EventTypeFileGet

+ const EventTypeFileGetContent

+ const EventTypeOperationComplete

+ const EventTypeOperationProgress

+ const EventTypeOperationStart

+ const EventTypeOrganizationGet

+ const EventTypeOrganizationList

+ const EventTypePullRequestCreate

+ const EventTypePullRequestGet

+ const EventTypePullRequestList

+ const EventTypePullRequestMerge

+ const EventTypeRepositoryGet

+ const EventTypeRepositoryList

+ const EventTypeTagCreate

+ const EventTypeTagList

+ type FileContent struct

+ Content string

+ DownloadURL string

+ Encoding string

+ Name string

+ Path string

+ SHA string

+ Size int

+ Type string

+ URL string

+ type FileService interface

+ GetFileContent func(ctx context.Context, session *GitHubSession, owner, repo, path, ref string) (*FileContent, error)

+ GetFileRevision func(ctx context.Context, session *GitHubSession, owner, repo, path, sha string) (*FileContent, error)

+ type GitHubError struct

+ Err error

+ ID string

+ Message string

+ Metadata map[string]interface{}

+ Operation string

+ Owner string

+ RateLimit *RateLimitInfo

+ Repository string

+ SessionID string

+ StatusCode int

+ Timestamp time.Time

+ Type EventType

+ func (e *GitHubError) Error() string

+ func (e *GitHubError) Unwrap() error

+ type GitHubService interface

+ CreateSession func(token string, config *SessionConfig) *GitHubSession

+ func NewGitHubService() GitHubService

+ func NewGitHubServiceWithDependencies(sessionManager SessionManager, validationService ValidationService, ...) GitHubService

+ type GitHubSession struct

+ Client *github.Client

+ Config *SessionConfig

+ ID string

+ Metadata *SessionMetadata

+ Token string

+ func NewGitHubSession(token string, config *SessionConfig) *GitHubSession

+ func (s *GitHubSession) Close() error

+ func (s *GitHubSession) GetCustomMetadata(key string) (interface{}, bool)

+ func (s *GitHubSession) GetEventChannels() *EventChannels

+ func (s *GitHubSession) GetID() string

+ func (s *GitHubSession) GetMetadata() *SessionMetadata

+ func (s *GitHubSession) GetRateLimit() *RateLimitInfo

+ func (s *GitHubSession) GetToken() string

+ func (s *GitHubSession) IncrementErrorCount()

+ func (s *GitHubSession) IncrementRequestCount()

+ func (s *GitHubSession) Initialize(ctx context.Context) error

+ func (s *GitHubSession) IsActive() bool

+ func (s *GitHubSession) SetCustomMetadata(key string, value interface{})

+ func (s *GitHubSession) String() string

+ func (s *GitHubSession) UpdateActivity()

+ func (s *GitHubSession) WaitForRateLimit(ctx context.Context) error

+ type GitHubSessionInterface interface

+ Close func() error

+ GetCustomMetadata func(key string) (interface{}, bool)

+ GetEventChannels func() *EventChannels

+ GetID func() string

+ GetMetadata func() *SessionMetadata

+ GetRateLimit func() *RateLimitInfo

+ GetToken func() string

+ IncrementErrorCount func()

+ IncrementRequestCount func()

+ Initialize func(ctx context.Context) error

+ IsActive func() bool

+ SetCustomMetadata func(key string, value interface{})

+ String func() string

+ UpdateActivity func()

+ WaitForRateLimit func(ctx context.Context) error

+ type HTTPClientProvider interface

+ GetClient func(token string) *github.Client

+ GetClientWithConfig func(token string, config *SessionConfig) *github.Client

+ type Label struct

+ Color string

+ Default bool

+ Description string

+ ID int64

+ Name string

+ type ListOptions struct

+ Page int

+ PerPage int

+ type LogField struct

+ Key string

+ Value interface{}

+ func CountField(count int) LogField

+ func DurationField(duration time.Duration) LogField

+ func ErrorField(err error) LogField

+ func Field(key string, value interface{}) LogField

+ func StatusCodeField(code int) LogField

+ type LogLevel int

+ const LogLevelCritical

+ const LogLevelDebug

+ const LogLevelError

+ const LogLevelInfo

+ const LogLevelWarn

+ func (l LogLevel) String() string

+ type Logger interface

+ Critical func(msg string, fields ...LogField)

+ Debug func(msg string, fields ...LogField)

+ Error func(msg string, fields ...LogField)

+ Info func(msg string, fields ...LogField)

+ Warn func(msg string, fields ...LogField)

+ WithContext func(ctx context.Context) Logger

+ WithOperation func(operationID string) Logger

+ WithSession func(sessionID string) Logger

+ func GetGlobalLogger() Logger

+ type MetricsCollector interface

+ RecordAPICall func(operation string, duration time.Duration, statusCode int)

+ RecordError func(operation string, errorType string)

+ RecordRateLimit func(remaining, limit int)

+ RecordSessionActivity func(sessionID string, requestCount, errorCount int64)

+ type NoOpMetricsCollector struct

+ func NewNoOpMetricsCollector() *NoOpMetricsCollector

+ func (m *NoOpMetricsCollector) RecordAPICall(operation string, duration time.Duration, statusCode int)

+ func (m *NoOpMetricsCollector) RecordError(operation string, errorType string)

+ func (m *NoOpMetricsCollector) RecordRateLimit(remaining, limit int)

+ func (m *NoOpMetricsCollector) RecordSessionActivity(sessionID string, requestCount, errorCount int64)

+ type Organization struct

+ AvatarURL string

+ CreatedAt time.Time

+ Description string

+ ID int64

+ Login string

+ Name string

+ Type string

+ URL string

+ UpdatedAt time.Time

+ type OrganizationService interface

+ GetOrganizationRepositories func(ctx context.Context, session *GitHubSession, org string) ([]Repository, error)

+ GetUserOrganizations func(ctx context.Context, session *GitHubSession) ([]Organization, error)

+ type PaginationConfig struct

+ MaxResults int

+ Page int

+ PerPage int

+ func DefaultPaginationConfig() *PaginationConfig

+ func (pc *PaginationConfig) Validate() error

+ type ProductionLogger struct

+ func NewProductionLogger(level LogLevel) *ProductionLogger

+ func (l *ProductionLogger) Critical(msg string, fields ...LogField)

+ func (l *ProductionLogger) Debug(msg string, fields ...LogField)

+ func (l *ProductionLogger) Error(msg string, fields ...LogField)

+ func (l *ProductionLogger) Info(msg string, fields ...LogField)

+ func (l *ProductionLogger) Warn(msg string, fields ...LogField)

+ func (l *ProductionLogger) WithContext(ctx context.Context) Logger

+ func (l *ProductionLogger) WithOperation(operationID string) Logger

+ func (l *ProductionLogger) WithSession(sessionID string) Logger

+ type ProgressInfo struct

+ Current int

+ Percent int

+ Total int

+ type PullRequest struct

+ Assignees []User

+ Base Branch

+ Body string

+ ClosedAt *time.Time

+ CreatedAt time.Time

+ DiffURL string

+ Draft bool

+ Head Branch

+ ID int64

+ Labels []Label

+ Mergeable bool

+ Merged bool

+ MergedAt *time.Time

+ Number int

+ PatchURL string

+ State string

+ Title string

+ URL string

+ UpdatedAt time.Time

+ User User

+ type PullRequestComment struct

+ CommitID string

+ DiffHunk string

+ OriginalCommitID string

+ OriginalPosition int

+ Path string

+ Position int

+ PullRequestURL string

+ type PullRequestListOptions struct

+ Base string

+ Direction string

+ Head string

+ Sort string

+ State string

+ type PullRequestService interface

+ CreatePullRequest func(ctx context.Context, session *GitHubSession, owner, repo string, ...) (*PullRequest, error)

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

+ GetPullRequestsWithTag func(ctx context.Context, session *GitHubSession, owner, repo, tag string) ([]PullRequest, error)

+ ListPullRequests func(ctx context.Context, session *GitHubSession, owner, repo string, ...) ([]PullRequest, error)

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

+ type RateLimitInfo struct

+ Limit int

+ Remaining int

+ Reset time.Time

+ type Repository struct

+ CloneURL string

+ CreatedAt time.Time

+ DefaultBranch string

+ Description string

+ Fork bool

+ ForkCount int

+ FullName string

+ ID int64

+ Language string

+ Name string

+ Owner User

+ Private bool

+ PushedAt time.Time

+ SSHURL string

+ StarCount int

+ URL string

+ UpdatedAt time.Time

+ type RepositoryService interface

+ GetAllUserRepositories func(ctx context.Context, session *GitHubSession) ([]Repository, error)

+ GetRepository func(ctx context.Context, session *GitHubSession, owner, repo string) (*Repository, error)

+ type RequestHandler struct

+ func NewRequestHandler(session *GitHubSession, operation string, eventType EventType) *RequestHandler

+ func (rh *RequestHandler) HandleResponse(resp *github.Response, err error, operation string) error

+ func (rh *RequestHandler) SendCompleteEvent(message string)

+ func (rh *RequestHandler) SendProgressEvent(message string, current, total int)

+ func (rh *RequestHandler) SendStartEvent(message string)

+ func (rh *RequestHandler) WithRepository(owner, repo string) *RequestHandler

+ type RequestHandlerInterface interface

+ HandleResponse func(resp *github.Response, err error, operation string) error

+ SendCompleteEvent func(message string)

+ SendProgressEvent func(message string, current, total int)

+ SendStartEvent func(message string)

+ WithRepository func(owner, repo string) RequestHandlerInterface

+ type ResourceConverter func(T) R

+ type ResourceFetcher func(opts *github.ListOptions) ([]T, *github.Response, error)

+ type ResourceSingleFetcher func() (T, *github.Response, error)

+ type SessionConfig struct

+ Custom map[string]interface{}

+ CustomHTTPClient *http.Client

+ EnableMetrics bool

+ EnableRateLimit bool

+ EventChannels *EventChannels

+ MaxRetries int

+ RetryDelay time.Duration

+ Timeout time.Duration

+ func DefaultSessionConfig() *SessionConfig

+ type SessionManager interface

+ CreateSession func(token string, config *SessionConfig) GitHubSessionInterface

+ ValidateSession func(session GitHubSessionInterface) error

+ type SessionMetadata struct

+ CreatedAt time.Time

+ Custom map[string]interface{}

+ ErrorCount int64

+ LastActivity time.Time

+ RateLimit *RateLimitInfo

+ RequestCount int64

+ Scopes []string

+ UserEmail string

+ UserID int64

+ UserLogin string

+ UserName string

+ type Tag struct

+ Commit CommitRef

+ Name string

+ TarballURL string

+ ZipballURL string

+ type TagService interface

+ CreateTag func(ctx context.Context, session *GitHubSession, owner, repo string, ...) (*Tag, error)

+ ListTags func(ctx context.Context, session *GitHubSession, owner, repo string) ([]Tag, error)

+ type User struct

+ AvatarURL string

+ CreatedAt time.Time

+ Email string

+ ID int64

+ Login string

+ Name string

+ Type string

+ URL string

+ UpdatedAt time.Time

+ type ValidationService interface

+ ValidateGitHubIdentifier func(identifier, fieldName string) error

+ ValidateOperation func(operation string) error

+ ValidateRepositoryPath func(owner, repo string) error

+ ValidateToken func(token string) error

v0.0.46

Feb 10, 2026

v0.0.45

Feb 9, 2026

v0.0.44

Feb 6, 2026

v0.0.43

Feb 4, 2026

v0.0.42

Feb 3, 2026

v0.0.41

Dec 19, 2025

v0.0.40

Oct 22, 2025

v0.0.39

Sep 22, 2025

v0.0.38

Sep 14, 2025

v0.0.37

Sep 14, 2025

v0.0.36

Aug 26, 2025

v0.0.35

Aug 20, 2025

v0.0.34

Aug 6, 2025

v0.0.33

Aug 4, 2025

v0.0.32

Jul 31, 2025

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