Documentation ¶
Overview ¶
Package gotaskr provides the basic methods to register and run tasks. It also provides the main entrypoint for gotaskr.
Index ¶
- Variables
- func AddFollowupTask(taskName ...string)
- func Execute() int
- func FinishTimeMeasurement(timeMeasurement *TimeMeasurement)
- func GetArgument(argName string) (string, bool)
- func GetArgumentOrDefault(argName string, defaultValue string) (string, bool)
- func HasArgument(argName string) bool
- func MeasureTime(measurementName string, f func() error) error
- func RunTarget(target string) error
- func Setup(setupFunc func() error)
- func TaskSetup(taskFunc func() error)
- func TaskTeardown(taskFunc func() error)
- func Teardown(taskFunc func() error)
- type TaskObject
- func (taskObject *TaskObject) Argument(argumentName string, argumentDescription string, optional bool) *TaskObject
- func (taskObject *TaskObject) ContinueOnError() *TaskObject
- func (taskObject *TaskObject) DeferOnError() *TaskObject
- func (taskObject *TaskObject) DependeeOf(taskName ...string) *TaskObject
- func (taskObject *TaskObject) DependeeOfTask(task ...*TaskObject) *TaskObject
- func (taskObject *TaskObject) DependsOn(taskName ...string) *TaskObject
- func (taskObject *TaskObject) DependsOnTask(task ...*TaskObject) *TaskObject
- func (taskObject *TaskObject) Description(description string) *TaskObject
- func (taskObject *TaskObject) GetName() string
- func (taskObject *TaskObject) Then(taskName ...string) *TaskObject
- func (taskObject *TaskObject) ThenTask(task ...*TaskObject) *TaskObject
- type TimeMeasurement
Constants ¶
This section is empty.
Variables ¶
var Tools *gttools.ToolsClient = gttools.CreateToolsClient()
Tools provides typed access to the various tools supported.
Functions ¶
func AddFollowupTask ¶ added in v0.0.8
func AddFollowupTask(taskName ...string)
AddFollowupTask allows to add one or more tasks that should run after the current finished.
func FinishTimeMeasurement ¶ added in v0.3.8
func FinishTimeMeasurement(timeMeasurement *TimeMeasurement)
func GetArgument ¶
GetArgument returns the value of the argument with the given name and also a flag, if the argument was present or not.
func GetArgumentOrDefault ¶ added in v0.0.3
GetArgumentOrDefault returns the value of the argument with the given name or the given default value if the value was not present and also a flag, if the argument was present or not.
func HasArgument ¶
HasArgument returns true if an arument was set and false otherwise, regardless of the value.
func MeasureTime ¶ added in v0.1.5
func TaskTeardown ¶ added in v0.0.25
func TaskTeardown(taskFunc func() error)
Types ¶
type TaskObject ¶
type TaskObject struct {
// contains filtered or unexported fields
}
TaskObject represents a registered task.
func Task ¶
func Task(name string, taskFunc func() error) *TaskObject
Task registers the given function with the name so it can be executed.
func (*TaskObject) Argument ¶ added in v0.0.12
func (taskObject *TaskObject) Argument(argumentName string, argumentDescription string, optional bool) *TaskObject
Argument adds a description for an argument. Will be shown when the help is displayed.
func (*TaskObject) ContinueOnError ¶ added in v0.0.7
func (taskObject *TaskObject) ContinueOnError() *TaskObject
ContinueOnError will continue with dependencies or dependees even when the task returned an error.
func (*TaskObject) DeferOnError ¶ added in v0.0.7
func (taskObject *TaskObject) DeferOnError() *TaskObject
DeferOnError will continue with dependencies or dependees even when the task returned an error.
func (*TaskObject) DependeeOf ¶ added in v0.0.7
func (taskObject *TaskObject) DependeeOf(taskName ...string) *TaskObject
DependeeOf adds dependees in the given order. Duplicate dependees are removed.
func (*TaskObject) DependeeOfTask ¶ added in v0.1.3
func (taskObject *TaskObject) DependeeOfTask(task ...*TaskObject) *TaskObject
DependeeOfTask adds dependees in the given order. Duplicate dependees are removed.
func (*TaskObject) DependsOn ¶
func (taskObject *TaskObject) DependsOn(taskName ...string) *TaskObject
DependsOn adds dependencies in the given order. Duplicate dependencies are removed.
func (*TaskObject) DependsOnTask ¶ added in v0.1.3
func (taskObject *TaskObject) DependsOnTask(task ...*TaskObject) *TaskObject
DependsOnTask adds dependencies in the given order. Duplicate dependencies are removed.
func (*TaskObject) Description ¶
func (taskObject *TaskObject) Description(description string) *TaskObject
Description sets the description of a task. Will be shown when the help is displayed.
func (*TaskObject) GetName ¶ added in v0.1.2
func (taskObject *TaskObject) GetName() string
GetName gets the name of the task.
func (*TaskObject) Then ¶ added in v0.0.8
func (taskObject *TaskObject) Then(taskName ...string) *TaskObject
Then adds followup tasks in the given order.
func (*TaskObject) ThenTask ¶ added in v0.1.3
func (taskObject *TaskObject) ThenTask(task ...*TaskObject) *TaskObject
Then adds followup tasks in the given order.
type TimeMeasurement ¶ added in v0.3.8
type TimeMeasurement struct {
// contains filtered or unexported fields
}
func StartTimeMeasurement ¶ added in v0.3.8
func StartTimeMeasurement(measurementName string) *TimeMeasurement
func (*TimeMeasurement) Duration ¶ added in v0.3.10
func (t *TimeMeasurement) Duration() time.Duration
func (*TimeMeasurement) Finish ¶ added in v0.3.8
func (t *TimeMeasurement) Finish()
func (*TimeMeasurement) StartTime ¶ added in v0.3.10
func (t *TimeMeasurement) StartTime() time.Time
Directories ¶
Path | Synopsis |
---|---|
Package argparse is a simple parser for command line arguments.
|
Package argparse is a simple parser for command line arguments. |
examples
|
|
Package execr is a wapper to run exec commands.
|
Package execr is a wapper to run exec commands. |
Package goext adds various extensions for the go language.
|
Package goext adds various extensions for the go language. |
Package gttools provides helper methods for various tools.
|
Package gttools provides helper methods for various tools. |