project

package

Go to main page

Versions in this module

v1

v1.3.1

Apr 29, 2017

v1.3.0

Feb 8, 2017

Changes in this version

+ type BackgroundRunner interface

+ Stop func() error

+ type EvtTaskStop struct

+ Task *Task

type File

+ Commands map[string]*Target

type Project

+ func (p *Project) IsCommand(name string) bool

type Target

+ Command bool

type Task

+ func (t *Task) IsBackground() bool

+ func (t *Task) Stop() (err error)

type TaskResult

+ const Started

type TaskState

+ const Background

v1.2.0

Oct 7, 2016

v1.1.1

Sep 21, 2016

Changes in this version

+ const WrapperDesc

+ const WrapperMagic

+ const WrapperName

+ var ErrWrapperImageMissing = fmt.Errorf("image name missing after " + WrapperMagic)

type File

+ WrapperTarget string

type Project

+ func (p *Project) WrapperTarget() *Target

v1.1.0

Sep 1, 2016

Changes in this version

+ const MaxNameLen

+ var ErrMissingArtifacts = fmt.Errorf("missing artifacts")

+ var ErrNameFirstChar = fmt.Errorf("name must start from a letter or an underscore")

+ var ErrNameMissing = fmt.Errorf("name is required")

+ var ErrNameTooLong = fmt.Errorf("name is too long")

+ var ErrProjectNameMissing = fmt.Errorf("project name is required")

+ func ValidateName(name string) error

+ func ValidateProjectName(name string) error

+ type CommonSettings struct

+ DefaultTargets []string

+ ExecShell string

+ ExecTarget string

+ type ExecSummary []*TaskSummary

+ func (s ExecSummary) ByTarget(target string) *TaskSummary

type Project

+ func (p *Project) Summary() (ExecSummary, error)

type Runner

+ Signature func() string

+ ValidateArtifacts func() bool

type Target

+ Args []string

+ Artifacts []string

+ Exec bool

+ func (t *Target) BaseDir(dirs ...string) string

+ func (t *Target) CommonSettings() (settings CommonSettings, err error)

type Task

+ func (t *Task) CreateRunner() (Runner, error)

+ func (t *Task) ValidateArtifacts() bool

type TaskResult

+ func (r *TaskResult) MarshalJSON() ([]byte, error)

+ func (r *TaskResult) UnmarshalJSON(data []byte) error

type TaskState

+ const Abandoned

+ func (r *TaskState) MarshalJSON() ([]byte, error)

+ func (r *TaskState) UnmarshalJSON(data []byte) error

+ type TaskSummary struct

+ Error string

+ FinishAt time.Time

+ Result TaskResult

+ StartAt time.Time

+ State TaskState

+ Target string

v1.0.0

Jun 27, 2016

Changes in this version

+ const Format

+ const LogFileName

+ const RcFile

+ const RootFile

+ const SettingExecDriver

+ const SummaryFileName

+ const WorkFolder

+ var DefaultExecDriver string

+ var ErrUnsupportedFormat = fmt.Errorf("unsupported format")

+ func RegisterExecDriver(name string, factory RunnerFactory)

+ func RelPath(source, path string) string

+ type EventHandler func(event interface{})

+ type EvtAbortRequested struct

+ Abandon bool

+ Tasks []*Task

+ type EvtTaskAbort struct

+ Abandon bool

+ Signal os.Signal

+ Task *Task

+ type EvtTaskActivated struct

+ Task *Task

+ type EvtTaskFinish struct

+ Task *Task

+ type EvtTaskOutput struct

+ Output []byte

+ Task *Task

+ type EvtTaskStart struct

+ Task *Task

+ type ExecPlan struct

+ DebugLog bool

+ DryRun bool

+ Env map[string]string

+ EventHandler EventHandler

+ FinishedTasks []*Task

+ MaxConcurrency int

+ Project *Project

+ QueuedTasks []*Task

+ RebuildAll bool

+ RebuildTargets map[string]bool

+ RequiredTargets []string

+ RunnerFactory RunnerFactory

+ RunningTasks map[string]*Task

+ SkippedTargets map[string]bool

+ Summary []map[string]interface{}

+ Tasks map[string]*Task

+ WaitingTasks map[string]*Task

+ WorkPath string

+ func NewExecPlan(project *Project) *ExecPlan

+ func (p *ExecPlan) AddTarget(t *Target) (*Task, bool)

+ func (p *ExecPlan) Execute(abortCh <-chan os.Signal) error

+ func (p *ExecPlan) GenerateSummary() (err error)

+ func (p *ExecPlan) Logf(fmt string, args ...interface{})

+ func (p *ExecPlan) OnEvent(handler EventHandler) *ExecPlan

+ func (p *ExecPlan) Rebuild(targets ...string) *ExecPlan

+ func (p *ExecPlan) Require(targets ...string) error

+ func (p *ExecPlan) Skip(targets ...string) *ExecPlan

