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

githubapi

package

Go to main page

Versions in this module

v1

v1.20.0

Nov 2, 2025

v1.19.0

Sep 24, 2025

v1.18.1

May 16, 2025

Changes in this version

+ func ApprovePr(approverClient *github.Client, ghPrClientDetails GhPrClientDetails, ...) error

+ func BumpVersion(ghPrClientDetails GhPrClientDetails, defaultBranch string, filePath string, ...) error

+ func CompareRepoDirectories(ghPrClientDetails GhPrClientDetails, sourcePath string, targetPath string, ...) (bool, string, error)

+ func DetectDrift(ghPrClientDetails GhPrClientDetails) error

+ func DoesPrHasLabel(labels []*github.Label, name string) bool

+ func GeneratePromotionPlan(ghPrClientDetails GhPrClientDetails, config *cfg.Config, configBranch string) (map[string]PromotionInstance, error)

+ func GenerateSyncTreeEntriesForCommit(treeEntries *[]*github.TreeEntry, ghPrClientDetails GhPrClientDetails, ...) error

+ func GetBotGhIdentity(githubGraphQlClient *githubv4.Client, ctx context.Context) (string, error)

+ func GetFileContent(ghPrClientDetails GhPrClientDetails, branch string, filePath string) (string, int, error)

+ func GetInRepoConfig(ghPrClientDetails GhPrClientDetails, defaultBranch string) (*cfg.Config, error)

+ func HandlePREvent(eventPayload *github.PullRequestEvent, ghPrClientDetails GhPrClientDetails, ...)

+ func MainGhMetricsLoop(mainGhClientCache *lru.Cache[string, GhClientPair])

+ func MergePr(details GhPrClientDetails, number int) error

+ func MimizeStalePrComments(ghPrClientDetails GhPrClientDetails, githubGraphQlClient *githubv4.Client, ...) error

+ func ReciveEventFile(eventType string, eventFilePath string, ...)

+ func ReciveWebhook(r *http.Request, mainGhClientCache *lru.Cache[string, GhClientPair], ...) error

+ func SetCommitStatus(ghPrClientDetails GhPrClientDetails, state string)

+ type DiffCommentData struct

+ BranchName string

+ DiffOfChangedComponents []argocd.DiffResult

+ DisplaySyncBranchCheckBox bool

+ type GhClientPair struct

+ func (gcp *GhClientPair) GetAndCache(ghClientCache *lru.Cache[string, GhClientPair], ghAppIdEnvVarName string, ...)

+ type GhPrClientDetails struct

+ Ctx context.Context

+ DefaultBranch string

+ GhClientPair *GhClientPair

+ Labels []*github.Label

+ Owner string

+ PrAuthor string

+ PrLogger *log.Entry

+ PrMetadata prMetadata

+ PrNumber int

+ PrSHA string

+ Ref string

+ Repo string

+ RepoURL string

+ func (p *GhPrClientDetails) GetDefaultBranch() (string, error)

+ func (p *GhPrClientDetails) ToggleCommitStatus(context string, user string) error

+ func (p GhPrClientDetails) CommentOnPr(commentBody string) error

+ type PromotionInstance struct

+ ComputedSyncPaths map[string]string

+ Metadata PromotionInstanceMetaData

+ type PromotionInstanceMetaData struct

+ AutoMerge bool

+ ComponentNames []string

+ PerComponentSkippedTargetPaths map[string][]string

+ SourcePath string

+ TargetDescription string

+ TargetPaths []string