githubretriever

package
v1.59.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 18, 2026 License: MIT Imports: 24 Imported by: 3

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) Init added in v1.59.0

func (r *Retriever) Init(_ context.Context, _ *fflog.FFLogger) error

Init validates the authentication configuration.

func (*Retriever) Retrieve

func (r *Retriever) Retrieve(ctx context.Context) ([]byte, error)

Retrieve is the function in charge of fetching the flag configuration.

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.

func (*Retriever) Shutdown added in v1.59.0

func (r *Retriever) Shutdown(_ context.Context) error

Shutdown drops the cached installation token and sets the status as not ready.

func (*Retriever) Status added in v1.59.0

func (r *Retriever) Status() retriever.Status

Status is the function returning the internal state of the retriever.

Jump to

Keyboard shortcuts

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