Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Retriever ¶
type Retriever struct {
RepositorySlug string
Branch string // default is main
FilePath string
GithubToken string
Timeout time.Duration // default is 10 seconds
// BaseURL is the base URL for the GitHub API.
// If not specified, it defaults to "https://api.github.com" for GitHub.com.
// For GitHub Enterprise instances, specify your instance URL (e.g., "https://github.acme.com/api/v3").
BaseURL string
// GitHub App authentication fields.
// AppID and InstallationID are required together with either
// PrivateKey (PEM string) or PrivateKeyFile (path to a PEM file).
// Mutually exclusive with GithubToken / AuthToken.
AppID int64
InstallationID int64
PrivateKey string // PEM-encoded RSA private key
PrivateKeyFile string // path to a PEM file; takes precedence over PrivateKey if both are set
// contains filtered or unexported fields
}
Retriever is a configuration struct for a GitHub retriever.
func (*Retriever) SetHTTPClient ¶
func (r *Retriever) SetHTTPClient(client internal.HTTPClient)
SetHTTPClient is here if you want to override the default http.Client we are using. It is also used for the tests.
Click to show internal directories.
Click to hide internal directories.