github

package

v0.47.0 Latest Latest Go to latest Published: Dec 29, 2025 License: Apache-2.0 Imports: 10 Imported by: 0

Details

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

Repository

github.com/cashapp/hermit

Links

Open Source Insights

Documentation ¶

Overview ¶

Package github implements a client for GitHub that includes the minimum set of functions required by Hermit.

Index ¶

func AuthenticatedURLRewriter(token string, matcher RepoMatcher) func(uri string) (string, error)
func TokenAuthenticatedTransport(transport http.RoundTripper, token string) http.RoundTripper
type Asset
type Client
- func New(client *http.Client, token string) *Client
type Release
type Repo
type RepoMatcher
- func GlobRepoMatcher(patterns []string) (RepoMatcher, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func AuthenticatedURLRewriter ¶ added in v0.44.4

func AuthenticatedURLRewriter(token string, matcher RepoMatcher) func(uri string) (string, error)

AuthenticatedURLRewriter rewrites GitHub URLs to include an auth token if they match the provided pattern

func TokenAuthenticatedTransport ¶

func TokenAuthenticatedTransport(transport http.RoundTripper, token string) http.RoundTripper

TokenAuthenticatedTransport returns a HTTP transport that will inject a GitHub authentication token into any requests to github.com.

Types ¶

type Asset ¶

type Asset struct {
	Name string `json:"name"`
	URL  string `json:"url"`
}

Asset is a minimal type for assets in the GitHub releases meta information retrieved via the GitHub API.

See https://docs.github.com/en/rest/reference/repos#list-releases

type Client ¶

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

Client for GitHub.

func New ¶

func New(client *http.Client, token string) *Client

New creates a new GitHub API client.

func (*Client) Download ¶ added in v0.3.3

func (a *Client) Download(asset Asset) (resp *http.Response, err error)

Download creates a download request for retrieving a release asset from GitHub.

func (*Client) ETag ¶ added in v0.10.0

func (a *Client) ETag(asset Asset) (etag string, err error)

ETag issues a HEAD request for an Asset and returns its ETag.

func (*Client) LatestRelease ¶

func (a *Client) LatestRelease(repo string) (*Release, error)

LatestRelease details for a GitHub repository.

func (*Client) ProjectForURL ¶

func (a *Client) ProjectForURL(sourceURL string) string

ProjectForURL returns the <repo>/<project> for the given URL if it is a GitHub project.

func (*Client) Release ¶ added in v0.10.0

func (a *Client) Release(repo, tag string) (*Release, error)

Release attempts to fetch Release info for a tag.

func (*Client) Releases ¶

func (a *Client) Releases(repo string, limit int) (releases []*Release, err error)

Releases for a particular repo. If limit is 0, fetches all releases.

func (*Client) Repo ¶

func (a *Client) Repo(repo string) (*Repo, error)

Repo information.

type Release ¶

type Release struct {
	TagName string  `json:"tag_name"`
	Assets  []Asset `json:"assets"`
}

Release is a minimal type for GitHub releases meta information retrieved via the GitHub API.

See https://docs.github.com/en/rest/reference/repos#list-releases

type Repo ¶

type Repo struct {
	Description string `json:"description"`
	Homepage    string `json:"homepage"`
}

Repo information.

type RepoMatcher ¶ added in v0.44.4

type RepoMatcher func(owner, repo string) bool

RepoMatcher is used to determine which repositories will use authenticated requests.

func GlobRepoMatcher ¶ added in v0.44.4

func GlobRepoMatcher(patterns []string) (RepoMatcher, error)

GlobRepoMatcher accepts a list of glob patterns and returns a RepoMatcher that will match 'owner/repo' pairs against the globs.

It returns an error if any of the patterns are invalid.

Source Files ¶

View all Source files

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