API Reference¶
Complete API documentation is available on pkg.go.dev. Each package is documented with function signatures, types, and examples.
Package Documentation¶
| Package | Description | Documentation |
|---|---|---|
gogithub |
Root package with backward-compatible exports | pkg.go.dev |
auth |
Authentication and client creation | pkg.go.dev |
config |
Configuration from environment variables | pkg.go.dev |
search |
Search API with query builder | pkg.go.dev |
repo |
Repository operations | pkg.go.dev |
pr |
Pull request operations | pkg.go.dev |
release |
Release and asset operations | pkg.go.dev |
graphql |
GraphQL API for contribution stats | pkg.go.dev |
errors |
Error types and translation | pkg.go.dev |
pathutil |
Path validation and normalization | pkg.go.dev |
cliutil |
CLI utilities | pkg.go.dev |
Dependencies¶
GoGitHub builds on these excellent libraries:
| Library | Purpose |
|---|---|
| google/go-github | GitHub REST API client |
| shurcooL/githubv4 | GitHub GraphQL API client |
| golang.org/x/oauth2 | OAuth2 authentication |
Version Compatibility¶
| GoGitHub Version | go-github Version | Min Go Version |
|---|---|---|
| v0.6.x | v81 | 1.24 |
| v0.5.x | v81 | 1.24 |
| v0.4.x | v81 | 1.22 |
| v0.3.x | v66 | 1.21 |
Source Code¶
Browse the source code on GitHub: github.com/grokify/gogithub