Structure

ActionContext

Shared context passed to every action during execution.

struct ActionContext

Overview

Provides access to the shell execution environment, logger, resolved configuration, App Store Connect client, and (for Android) Google Play client.

Usage

struct MyAction: Action {
    func run(with options: Options, context: ActionContext) async throws -> Result {
        let output = try await GitCLI(context: context.shell).statusPorcelain().run()
        context.logger.info("Git status: \(output.stdout)")
        return Result()
    }
}

Topics

Initializers

init(shell: ShellContext, logger: Logger, config: ResolvedConfig, appStoreConnect: AppStoreConnectClient, googlePlay: GooglePlayClient?, platform: Platform, verbose: Bool, jsonOutput: Bool)
Creates an ActionContext (macOS).

Instance Properties

let appStoreConnect: AppStoreConnectClient
App Store Connect API client (iOS, macOS only).
let config: ResolvedConfig
Merged configuration from Shipfile + env + CLI.
var configIsCI: Bool
let googlePlay: GooglePlayClient?
Google Play API client (Android). nil when Google Play credentials are not configured.
let jsonOutput: Bool
When true, the command’s result is being emitted as machine-readable JSON on stdout.
let logger: Logger
Structured logger scoped to the current operation.
let platform: Platform
Target platform for this run.
let shell: ShellContext
SwiftyShell context for executing shell commands.
let verbose: Bool
When true, raw stdout/stderr from shell commands is emitted at debug log level.

Instance Methods

func ensureProjectGenerated() async throws
Actions that require an Xcode container (.xcodeproj / .xcworkspace) call this method to ensure the project exists. If project generation is configured and the output project is missing, this runs the generation command automatically.
func gradle() -> Gradle
Creates a Gradle command family with ShipIt’s resolved project settings applied.
func linkKMPFramework(buildConfiguration: String, target: String, module: String?) async throws
Links the KMP shared framework when targeting iOS with BuildSystem.kmp.
func logShellOutput(ShellOutput, label: String)
Logs stdout and stderr from a shell command at .debug level when verbose is enabled.
func streamingGradle() -> Gradle
Returns a Gradle builder configured to stream output live for long-running builds.
func streamingXcodeBuild() -> XcodeBuild
Returns an XcodeBuild builder configured to stream output live for long-running builds.
func withConfig(ResolvedConfig) -> ActionContext
Returns a copy of this context with the given config, preserving all other fields.
func withGradleProjectDir(String) -> ActionContext
Returns a copy of this context with the Gradle project directory overridden.

Type Methods

static func mock(executor: MockExecutor, versioningSource: String, platform: Platform, jsonOutput: Bool, config: ResolvedConfig?) -> ActionContext
Creates a mock ActionContext for use in tests.

Relationships

Conforms To

Swift.Sendable
Swift.SendableMetatype