Represents the data and utilities that are contextually available inside the implementation of a Task.
Attributes
- Companion
- object
- Source
- TaskCtx.scala
- Graph
-
- Supertypes
Members list
Value members
Concrete methods
Stops the Mill process.
Deprecated methods
Attributes
- Deprecated
-
[Since version Mill 1.0.4]Use `systemExitWithReason` instead - Source
- TaskCtx.scala
Inherited and Abstract methods
Attributes
- Inherited from:
- Args
- Source
- TaskCtx.scala
Attributes
- Inherited from:
- Args
- Source
- TaskCtx.scala
Task.dest is a unique os.Path (e.g. out/classFiles.dest/ or out/run.dest/) that is assigned to every task or Command. It is cleared before your task runs, and you can use it as a scratch space for temporary files or a place to put returned artifacts. This is guaranteed to be unique for every Task or Command, so you can be sure that you will not collide or interfere with anyone else writing to those same paths.
Task.dest is a unique os.Path (e.g. out/classFiles.dest/ or out/run.dest/) that is assigned to every task or Command. It is cleared before your task runs, and you can use it as a scratch space for temporary files or a place to put returned artifacts. This is guaranteed to be unique for every Task or Command, so you can be sure that you will not collide or interfere with anyone else writing to those same paths.
Attributes
- Inherited from:
- Dest
- Source
- TaskCtx.scala
Task.env is the environment variable map passed to the Mill command when it is run; typically used inside a Task.Input to ensure any changes in the env vars are properly detected.
Task.env is the environment variable map passed to the Mill command when it is run; typically used inside a Task.Input to ensure any changes in the env vars are properly detected.
Note that you should not use sys.env, as Mill's long-lived server process means that sys.env variables may not be up to date.
Attributes
- Inherited from:
- Env
- Source
- TaskCtx.scala
Fail this task with a message. This is a convenient alternative to returning Result.Failure which also requires the happy path to return Result.Success.
Fail this task with a message. This is a convenient alternative to returning Result.Failure which also requires the happy path to return Result.Success.
Attributes
- Inherited from:
- Fail
- Source
- TaskCtx.scala
Provides APIs for Mill tasks to spawn async "future" computations that can be awaited upon to yield their result. Unlike other thread pools or Executors, fork.async spawns futures that follow Mill's -j/--jobs config, sandbox their os.pwd in separate folders, and integrate with Mill's terminal logging prefixes and prompt so a user can easily see what futures are running and what logs belong to each future.
Provides APIs for Mill tasks to spawn async "future" computations that can be awaited upon to yield their result. Unlike other thread pools or Executors, fork.async spawns futures that follow Mill's -j/--jobs config, sandbox their os.pwd in separate folders, and integrate with Mill's terminal logging prefixes and prompt so a user can easily see what futures are running and what logs belong to each future.
Attributes
- Inherited from:
- Fork
- Source
- TaskCtx.scala
Attributes
- Inherited from:
- Jobs
- Source
- TaskCtx.scala
Task.log is the default logger provided for every task. While your task is running, System.out and System.in are also redirected to this logger. The logs for a task are streamed to standard out/error as you would expect, but each task's specific output is also streamed to a log file on disk, e.g. out/run.log or out/classFiles.log for you to inspect later.
Task.log is the default logger provided for every task. While your task is running, System.out and System.in are also redirected to this logger. The logs for a task are streamed to standard out/error as you would expect, but each task's specific output is also streamed to a log file on disk, e.g. out/run.log or out/classFiles.log for you to inspect later.
Messages logged with log.debug appear by default only in the log files. You can use the --debug option when running mill to show them on the console too.
Attributes
- Inherited from:
- Log
- Source
- TaskCtx.scala
Attributes
- Inherited from:
- Offline
- Source
- TaskCtx.scala
This is the os.Path pointing to the project root directory.
This is the os.Path pointing to the project root directory.
This is the preferred access to the project directory, and should always be preferred over os.pwd* (which might also point to the project directory in classic cli scenarios, but might not in other use cases like BSP or LSP server usage).
Attributes
- Inherited from:
- Workspace
- Source
- TaskCtx.scala