STRUCT

RunAction

Contents

• Properties
  • configuration
  • attachDebugger
  • customLLDBInitFile
  • preActions
  • postActions
  • executable
  • customWorkingDirectory
  • filePath
  • arguments
  • options
  • diagnosticsOptions
  • metalOptions
  • expandVariableFromTarget
  • launchStyle
  • appClipInvocationURLString
• Methods
  • runAction(configuration:attachDebugger:customLLDBInitFile:preActions:postActions:executable:customWorkingDirectory:filePath:arguments:options:diagnosticsOptions:metalOptions:expandVariableFromTarget:launchStyle:appClipInvocationURLString:)

public struct RunAction: Equatable, Codable, Sendable

An action that runs the built products.

It's initialized with the .runAction static method.

Properties

configuration

public var configuration: ConfigurationName

Indicates the build configuration the product should run with.

attachDebugger

public var attachDebugger: Bool

Whether a debugger should be attached to the run process or not.

customLLDBInitFile

public var customLLDBInitFile: Path?

The path of custom lldbinit file.

preActions

public var preActions: [ExecutionAction]

A list of actions that are executed before starting the run process.

postActions

public var postActions: [ExecutionAction]

A list of actions that are executed after the run process.

executable

public var executable: TargetReference?

The name of the executable or target to run.

customWorkingDirectory

public var customWorkingDirectory: Path?

Custom working directory path for the run action. When set, the executable will be launched from this directory instead of the default location.

filePath

public var filePath: Path?

Path to an executable file to run instead of the built product. This allows running arbitrary executables or scripts as part of the run action.

arguments

public var arguments: Arguments?

Command line arguments passed on launch and environment variables.

options

public var options: RunActionOptions

List of options to set to the action.

diagnosticsOptions

public var diagnosticsOptions: SchemeDiagnosticsOptions

List of diagnostics options to set to the action.

metalOptions

public var metalOptions: MetalOptions

List of metal options to set to the action

expandVariableFromTarget

public var expandVariableFromTarget: TargetReference?

A target that will be used to expand the variables defined inside Environment Variables definition (e.g. $SOURCE_ROOT)

launchStyle

public var launchStyle: LaunchStyle

The launch style of the action

appClipInvocationURLString

public var appClipInvocationURLString: String?

The URL string used to invoke the app clip, if available.

Methods

runAction(configuration:attachDebugger:customLLDBInitFile:preActions:postActions:executable:customWorkingDirectory:filePath:arguments:options:diagnosticsOptions:metalOptions:expandVariableFromTarget:launchStyle:appClipInvocationURLString:)

public static func runAction(
    configuration: ConfigurationName = .debug,
    attachDebugger: Bool = true,
    customLLDBInitFile: Path? = nil,
    preActions: [ExecutionAction] = [],
    postActions: [ExecutionAction] = [],
    executable: TargetReference? = nil,
    customWorkingDirectory: Path? = nil,
    filePath: Path? = nil,
    arguments: Arguments? = nil,
    options: RunActionOptions = .options(),
    diagnosticsOptions: SchemeDiagnosticsOptions = .options(),
    metalOptions: MetalOptions = .options(),
    expandVariableFromTarget: TargetReference? = nil,
    launchStyle: LaunchStyle = .automatically,
    appClipInvocationURLString: String? = nil
) -> RunAction

Returns a run action.

• Parameters:
  • configuration: Indicates the build configuration the product should run with.
  • attachDebugger: Whether a debugger should be attached to the run process or not.
  • preActions: A list of actions that are executed before starting the run process.
  • postActions: A list of actions that are executed after the run process.
  • executable: The name of the executable or target to run.
  • customWorkingDirectory: Custom working directory path for the run action. When set, the executable will be launched from this directory instead of the default location.
  • filePath: Path to an executable file to run instead of the built product. This allows running arbitrary executables or scripts as part of the run action.
  • arguments: Command line arguments passed on launch and environment variables.
  • options: List of options to set to the action.
  • diagnosticsOptions: List of diagnostics options to set to the action.
  • metalOptions: List of metal options to set to the action.
  • expandVariableFromTarget: A target that will be used to expand the variables defined inside Environment Variables definition (e.g. $SOURCE_ROOT). When nil, it does not expand any variables.
  • appClipInvocationURLString: The URL string used to invoke the app clip, if available.
  • launchStyle: The launch style of the action
• Returns: Run action.

Parameters

Name	Description
configuration	Indicates the build configuration the product should run with.
attachDebugger	Whether a debugger should be attached to the run process or not.
preActions	A list of actions that are executed before starting the run process.
postActions	A list of actions that are executed after the run process.
executable	The name of the executable or target to run.
customWorkingDirectory	Custom working directory path for the run action. When set, the executable will be launched from this directory instead of the default location.
filePath	Path to an executable file to run instead of the built product. This allows running arbitrary executables or scripts as part of the run action.
arguments	Command line arguments passed on launch and environment variables.
options	List of options to set to the action.
diagnosticsOptions	List of diagnostics options to set to the action.
metalOptions	List of metal options to set to the action.
expandVariableFromTarget	A target that will be used to expand the variables defined inside Environment Variables definition (e.g. $SOURCE_ROOT). When nil, it does not expand any variables.
appClipInvocationURLString	The URL string used to invoke the app clip, if available.
launchStyle	The launch style of the action