Documentation
¶
Index ¶
- Constants
- func CacheDir() string
- func CtxDeps(ctx context.Context, fns ...interface{})
- func Deps(fns ...interface{})
- func ExitStatus(err error) int
- func Fatal(code int, args ...interface{}) error
- func Fatalf(code int, format string, args ...interface{}) error
- func SerialCtxDeps(ctx context.Context, fns ...interface{})
- func SerialDeps(fns ...interface{})
- func Verbose() bool
Constants ¶
const CacheEnv = "MAGEFILE_CACHE"
CacheEnv is the environment variable that users may set to change the location where mage stores its compiled binaries.
Variables ¶
This section is empty.
Functions ¶
func CacheDir ¶
func CacheDir() string
CacheDir returns the directory where mage caches compiled binaries. It defaults to $HOME/.magefile, but may be overridden by the MAGEFILE_CACHE environment variable.
func CtxDeps ¶
CtxDeps runs the given functions as dependencies of the calling function. Dependencies must only be of type: github.com/magefile/mage/types.FuncType. The function calling Deps is guaranteed that all dependent functions will be run exactly once when Deps returns. Dependent functions may in turn declare their own dependencies using Deps. Each dependency is run in their own goroutines. Each function is given the context provided if the function prototype allows for it.
func Deps ¶
func Deps(fns ...interface{})
Deps runs the given functions with the default runtime context
func ExitStatus ¶
ExitStatus queries the error for an exit status. If the error is nil, it returns 0. If the error does not implement ExitStatus() int, it returns 1. Otherwise it retiurns the value from ExitStatus().
func Fatal ¶
Fatal returns an error that will cause mage to print out the given args and exit with the given exit code.
func Fatalf ¶
Fatalf returns an error that will cause mage to print out the given message and exit with an exit code of 1.
func SerialCtxDeps ¶
SerialCtxDeps is like CtxDeps except it runs each dependency serially, instead of in parallel. This can be useful for resource intensive dependencies that shouldn't be run at the same time.
func SerialDeps ¶
func SerialDeps(fns ...interface{})
SerialDeps is like Deps except it runs each dependency serially, instead of in parallel. This can be useful for resource intensive dependencies that shouldn't be run at the same time.
Types ¶
This section is empty.
Source Files