stepcache

package

v0.0.21 Latest Latest Go to latest Published: Oct 26, 2026 License: MIT Imports: 9 Imported by: 0

Documentation ¶

Overview ¶

Package stepcache builds a StepCache from config: off (the default, never hits) or dir (one marker file per passed key under a directory), and derives the content-addressed key a step is cached under.

Index ¶

func Digest(ctx context.Context, cb interfaces.Codebase, sel types.FileSelector) ([]byte, error)
func IsOff(c interfaces.StepCache) bool
func Key(inputs []byte, toolVersion string, args []string) string
func NewFromConfig(cfg Config) (interfaces.StepCache, error)
type Config
type Kind

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Digest ¶ added in v0.0.20

func Digest(
	ctx context.Context,
	cb interfaces.Codebase,
	sel types.FileSelector,
) ([]byte, error)

Digest is the SHA-256 of the paths and contents of the files sel selects in cb, in path order: the inputs part of a step's Key.

func IsOff ¶ added in v0.0.19

func IsOff(c interfaces.StepCache) bool

IsOff reports whether c is the off cache (or nil), so a caller can skip computing keys nothing will ever look up.

func Key ¶

func Key(inputs []byte, toolVersion string, args []string) string

Key is the hex SHA-256 of a step's inputs, its tool's version and its arguments. Each field is length-prefixed, so no two different field lists share a key.

func NewFromConfig ¶

func NewFromConfig(cfg Config) (interfaces.StepCache, error)

NewFromConfig builds the cache cfg.Kind selects. An unknown kind, or KindDir with no Dir, is CodeInvalidInput. It does no I/O.

Types ¶

type Config ¶

type Config struct {
	// Kind selects the implementation; empty means KindOff.
	Kind Kind `yaml:"kind" mapstructure:"kind"`

	// Dir is KindDir's directory, created on the first Record.
	Dir string `yaml:"dir" mapstructure:"dir"`
}

Config selects and locates the cache.

type Kind ¶

type Kind string

Kind selects a StepCache implementation.

const (
	// KindOff never hits and records nothing (the default).
	KindOff Kind = "off"

	// KindDir records each passed key as a marker file under Config.Dir.
	KindDir Kind = "dir"
)

Source Files ¶

View all Source files

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