github

package

v1.5.2 Latest Latest Go to latest Published: Jul 31, 2026 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/anoldguy/work

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
type APIError
- func (e *APIError) Error() string
type Client
- func NewClient(domain, token string) *Client
type Org
type Repo
type RepoOwner

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrRepoNotFound = errors.New("repository not found")

ErrRepoNotFound signals that a repository does not exist on this domain, or that the token cannot see it. GitHub returns 404 for both, and to a caller probing several domains they mean the same thing: try the next one.

Functions ¶

This section is empty.

Types ¶

type APIError ¶

type APIError struct {
	StatusCode int
	Body       string
}

APIError represents a non-200 response from the GitHub API.

func (*APIError) Error ¶

func (e *APIError) Error() string

type Client ¶

type Client struct {
	// contains filtered or unexported fields
}

Client provides authenticated access to the GitHub REST API. Supports both github.com and GitHub Enterprise domains.

func NewClient ¶

func NewClient(domain, token string) *Client

NewClient creates an authenticated GitHub API client for the given domain. For github.com, uses https://api.github.com. For GHE domains, uses https://<domain>/api/v3.

func (*Client) Domain ¶

func (c *Client) Domain() string

Domain returns the GitHub domain this client targets.

func (*Client) GetRepo ¶ added in v1.5.1

func (c *Client) GetRepo(ctx context.Context, owner, name string) (*Repo, error)

GetRepo looks up a single repository by owner and name. Unlike the list endpoints, this works for repos the user neither owns nor collaborates on, which is what makes it useful as a cache-miss fallback.

func (*Client) ListOrgRepos ¶

func (c *Client) ListOrgRepos(ctx context.Context, org string) ([]Repo, error)

ListOrgRepos returns all repositories for the given organization.

func (*Client) ListPersonalRepos ¶

func (c *Client) ListPersonalRepos(ctx context.Context) ([]Repo, error)

ListPersonalRepos returns repositories owned by the authenticated user.

func (*Client) ListUserOrgs ¶

func (c *Client) ListUserOrgs(ctx context.Context) ([]Org, error)

ListUserOrgs returns all organizations the authenticated user belongs to.

type Org ¶

type Org struct {
	Login string `json:"login"`
}

Org represents a GitHub organization.

type Repo ¶

type Repo struct {
	Name     string    `json:"name"`
	CloneURL string    `json:"clone_url"`
	Owner    RepoOwner `json:"owner"`
}

Repo represents a GitHub repository returned from the API.

type RepoOwner ¶

type RepoOwner struct {
	Login string `json:"login"`
}

RepoOwner identifies the owner of a GitHub repository.

Source Files ¶

View all Source files

github.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL