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.7.0

Jan 5, 2026

Changes in this version

type GitHubClient

+ func (ghc *GitHubClient) SetMainPath(path string)

v1.6.0

Dec 29, 2025

Changes in this version

+ type GitHubClient struct

+ func NewGitHubClient(owner, repo, token string) *GitHubClient

+ func NewGitHubClientWithServices(prService PullRequestsService, issuesService IssuesService, ...) *GitHubClient

+ func (ghc *GitHubClient) AddLabelsToPR(ctx context.Context, prNumber int, labels []string) error

+ func (ghc *GitHubClient) CreateIssue(ctx context.Context, title string, body string, labels []string, ...) (*models.Issue, error)

+ func (ghc *GitHubClient) CreateLabel(ctx context.Context, name, color, description string) error

+ func (ghc *GitHubClient) CreateRelease(ctx context.Context, release *models.Release, notes *models.ReleaseNotes, ...) error

+ func (ghc *GitHubClient) GetAuthenticatedUser(ctx context.Context) (string, error)

+ func (ghc *GitHubClient) GetClosedIssuesBetweenTags(ctx context.Context, previousTag, _ string) ([]models.Issue, error)

+ func (ghc *GitHubClient) GetContributorsBetweenTags(ctx context.Context, previousTag, currentTag string) ([]string, error)

+ func (ghc *GitHubClient) GetFileAtTag(ctx context.Context, tag, filepath string) (string, error)

+ func (ghc *GitHubClient) GetFileStatsBetweenTags(ctx context.Context, previousTag, currentTag string) (*models.FileStatistics, error)

+ func (ghc *GitHubClient) GetIssue(ctx context.Context, issueNumber int) (*models.Issue, error)

+ func (ghc *GitHubClient) GetMergedPRsBetweenTags(ctx context.Context, previousTag, _ string) ([]models.PullRequest, error)

+ func (ghc *GitHubClient) GetPR(ctx context.Context, prNumber int) (models.PRData, error)

+ func (ghc *GitHubClient) GetPRIssues(ctx context.Context, branchName string, commits []string, prDescription string) ([]models.Issue, error)

+ func (ghc *GitHubClient) GetRelease(ctx context.Context, version string) (*models.VCSRelease, error)

+ func (ghc *GitHubClient) GetRepoLabels(ctx context.Context) ([]string, error)

+ func (ghc *GitHubClient) UpdateIssueChecklist(ctx context.Context, issueNumber int, checkedIndices []int) error

+ func (ghc *GitHubClient) UpdatePR(ctx context.Context, prNumber int, summary models.PRSummary) error

+ func (ghc *GitHubClient) UpdateRelease(ctx context.Context, version, body string) error

+ type IssuesService interface

+ AddLabelsToIssue func(ctx context.Context, owner, repo string, number int, labels []string) ([]*github.Label, *github.Response, error)

+ Create func(ctx context.Context, owner, repo string, issue *github.IssueRequest) (*github.Issue, *github.Response, error)

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

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

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

+ ListByRepo func(ctx context.Context, owner, repo string, opts *github.IssueListByRepoOptions) ([]*github.Issue, *github.Response, error)

+ ListLabels func(ctx context.Context, owner, repo string, opts *github.ListOptions) ([]*github.Label, *github.Response, error)

+ type MockBinaryBuilderFactory struct

+ func (m *MockBinaryBuilderFactory) NewBuilder(mainPath, binaryName string, opts ...builder.Option) binaryBuilder

+ type MockBinaryPackager struct

+ func (m *MockBinaryPackager) BuildAndPackageAll(ctx context.Context, progressCh chan<- models.BuildProgress) ([]string, error)

+ type MockIssuesService struct

+ func (m *MockIssuesService) AddLabelsToIssue(ctx context.Context, owner, repo string, number int, labels []string) ([]*github.Label, *github.Response, error)

+ func (m *MockIssuesService) Create(ctx context.Context, owner, repo string, issue *github.IssueRequest) (*github.Issue, *github.Response, error)

+ func (m *MockIssuesService) CreateLabel(ctx context.Context, owner, repo string, label *github.Label) (*github.Label, *github.Response, error)

+ func (m *MockIssuesService) Edit(ctx context.Context, owner, repo string, number int, ...) (*github.Issue, *github.Response, error)

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

