Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

github

package

Go to main page

Versions in this module

v1

v1.2.0

Nov 12, 2025

Changes in this version

+ type GitHubAPIError struct

+ Err error

+ Operation string

+ Owner string

+ Repo string

+ Status string

+ func (e *GitHubAPIError) Error() string

+ func (e *GitHubAPIError) Unwrap() error

+ type GitHubAbuseRateLimitError struct

+ Err error

+ Operation string

+ Owner string

+ Repo string

+ RetryAfter time.Duration

+ func (e *GitHubAbuseRateLimitError) Error() string

+ func (e *GitHubAbuseRateLimitError) Unwrap() error

+ type GitHubAcceptedError struct

+ Err error

+ Operation string

+ Owner string

+ Repo string

+ func (e *GitHubAcceptedError) Error() string

+ func (e *GitHubAcceptedError) Unwrap() error

+ type GitHubRateLimitError struct

+ Err error

+ Operation string

+ Owner string

+ Remaining int

+ Repo string

+ ResetTime time.Time

+ func (e *GitHubRateLimitError) Error() string

+ func (e *GitHubRateLimitError) Unwrap() error

v1.1.1

Mar 11, 2025

v1.1.0

Mar 11, 2025

Changes in this version

+ type AppInfo struct

+ Name string

+ type AuthInfo struct

+ AppID int64

+ GithubToken string

+ InstallationID int64

+ PrivateKey []byte

+ type CICheckStatus interface

+ Outcome func() CIStatus

+ Type func() string

+ type CIStatus uint

+ const CIStatusFailed

+ const CIStatusPassed

+ const CIStatusPending

+ const CIStatusSkipped

+ const CIStatusUnknown

+ func (c CIStatus) String() string

+ type CheckCIStatus interface

+ type CheckCIStatusForChecks interface

+ GetCIStatusForChecks func(ctx context.Context, owner, repo string, commitHash string, ...) (CIStatus, []string, error)

+ type CheckOverallCIStatus interface

+ GetCIStatus func(ctx context.Context, owner, repo string, commitHash string, excludes []string) (CIStatus, error)

+ type CheckPRMerged interface

+ IsPRMergedOrClosed func(ctx context.Context, owner, repo string, pr int) (string, bool, int64, error)

+ type CheckRun struct

+ CheckSuite CheckSuiteInfo

+ Conclusion string

+ Name string

+ Status string

+ func (c CheckRun) Outcome() CIStatus

+ func (c CheckRun) String() string

+ func (c CheckRun) Type() string

+ type CheckSuiteInfo struct

+ App AppInfo

+ WorkflowRun struct{ ... }

+ type GHClient struct

+ func AuthenticateWithApp(ctx context.Context, logger *slog.Logger, privateKey []byte, ...) (GHClient, error)

+ func AuthenticateWithToken(ctx context.Context, logger *slog.Logger, token string, ...) GHClient

+ func NewGithubClient(ctx context.Context, logger *slog.Logger, authInfo AuthInfo, ...) (GHClient, error)

+ func (c GHClient) GetCIStatus(ctx context.Context, owner, repoName, ref string, excludes []string) (CIStatus, error)

+ func (c GHClient) GetCIStatusForChecks(ctx context.Context, owner, repoName string, ref string, checkNames []string) (CIStatus, []string, error)

+ func (c GHClient) GetDetailedCIStatus(ctx context.Context, owner, repoName, ref string) ([]CICheckStatus, error)

+ func (c GHClient) GetPRHeadSHA(ctx context.Context, owner, repo string, prNumber int) (string, error)

+ func (c GHClient) IsPRMergedOrClosed(ctx context.Context, owner, repo string, prNumber int) (string, bool, int64, error)

+ type GetDetailedCIStatus interface

+ GetDetailedCIStatus func(ctx context.Context, owner, repo string, commitHash string) ([]CICheckStatus, error)

+ type GetPRHeadSHA interface

+ GetPRHeadSHA func(ctx context.Context, owner, repo string, pr int) (string, error)

+ type PageInfo struct

+ EndCursor *string

+ HasNextPage bool

+ type RollupContextNode struct

+ CheckRun CheckRun

+ StatusContext StatusContext

+ Typename string

+ type RollupContexts struct

+ CheckRunCount int

+ Nodes []RollupContextNode

+ PageInfo PageInfo

+ StatusContextCount int

+ type StatusCheckRollup struct

+ Contexts RollupContexts

+ State string

+ type StatusContext struct

+ Context string

+ State string

+ func (s StatusContext) Outcome() CIStatus

+ func (s StatusContext) String() string

+ func (s StatusContext) Type() string

+ type WorkflowInfo struct

+ Name string