+ type File struct

+ Desc string

+ Format string

+ Includes []string

+ Local Settings

+ Name string

+ Settings Settings

+ Source string

+ Targets map[string]*Target

+ func LoadFile(baseDir, path string) (*File, error)

+ func (f *File) Merge(s *File) error

+ type Project struct

+ BaseDir string

+ Files []*File

+ LaunchPath string

+ MasterFile File

+ Name string

+ Targets TargetNameMap

+ func LoadProject() (p *Project, err error)

+ func LoadProjectFrom(startDir string) (p *Project, err error)

+ func LocateProject() (*Project, error)

+ func LocateProjectFrom(startDir string) (*Project, error)

+ func (p *Project) DebugLogFile() string

+ func (p *Project) Finalize() error

+ func (p *Project) GetSettings(v interface{}) error

+ func (p *Project) GetSettingsIn(name string, v interface{}) error

+ func (p *Project) Glob(pattern string) (paths []string, err error)

+ func (p *Project) Load(path string) (*File, error)

+ func (p *Project) LoadRcFiles() error

+ func (p *Project) MergeSettingsFlat(flat map[string]interface{}) error

+ func (p *Project) Plan() *ExecPlan

+ func (p *Project) Resolve() error

+ func (p *Project) SummaryFile() string

+ func (p *Project) TargetNames() []string

+ func (p *Project) TargetNamesMatch(pattern string) (names []string, err error)

+ func (p *Project) WorkPath() string

+ type Runner interface

+ Run func(<-chan os.Signal) (TaskResult, error)

+ type RunnerFactory func(*Task) (Runner, error)

+ type Settings map[string]interface

+ func (s Settings) Get(v interface{}) error

+ func (s Settings) GetBy(name string, v interface{}) error

+ func (s Settings) Merge(s1 Settings) error

+ func (s Settings) MergeFlat(flat map[string]interface{}) error

+ type Target struct

+ Activates TargetNameMap

+ After []string

+ Always bool

+ Before []string

+ Depends TargetNameMap

+ Desc string

+ ExecDriver string

+ Ext map[string]interface{}

+ File *File

+ Name string

+ Project *Project

+ Watches []string

+ WorkDir string

+ func (t *Target) AddDep(dep *Target)

+ func (t *Target) BuildWatchList() (list WatchList)

+ func (t *Target) Errorf(format string, args ...interface{}) error

+ func (t *Target) GetExt(v interface{}) error

+ func (t *Target) GetSettings(name string, v interface{}) (err error)

+ func (t *Target) GetSettingsWithExt(name string, v interface{}) (err error)

+ func (t *Target) Initialize(name string, project *Project)

+ func (t *Target) IsTransit() bool

+ func (t *Target) ProjectPath(path string) string

+ func (t *Target) WorkingDir(dirs ...string) string

+ type TargetNameMap map[string]*Target

+ func (m TargetNameMap) Add(t *Target) error

+ func (m TargetNameMap) BuildDeps() error

+ func (m TargetNameMap) CheckCyclicDeps() error

+ func (m TargetNameMap) CompleteName(name string) ([]string, error)

+ func (m TargetNameMap) CompleteNames(in []string, errs *errors.AggregatedError) (out []string)

+ type Task struct

+ Depends map[string]*Task

+ Error error

+ FinishTime time.Time

+ Plan *ExecPlan

+ Result TaskResult

+ StartTime time.Time

+ State TaskState

+ Target *Target

+ func NewTask(p *ExecPlan, t *Target) *Task

+ func (t *Task) Abort(abandon bool, signal os.Signal)

+ func (t *Task) BuildSuccessMark() error

+ func (t *Task) CalcSuccessMark() bool

+ func (t *Task) ClearSuccessMark() error

+ func (t *Task) Duration() time.Duration

+ func (t *Task) EnvVars() []string

+ func (t *Task) IsActivated() bool

+ func (t *Task) Name() string

+ func (t *Task) Project() *Project

+ func (t *Task) Run() (result TaskResult, err error)

+ func (t *Task) SuccessMarkFile() string

+ func (t *Task) Summary() map[string]interface{}

+ func (t *Task) WorkingDir(dirs ...string) string

+ func (t *Task) Write(p []byte) (int, error)

+ type TaskResult int

+ const Aborted

+ const Failure

+ const Skipped

+ const Success

+ const Unknown

+ func (r TaskResult) IsOK() bool

+ func (r TaskResult) String() string

+ type TaskState int

+ const Abadoned

+ const Finished

+ const Queued

+ const Running

+ const Waiting

+ func (r TaskState) String() string

+ type WatchItem struct

+ ModTime time.Time

+ Path string

+ type WatchList []*WatchItem

+ func (w WatchList) Digest() string

+ func (w WatchList) IsEmpty() bool

+ func (w WatchList) String() string

v1.0.0-alpha1

May 6, 2016

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