+ func (m *MockIssuesService) ListByRepo(ctx context.Context, owner, repo string, opts *github.IssueListByRepoOptions) ([]*github.Issue, *github.Response, error)

+ func (m *MockIssuesService) ListLabels(ctx context.Context, owner, repo string, opts *github.ListOptions) ([]*github.Label, *github.Response, error)

+ type MockPRService struct

+ func (m *MockPRService) Edit(ctx context.Context, owner, repo string, number int, pr *github.PullRequest) (*github.PullRequest, *github.Response, error)

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

+ func (m *MockPRService) GetRaw(ctx context.Context, owner, repo string, number int, opts github.RawOptions) (string, *github.Response, error)

+ func (m *MockPRService) List(ctx context.Context, owner, repo string, opts *github.PullRequestListOptions) ([]*github.PullRequest, *github.Response, error)

+ func (m *MockPRService) ListCommits(ctx context.Context, owner, repo string, number int, opts *github.ListOptions) ([]*github.RepositoryCommit, *github.Response, error)

+ type MockReleaseService struct

+ func (m *MockReleaseService) CreateRelease(ctx context.Context, owner, repo string, release *github.RepositoryRelease) (*github.RepositoryRelease, *github.Response, error)

+ func (m *MockReleaseService) EditRelease(ctx context.Context, owner, repo string, id int64, ...) (*github.RepositoryRelease, *github.Response, error)

+ func (m *MockReleaseService) GetReleaseByTag(ctx context.Context, owner, repo, tag string) (*github.RepositoryRelease, *github.Response, error)

+ func (m *MockReleaseService) UploadReleaseAsset(ctx context.Context, owner, repo string, id int64, opt *github.UploadOptions, ...) (*github.ReleaseAsset, *github.Response, error)

+ type MockRepoService struct

+ func (m *MockRepoService) CompareCommits(ctx context.Context, owner, repo, base, head string, opts *github.ListOptions) (*github.CommitsComparison, *github.Response, error)

+ func (m *MockRepoService) GetCommit(ctx context.Context, owner, repo, sha string, opts *github.ListOptions) (*github.RepositoryCommit, *github.Response, error)

+ func (m *MockRepoService) GetContents(ctx context.Context, owner, repo, path string, ...) (*github.RepositoryContent, []*github.RepositoryContent, *github.Response, ...)

+ type MockUserService struct

+ func (m *MockUserService) Get(ctx context.Context, user string) (*github.User, *github.Response, error)

+ type PullRequestsService interface

+ Edit func(ctx context.Context, owner, repo string, number int, pr *github.PullRequest) (*github.PullRequest, *github.Response, error)

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

+ GetRaw func(ctx context.Context, owner, repo string, number int, opts github.RawOptions) (string, *github.Response, error)

+ List func(ctx context.Context, owner, repo string, opts *github.PullRequestListOptions) ([]*github.PullRequest, *github.Response, error)

+ ListCommits func(ctx context.Context, owner, repo string, number int, opts *github.ListOptions) ([]*github.RepositoryCommit, *github.Response, error)

+ type ReleasesService interface

+ CreateRelease func(ctx context.Context, owner, repo string, release *github.RepositoryRelease) (*github.RepositoryRelease, *github.Response, error)

+ EditRelease func(ctx context.Context, owner, repo string, id int64, ...) (*github.RepositoryRelease, *github.Response, error)

+ GetReleaseByTag func(ctx context.Context, owner, repo, tag string) (*github.RepositoryRelease, *github.Response, error)

+ UploadReleaseAsset func(ctx context.Context, owner, repo string, id int64, opt *github.UploadOptions, ...) (*github.ReleaseAsset, *github.Response, error)

+ type RepositoriesService interface

+ CompareCommits func(ctx context.Context, owner, repo, base, head string, opts *github.ListOptions) (*github.CommitsComparison, *github.Response, error)

+ GetCommit func(ctx context.Context, owner, repo, sha string, opts *github.ListOptions) (*github.RepositoryCommit, *github.Response, error)

+ GetContents func(ctx context.Context, owner, repo, path string, ...) (*github.RepositoryContent, []*github.RepositoryContent, *github.Response, ...)

+ type UsersService interface

+ Get func(ctx context.Context, user string) (*github.User, *github.Response, error)