env

Documentation

Index

• type GFlowsEnv
  • func NewGFlowsEnv(fs *afero.Afero, installer *GFlowsLibInstaller, context *config.GFlowsContext, ...) *GFlowsEnv
  • func (env *GFlowsEnv) CleanUp()
  • func (env *GFlowsEnv) GetLibPaths(workflowName string) ([]string, error)
  • func (env *GFlowsEnv) GetPackages() ([]pkg.GFlowsPackage, error)
  • func (env *GFlowsEnv) LoadDependency(path string) (*GFlowsLib, error)
• type GFlowsLib
  • func NewGFlowsLib(fs *afero.Afero, installer *GFlowsLibInstaller, logger *io.Logger, path string, ...) (*GFlowsLib, error)
  • func (lib *GFlowsLib) CleanUp()
  • func (lib *GFlowsLib) GetPathInfo(localPath string) (*pkg.PathInfo, error)
  • func (lib *GFlowsLib) LibsDir() string
  • func (lib *GFlowsLib) Setup() error
  • func (lib *GFlowsLib) WorkflowsDir() string
• type GFlowsLibInstaller
  • func NewGFlowsLibInstaller(fs *afero.Afero, reader *content.Reader, writer *content.Writer, ...) *GFlowsLibInstaller
  • func (installer *GFlowsLibInstaller) CleanUp()
• type GFlowsLibManifest
  • func ParseManifest(content string) (*GFlowsLibManifest, error)

Types

type GFlowsEnv

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

func NewGFlowsEnv

func NewGFlowsEnv(fs *afero.Afero, installer *GFlowsLibInstaller, context *config.GFlowsContext, logger *io.Logger) *GFlowsEnv

func (*GFlowsEnv) CleanUp

func (env *GFlowsEnv) CleanUp()

func (*GFlowsEnv) GetLibPaths

func (env *GFlowsEnv) GetLibPaths(workflowName string) ([]string, error)

GetLibPaths - returns search paths for the given workflow (including libs and local dependency directories)

func (*GFlowsEnv) GetPackages

func (env *GFlowsEnv) GetPackages() ([]pkg.GFlowsPackage, error)

func (*GFlowsEnv) LoadDependency

func (env *GFlowsEnv) LoadDependency(path string) (*GFlowsLib, error)

type GFlowsLib

type GFlowsLib struct {
	// Path - the path to the package. Can be remote, local (relative) or local (absolute).
	Path string

	// ManifestPath - the path to the manifest, computed from Path.
	ManifestPath string

	// PackageName - the name of the package. This defaults to the name of the parent directory of
	// the manifest, but will be updated to the name in the manifest if given.
	PackageName string

	// LocalDir - the local directory of the library, to add to the lib paths. If ManifestPath is
	// local then this will simply be the directory containing ManifestPath. If ManifestPath is
	// remote, then this will be a local temp directory.
	LocalDir string

	// Files - content of the package as an array of FileInfo
	Files []*pkg.PathInfo
	// contains filtered or unexported fields
}

func NewGFlowsLib

func NewGFlowsLib(fs *afero.Afero, installer *GFlowsLibInstaller, logger *io.Logger, path string, context *config.GFlowsContext) (*GFlowsLib, error)

func (*GFlowsLib) CleanUp

func (lib *GFlowsLib) CleanUp()

func (*GFlowsLib) GetPathInfo

func (lib *GFlowsLib) GetPathInfo(localPath string) (*pkg.PathInfo, error)

func (*GFlowsLib) LibsDir

func (lib *GFlowsLib) LibsDir() string

func (*GFlowsLib) Setup

func (lib *GFlowsLib) Setup() error

func (*GFlowsLib) WorkflowsDir

func (lib *GFlowsLib) WorkflowsDir() string

type GFlowsLibInstaller

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

func NewGFlowsLibInstaller

func NewGFlowsLibInstaller(
	fs *afero.Afero,
	reader *content.Reader,
	writer *content.Writer,
	logger *io.Logger,
	repoManager *content.RepoManager,
) *GFlowsLibInstaller

func (*GFlowsLibInstaller) CleanUp

func (installer *GFlowsLibInstaller) CleanUp()

type GFlowsLibManifest

type GFlowsLibManifest struct {
	// Files - the list of files in the library. If the manifest is remote, this list is used to
	// download the files.
	Files []string

	// Libs - deprecated field, use Files instead
	Libs []string

	// Name - the name of the package
	Name string
}

func ParseManifest

func ParseManifest(content string) (*GFlowsLibManifest, error)