Summary

Provides RWX runtime information for the current build, exposing the directories RWX uses for output values and artifacts. These are written to at task execution time and complement static outputs.values / outputs.artifacts declarations in the task YAML.

Namespace

Cake.Common.Build.Rwx.Data

Base Types

object
RwxInfo

graph BT Type-->Base0["RwxInfo"] click Base0 "/api/Cake.Common.Build.Rwx/RwxInfo" Base0-->Base1["object"] Type["RwxRuntimeInfo"] class Type type-node

Syntax

public sealed class RwxRuntimeInfo : RwxInfo

Constructors

Name	Summary
RwxRuntimeInfo(ICakeEnvironment)	Initializes a new instance of the `RwxRuntimeInfo` class.

Properties

Name	Value	Summary
ArtifactsPath	DirectoryPath	Gets the directory into which artifacts can be uploaded. Files copied into this directory are captured as artifacts of the current task.
EnvPath	DirectoryPath	Gets the directory into which environment variables can be exported for downstream tasks. Each file in this directory becomes an environment variable in tasks that depend on the current one via `use`, keyed by filename.
IsRuntimeAvailable	bool	Gets a value indicating whether the values, artifacts, and env directories are all exposed by the current RWX runtime.
ValuesPath	DirectoryPath	Gets the directory in which output values can be written. Each file in this directory becomes an output value keyed by its filename.

Methods

Name	Value	Summary
GetEnvironmentBoolean(string)	bool	Gets an environment variable as a `bool`. Inherited from RwxInfo
GetEnvironmentDirectoryPath(string)	DirectoryPath	Gets an environment variable as a `DirectoryPath`. Inherited from RwxInfo
GetEnvironmentInteger(string)	int	Gets an environment variable as a `int`. Inherited from RwxInfo
GetEnvironmentString(string)	string	Gets an environment variable as a `string`. Inherited from RwxInfo

Extension Methods