upstreamcommit

package

v1.0.0 Latest Latest Go to latest Published: Sep 25, 2026 License: MIT Imports: 11 Imported by: 0

Details

Package upstreamcommit manages generated component configuration files that pin resolved upstream commits.

View Source

const DefaultDir = "base/upstream-commits"

DefaultDir is the project-relative directory that holds the generated per-component upstream-commit TOML files.

This section is empty.

This section is empty.

type Store struct {
	// contains filtered or unexported fields
}

Store reads and writes generated upstream-commit component configuration.

func NewStore(fs opctx.FS, dir string) *Store

NewStore creates a store rooted at dir.

func (s *Store) Dir() string

Dir returns the generated configuration directory.

func (s *Store) Exists(componentName string) (bool, error)

Exists reports whether a generated TOML exists for componentName.

func (s *Store) FindOrphans(
	components map[string]projectconfig.ComponentConfig,
) ([]string, error)

FindOrphans returns generated component TOMLs that do not correspond to an upstream component in components.

func (s *Store) Get(componentName string) (commit string, exists bool, err error)

Get returns the upstream commit in a component's generated TOML file.

func (s *Store) Path(componentName string) (string, error)

Path returns the generated TOML path for componentName.

func (s *Store) PruneOrphans(components map[string]projectconfig.ComponentConfig) (int, error)

PruneOrphans removes generated TOMLs that are no longer needed.

func (s *Store) Remove(componentName string) (bool, error)

Remove deletes the generated TOML for componentName if it exists.

func (s *Store) Save(componentName, upstreamCommit string) error

Save writes a generated component TOML override containing only upstreamCommit.