Struct TaskOptionsConfig 

pub struct TaskOptionsConfig {

    pub affected_files: Option<TaskOptionAffectedFilesEntry>,
    pub allow_failure: Option<bool>,
    pub cache: Option<TaskOptionCache>,
    pub cache_key: Option<String>,
    pub cache_lifetime: Option<String>,
    pub env_file: Option<TaskOptionEnvFile>,
    pub infer_inputs: Option<bool>,
    pub interactive: Option<bool>,
    pub internal: Option<bool>,
    pub merge: Option<TaskMergeStrategy>,
    pub merge_args: Option<TaskMergeStrategy>,
    pub merge_deps: Option<TaskMergeStrategy>,
    pub merge_env: Option<TaskMergeStrategy>,
    pub merge_inputs: Option<TaskMergeStrategy>,
    pub merge_outputs: Option<TaskMergeStrategy>,
    pub merge_toolchains: Option<TaskMergeStrategy>,
    pub mutex: Option<String>,
    pub os: Option<OneOrMany<TaskOperatingSystem>>,
    pub output_style: Option<TaskOutputStyle>,
    pub persistent: Option<bool>,
    pub priority: Option<TaskPriority>,
    pub retry_count: Option<u8>,
    pub run_deps_in_parallel: Option<bool>,
    pub run_in_ci: Option<TaskOptionRunInCI>,
    pub run_from_workspace_root: Option<bool>,
    pub shell: Option<bool>,
    pub timeout: Option<u64>,
    pub unix_shell: Option<TaskUnixShell>,
    pub windows_shell: Option<TaskWindowsShell>,
}

Options to control task inheritance, execution, and more.

Fields

affected_files: Option<TaskOptionAffectedFilesEntry>

The pattern in which affected files will be passed to the task.

allow_failure: Option<bool>

Allow the task to fail without failing the entire action pipeline. @since 1.13.0

cache: Option<TaskOptionCache>

Cache the outputs of the task for incremental builds. Defaults to true if outputs are configured for the task.

cache_key: Option<String>

A custom key to include in the cache hashing process. Can be used to invalidate local and remote caches.

cache_lifetime: Option<String>

Lifetime to cache the task itself, in the format of “1h”, “30m”, etc. If not defined, caches live forever, or until inputs change. @since 1.29.0

env_file: Option<TaskOptionEnvFile>

Loads and sets environment variables from the .env file(s) when running the task.

infer_inputs: Option<bool>

Automatically infer inputs from file groups or environment variables that were utilized within command, script, args, and env. @since 1.31.0

interactive: Option<bool>

Marks the task as interactive, so that it will run in isolation, and have direct access to stdin. @since 1.12.0

internal: Option<bool>

Marks the task as internal, which disables it from being ran from the command line, but can still be depended on by other tasks. @since 1.23.0

merge: Option<TaskMergeStrategy>

The default strategy to use when merging args, deps, env, inputs, or outputs with an inherited task. Can be overridden with the other field-specific merge options.

merge_args: Option<TaskMergeStrategy>

The strategy to use when merging args with an inherited task.

merge_deps: Option<TaskMergeStrategy>

The strategy to use when merging deps with an inherited task.

merge_env: Option<TaskMergeStrategy>

The strategy to use when merging env with an inherited task.

merge_inputs: Option<TaskMergeStrategy>

The strategy to use when merging inputs with an inherited task.

merge_outputs: Option<TaskMergeStrategy>

The strategy to use when merging outputs with an inherited task.

merge_toolchains: Option<TaskMergeStrategy>

The strategy to use when merging toolchains with an inherited task. @since 2.0.0

mutex: Option<String>

Creates an exclusive lock on a virtual resource, preventing other tasks using the same resource from running concurrently. @since 1.24.0

os: Option<OneOrMany<TaskOperatingSystem>>

The operating system in which to only run this task on.

output_style: Option<TaskOutputStyle>

The style in which task output will be printed to the console.

persistent: Option<bool>

Marks the task as persistent (continuously running). This is ideal for watchers, servers, or never-ending processes. @since 1.6.0

priority: Option<TaskPriority>

Marks the task with a certain priority, which determines the order in which it is ran within the action pipeline.

retry_count: Option<u8>

The number of times a failing task will be retried to succeed.

run_deps_in_parallel: Option<bool>

Runs direct task dependencies (via deps) in sequential order. This does not apply to indirect or transient dependencies.

run_in_ci: Option<TaskOptionRunInCI>

Whether to run the task in CI or not, when executing moon ci, moon check, or moon run.

run_from_workspace_root: Option<bool>

Runs the task from the workspace root, instead of the project root.

shell: Option<bool>

Runs the task within a shell. When not defined, runs the task directly while relying on native PATH resolution.

timeout: Option<u64>

The maximum time in seconds that a task can run before being cancelled.

unix_shell: Option<TaskUnixShell>

The shell to run the task in when on a Unix-based machine. @since 1.21.0

windows_shell: Option<TaskWindowsShell>

The shell to run the task in when on a Windows machine. @since 1.21.0

Trait Implementations

impl Clone for TaskOptionsConfig

fn clone(&self) -> TaskOptionsConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Config for TaskOptionsConfig

type Partial = PartialTaskOptionsConfig

fn from_partial( partial: <TaskOptionsConfig as Config>::Partial, ) -> TaskOptionsConfig

Convert a partial configuration into a full configuration, with all values populated.

fn settings() -> BTreeMap<String, ConfigSetting>

Return a map of all settings and their metadata for the configuration.

impl Debug for TaskOptionsConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for TaskOptionsConfig

fn default() -> TaskOptionsConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TaskOptionsConfig

where TaskOptionsConfig: Default,

fn deserialize<__D>( __deserializer: __D, ) -> Result<TaskOptionsConfig, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TaskOptionsConfig

fn eq(&self, other: &TaskOptionsConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Schematic for TaskOptionsConfig

fn schema_name() -> Option<String>

Define a name for this schema type. Names are required for non-primitive values as a means to link references, and avoid cycles.

fn build_schema(schema: SchemaBuilder) -> Schema

Create and return a schema that models the structure of the implementing type. The schema can be used to generate code, documentation, or other artifacts.

impl Serialize for TaskOptionsConfig

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for TaskOptionsConfig

impl StructuralPartialEq for TaskOptionsConfig