project

Documentation

Index

• Constants
• Variables
• func DetectProjectAndStackFrom(stackDir string) (p *v1.Project, s *v1.Stack, err error)
• func DetectProjectAndStacks() (*v1.Project, *v1.Stack, error)
• func FindAllProjectsFrom(path string) ([]*v1.Project, error)
• func FindAllStacksFrom(path string) ([]*v1.Stack, error)
• func GetStackFrom(path string) (*v1.Stack, error)
• func IsStack(path string) bool
• type Storage

Constants

const (
	ProjectFile = "project.yaml"
	StackFile   = "stack.yaml"
)

Variables

var (
	ErrNotProjectDirectory = errors.New("path must be a project directory")
	ErrProjectNotUnique    = errors.New("the project obtained is not unique")
	ErrNotStackDirectory   = errors.New("path must be a stack directory")
	ErrStackNotUnique      = errors.New("the stack obtained is not unique")
)

Functions

func DetectProjectAndStackFrom

func DetectProjectAndStackFrom(stackDir string) (p *v1.Project, s *v1.Stack, err error)

DetectProjectAndStackFrom try to get stack and project from given path

func DetectProjectAndStacks

func DetectProjectAndStacks() (*v1.Project, *v1.Stack, error)

DetectProjectAndStacks locates the closest project and stack from the current working directory, or an error if not found.

func FindAllProjectsFrom

func FindAllProjectsFrom(path string) ([]*v1.Project, error)

FindAllProjectsFrom find all project from the given path

func FindAllStacksFrom

func FindAllStacksFrom(path string) ([]*v1.Stack, error)

FindAllStacksFrom find all stacks from the given path

func GetStackFrom

func GetStackFrom(path string) (*v1.Stack, error)

GetStackFrom get stack from the given path

func IsStack

func IsStack(path string) bool

IsStack determine whether the given path is Stack directory

Types

type Storage

type Storage interface {
	// Get returns a specified Graph.
	Get() (map[string][]string, error)
}

Storage is used to provide storage service for multiple Releases of a specified Project and Workspace.