note

package

v0.2.9 Latest Latest Go to latest Published: Mar 7, 2026 License: Apache-2.0 Imports: 22 Imported by: 0

Details

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

Repository

github.com/carabiner-dev/collector

Links

Open Source Insights

Documentation ¶

Overview ¶

Package note implements an attestation fetcher that can read from git commit notes.

Index ¶

Variables
func WithHttpAuth(username, password string) optFn
func WithInit(init string) optFn
func WithLocator(locator string) optFn
func WithPush(push bool) optFn
type Collector
- func New(funcs ...optFn) (*Collector, error)
type Options
- func (o *Options) Validate() error

Constants ¶

This section is empty.

Variables ¶

View Source

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

Implement the factory function

View Source

var TypeMoniker = "note"

Functions ¶

func WithHttpAuth ¶ added in v0.2.7

func WithHttpAuth(username, password string) optFn

func WithInit ¶ added in v0.2.7

func WithInit(init string) optFn

func WithLocator ¶

func WithLocator(locator string) optFn

func WithPush ¶ added in v0.2.7

func WithPush(push bool) optFn

Types ¶

type Collector ¶

type Collector struct {
	Options Options
}

func New ¶

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

func (*Collector) Fetch ¶

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 (*Collector) FetchByPredicateType ¶

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

func (*Collector) FetchBySubject ¶

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

FetchBySubject calls the attestation reader with a filter preconfigured with subject hashes.

func (*Collector) Store ¶ added in v0.2.7

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

Store implements the attestation.Storer interface

type Options ¶

type Options struct {
	Locator string
	// Push determines whether to push notes to remote after storing.
	// If nil, defaults to true for remote repos, false for local file:// repos.
	Push *bool

	// Username and password to use when git connects via HTTP
	HttpUsername, HttpPassword string
}

func (*Options) Validate ¶

func (o *Options) Validate() error

Source Files ¶

View all Source files

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