Documentation
¶
Index ¶
- Constants
- func CacheDir() string
- func CtxDeps(ctx context.Context, fns ...interface{})
- func Debug() bool
- 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 GoCmd() string
- func IgnoreDefault() bool
- func SerialCtxDeps(ctx context.Context, fns ...interface{})
- func SerialDeps(fns ...interface{})
- func Verbose() bool
- type Namespace
Constants ¶
const CacheEnv = "MAGEFILE_CACHE"
CacheEnv is the environment variable that users may set to change the location where mage stores its compiled binaries.
const DebugEnv = "MAGEFILE_DEBUG"
DebugEnv is the environment variable that indicates the user requested debug mode when running mage.
const GoCmdEnv = "MAGEFILE_GOCMD"
GoCmdEnv is the environment variable that indicates the user requested verbose mode when running a magefile.
const IgnoreDefaultEnv = "MAGEFILE_IGNOREDEFAULT"
IgnoreDefaultEnv is the environment variable that indicates the user requested to ignore the default target specified in the magefile.
const VerboseEnv = "MAGEFILE_VERBOSE"
VerboseEnv is the environment variable that indicates the user requested verbose mode when running a magefile.
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 ¶ added in v1.2.4
CtxDeps runs the given functions as dependencies of the calling function. Dependencies must only be of type:
func() func() error func(context.Context) func(context.Context) error
Or a similar method on a mg.Namespace type.
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 Debug ¶ added in v1.2.4
func Debug() bool
Debug reports whether a magefile was run with the verbose flag.
func Deps ¶
func Deps(fns ...interface{})
Deps runs the given functions in parallel, exactly once. Dependencies must only be of type:
func() func() error func(context.Context) func(context.Context) error
Or a similar method on a mg.Namespace type.
This is a way to build up a tree of dependencies with each dependency defining its own dependencies. Functions must have the same signature as a Mage target, i.e. optional context argument, optional error return.
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 the given exit code.
func GoCmd ¶ added in v1.3.0
func GoCmd() string
GoCmd reports the command that Mage will use to build go code. By default mage runs the "go" binary in the PATH.
func IgnoreDefault ¶ added in v1.5.0
func IgnoreDefault() bool
IgnoreDefault reports whether the user has requested to ignore the default target in the magefile.
func SerialCtxDeps ¶ added in v1.2.4
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 ¶ added in v1.2.4
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.
Source Files