info_get_cpu_count()

def info_get_cpu_count() -> int

Get the number of CPUs available

Returns

The number of CPUs available

info_get_execution_phase()

def info_get_execution_phase() -> string

Get the execution phase

Returns

The execution phase

info_get_path_to_spaces_tools()

def info_get_path_to_spaces_tools() -> string

Get the path to the Spaces tools folder

Returns

The path to the Spaces tools folder

info_get_path_to_store()

def info_get_path_to_store() -> string

Gets the path to the spaces store

Returns

The path to the store

info_get_platform_name()

def info_get_platform_name() -> string

Get the platform name

Returns

The platform name

info_get_supported_platforms()

def info_get_supported_platforms() -> list

Get the supported platforms

Returns

The supported platforms

info_is_ci()

def info_is_ci() -> bool

Check if the workflow is running in a CI environment.

Returns

True if --ci is passed when running spaces, False otherwise

info_is_execution_phase_checkout()

def info_is_execution_phase_checkout() -> bool

Check if the execution phase is checkout

Returns

True if the execution phase is checkout, False otherwise

info_is_execution_phase_inspect()

def info_is_execution_phase_inspect() -> bool

Check if the execution phase is inspect

Returns

True if the execution phase is inspect, False otherwise

info_is_execution_phase_run()

def info_is_execution_phase_run() -> bool

Check if the execution phase is run

Returns

True if the execution phase is run, False otherwise

info_is_platform_aarch64()

def info_is_platform_aarch64() -> bool

Check if the platform is aarch64

Returns

True if the platform is aarch64, False otherwise

info_is_platform_linux()

def info_is_platform_linux() -> bool

Check if the platform is Linux

Returns

True if the platform is Linux, False otherwise

info_is_platform_macos()

def info_is_platform_macos() -> bool

Check if the platform is macOS

Returns

True if the platform is macOS, False otherwise

info_is_platform_windows()

def info_is_platform_windows() -> bool

Check if the platform is Windows

Returns

True if the platform is Windows, False otherwise

info_is_platform_x86_64()

def info_is_platform_x86_64() -> bool

Check if the platform is x86_64

Returns

True if the platform is x86_64, False otherwise

info_parse_log_file()

def info_parse_log_file(path) -> dict

Parses a log file

Args

  • path: string: path to the log file

Returns

dict with members header and lines

info_set_max_queue_count()

def info_set_max_queue_count(max_queue_count)

Set the maximum number of jobs that can be queued.

Args

  • max_queue_count: int: The maximum number of jobs that can be queued

info_set_minimum_version()

def info_set_minimum_version(version)

Set the minimum version of Spaces required to run the workflow

Args

  • version: string: The minimum version of Spaces required to run the workflow

info_set_required_semver()

def info_set_required_semver(required)

Set the required spaces semver for the workflow

Args

  • required: string: The required semver for the workflow