SDK API reference: `sparkwing/inputs`

SDK API reference: sparkwing/inputs

Package inputs builds cache keys from files, environment variables, and constants.

Import as swinputs "github.com/sparkwing-dev/sparkwing/sparkwing/inputs". The root package and the other subpackages are indexed in sdk-reference.md.

FunctionsSection anchor link

  • func Compose(resolvers ...sparkwing.CacheKeyFn) sparkwing.CacheKeyFn -- Compose combines keys with sparkwing.Key.
  • func Const(s string) sparkwing.CacheKeyFn -- Const returns the supplied key.
  • func Env(names ...string) sparkwing.CacheKeyFn -- Env hashes the named environment variables in sorted name order.
  • func Files(globs ...string) sparkwing.CacheKeyFn -- Files hashes tracked files matching the supplied patterns.
  • func RepoFiles(options ...RepoFilesOption) sparkwing.CacheKeyFn -- RepoFiles hashes every tracked file.
  • func Tree(root string) sparkwing.CacheKeyFn -- Tree hashes every regular file under root and skips symlinks.

TypesSection anchor link

type RepoFilesOptionSection anchor link

type RepoFilesOption func(*repoFilesConfig)
  • func Ignore(patterns ...string) RepoFilesOption -- Ignore excludes matching tracked paths from RepoFiles.