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
- API
  
  Reference documentation for the pkg.go.dev API
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.4.0

Jul 28, 2026

v1.3.1

Jun 26, 2026

v1.3.0

Mar 30, 2026

Changes in this version

type Credentials

+ Key string

+ Provider string

v1.2.0

Mar 9, 2026

Changes in this version

+ func EmptyCommitOnBranchWithDefaultClient(ctx context.Context, req githubv4.CreateCommitOnBranchInput, opts ...GHOption) (string, error)

+ type CheckRunConclusion string

+ const CheckRunConclusionActionRequired

+ const CheckRunConclusionCancelled

+ const CheckRunConclusionFailure

+ const CheckRunConclusionNeutral

+ const CheckRunConclusionSkipped

+ const CheckRunConclusionSuccess

+ const CheckRunConclusionTimedOut

+ type CheckRunStatus string

+ const CheckRunStatusCompleted

+ const CheckRunStatusInProgress

+ const CheckRunStatusQueued

+ type Client struct

+ V3 *github.Client

+ V4 *githubv4.Client

+ type CommitOnBranchRequest struct

+ Branch string

+ Message string

+ Owner string

+ Repository string

+ type CommitStatus string

+ const CommitStatusError

+ const CommitStatusFailure

+ const CommitStatusPending

+ const CommitStatusSuccess

+ type Controller struct

+ func NewController(opts ...GHOption) (*Controller, error)

+ func (g *Controller) CompareCommits(pCtx *promotion.Context, base, head string) (*github.CommitsComparison, error)

+ func (g *Controller) CreatePromotionTargetRef(pCtx *promotion.Context) (*github.Reference, error)

+ func (g *Controller) CreatePullRequest(ctx *promotion.Bus) (*github.PullRequest, error)

+ func (g *Controller) EmptyCommitOnBranch(ctx context.Context, clients *Client, ...) (string, error)

+ func (g *Controller) FastForwardRefToSha(pCtx *promotion.Context) error

+ func (g *Controller) FindPullRequest(pCtx *promotion.Context) (*github.PullRequest, error)

+ func (g *Controller) ForceUpdateRefToSha(pCtx *promotion.Context) error

+ func (g *Controller) GetGitHubClients(body []byte) (*Client, error)

+ func (g *Controller) GetPromotionSourceRootRef(pCtx *promotion.Context) (*string, error)

+ func (g *Controller) ListPullRequestCommits(pCtx *promotion.Context) ([]*github.RepositoryCommit, error)

+ func (g *Controller) PromotionTargetRefExists(ctx *promotion.Context) bool

+ func (g *Controller) RequestTitle(pCtx promotion.Context) *string

+ func (g *Controller) RetrieveCredentials() error

+ func (g *Controller) SendPromotionFeedbackCheckRun(bus *promotion.Bus, conclusion CheckRunConclusion) error

+ func (g *Controller) SendPromotionFeedbackCommitStatus(bus *promotion.Bus, commitStatus CommitStatus) error

+ func (g *Controller) ValidateWebhookSecret(secret []byte, headers map[string]string) error

+ type Credentials struct

+ AppID int64

+ PrivateKey string

+ Token string

+ WebhookSecret *validation.WebhookSecret

+ type EventInstallationID struct

+ Installation struct{ ... }

+ type GHOption func(*Controller)

+ func WithAWSController(aws *aws.Controller) GHOption

+ func WithAuthMode(mode string) GHOption

+ func WithLogger(logger *slog.Logger) GHOption

+ func WithSSMKey(key string) GHOption

+ func WithToken(token string) GHOption

+ func WithWebhookSecret(secret *validation.WebhookSecret) GHOption