github

package

v0.3.1 Latest Latest Go to latest Published: Mar 16, 2026 License: Apache-2.0 Imports: 12 Imported by: 0

Details

Package github implements a collector that reads from the GitHub attestations store.

View Source

const (
	TypeMoniker = "github"
)

View Source

var Build = func(istr string) (attestation.Repository, error) {
	return New(WithRepo(istr))
}

Implement the factory function

View Source

var SupportedAlgorithms = []string{
	string(ita.AlgorithmSHA256), string(ita.AlgorithmSHA512),
}

func WithInit(init string) optFn

func WithOwner(owner string) optFn

func WithRepo(repo string) optFn

func WithToken(token string) optFn

type Collector struct {
	Options Options
	// contains filtered or unexported fields
}

func New(funcs ...optFn) (*Collector, error)

New returns a new collector

func (c *Collector) Fetch(ctx context.Context, opts attestation.FetchOptions) ([]attestation.Envelope, error)

Fetch queries the repository and retrieves any attestations matching the query

func (c *Collector) FetchBySubject(ctx context.Context, opts attestation.FetchOptions, subj []attestation.Subject) ([]attestation.Envelope, error)

FetchBySubject is the only method supported as the GitHub api can only list attestations by subject.

func (c *Collector) Store(ctx context.Context, _ attestation.StoreOptions, envelopes []attestation.Envelope) error

Store implements the attestations.Storer interface

type Options struct {
	Owner string
	Repo  string
	// Access token (uses GITHUB_TOKEN if unset)
	Token string
}