Structure

ResolvedConfig

Flat struct containing all resolved configuration values after merging CLI flags, environment variables, Shipfile.yml, and built-in defaults.

struct ResolvedConfig

Overview

ResolvedConfig is created by ConfigResolver and passed to actions via ActionContext. Actions read from this struct rather than parsing raw config sources themselves.

Priority

CLI flags (highest)
Shipfile.yml values
Environment variables (SHIPIT_*)
Built-in defaults (lowest)

Topics

Initializers

init(processedFiles: [String], appWorkspace: String?, appProject: String?, appScheme: String?, bundleID: String?, bundleIDFromTargetBuildSettings: Bool, teamID: String?, teamIDFromTargetBuildSettings: Bool, ascKeyID: String?, ascIssuerID: String?, ascPrivateKeyData: Data?, buildConfiguration: String, derivedDataPath: String?, xcargs: [String : String], archiveExportMethod: String, archiveIncludeSymbols: Bool, archiveOutputPath: String?, exportArchivePath: String?, exportOutputDirectory: String?, codeSigningType: String, automaticCodeSigning: Bool?, codeSigningStorage: String, codeSigningGitUrl: String?, vaultPassword: String?, codeSigningP12Path: String?, codeSigningP12Data: Data?, codeSigningP12Password: String?, codeSigningProvisioningProfilePath: String?, codeSigningProvisioningProfileData: Data?, skipWaitingForBuildProcessing: Bool, distributeExternal: Bool, testFlightGroups: [String], testFlightChangelog: String?, screenshotDevices: [String], screenshotLocales: [String], screenshotScheme: String?, screenshotOutputDirectory: String, metadataDirectory: String, submitForReview: Bool, automaticRelease: Bool, phasedRelease: Bool, versioningStrategy: String, versioningSource: String, versioningSpecPath: String?, versioningBuildKey: String, versioningMarketingKey: String, projectGenerationTool: String?, projectGenerationCommand: String?, projectGenerationSpecPath: String?, projectGenerationOutputProject: String?, projectGenerationAutoGenerate: Bool, slackWebhookUrl: String?, slackChannel: String?, workflows: [String : WorkflowConfig], customActions: [String : CustomActionConfig], platform: Platform, iosBuildSystem: BuildSystem, androidBuildSystem: BuildSystem, ci: Bool, projectRoot: String, kmpSharedModule: String, kmpBuildTarget: String, kmpArchiveTarget: String, kmpTestTask: String, androidCLI: AndroidCLIConfig, androidModule: String, androidScope: GradleTaskScope, androidTestKind: TestKind, androidTestDevices: TestDeviceConfig, androidBuildVariant: String, androidBuildType: AndroidBuildType, gradlewPath: String?, gradleProjectDir: String?, androidGradleFlags: [String], androidKeystorePath: String?, androidKeystorePassword: String?, androidKeyAlias: String?, androidKeyPassword: String?, androidPackageName: String?, androidRolloutFraction: Double?, androidGradleProperties: [String : String], googlePlayServiceAccountData: Data?)
Creates a ResolvedConfig with all configuration values.

Instance Properties

let androidBuildSystem: BuildSystem
Resolved Android build system. BuildSystem.native for pure Gradle projects; .flutter, .reactNative, or .kmp when the Android app is produced by a cross-platform tool.
let androidBuildType: AndroidBuildType
Default Android artifact type.
let androidBuildVariant: String
Default Android build variant (e.g. release, debug).
let androidCLI: AndroidCLIConfig
Resolved AndroidCLI integration settings.
let androidGradleFlags: [String]
Additional Gradle flags applied to Android Gradle invocations.
let androidGradleProperties: [String : String]
Additional Gradle -P project properties.
let androidKeyAlias: String?
Signing key alias within the keystore.
let androidKeyPassword: String?
Key password (from environment — never stored in Shipfile).
let androidKeystorePassword: String?
Keystore password (from environment — never stored in Shipfile).
let androidKeystorePath: String?
Path to the Android keystore file.
let androidModule: String
Gradle module name (e.g. app).
let androidPackageName: String?
Android application package name (e.g. com.example.myapp).
let androidRolloutFraction: Double?
Staged rollout fraction (0.0–1.0). nil means full rollout.
let androidScope: GradleTaskScope
Default Android Gradle test scope.
let androidTestDevices: TestDeviceConfig
Default Android test device configuration.
let androidTestKind: TestKind
Default Android test kind.
let appProject: String?
Path to the Xcode project. Used when appWorkspace is nil.
let appScheme: String?
The Xcode scheme for building and testing.
let appWorkspace: String?
Path to the Xcode workspace.
let archiveExportMethod: String
Export method for IPA generation.
let archiveIncludeSymbols: Bool
Whether to include debug symbols.
let archiveOutputPath: String?
Output path for the .xcarchive.
let ascIssuerID: String?
App Store Connect Issuer ID.
let ascKeyID: String?
App Store Connect API Key ID.
let ascPrivateKeyData: Data?
Raw contents of the .p8 private key.
let automaticCodeSigning: Bool
Whether Xcode automatic signing should be used.
let automaticRelease: Bool
Whether to release automatically after approval.
let buildConfiguration: String
Build configuration name (e.g. Release, Debug).
let bundleID: String?
The app bundle identifier.
let bundleIDFromTargetBuildSettings: Bool
Whether the bundle identifier was inferred from Xcode target build settings.
let ci: Bool
Whether the current run is in CI mode.
let codeSigningGitUrl: String?
Git URL of the encrypted certificate repository.
let codeSigningP12Data: Data?
Decoded .p12 certificate content for manual signing when provided via base64.
let codeSigningP12Password: String?
Password for the resolved .p12 certificate.
let codeSigningP12Path: String?
Path to the resolved .p12 certificate for manual signing.
let codeSigningProvisioningProfileData: Data?
Decoded .mobileprovision content for manual signing when provided via base64.
let codeSigningProvisioningProfilePath: String?
Path to the resolved .mobileprovision file for manual signing.
let codeSigningStorage: String
Certificate storage backend (git, s3, or gcs).
let codeSigningType: String
Code signing type (vault or manual).
let customActions: [String : CustomActionConfig]
User-defined composite actions from the Shipfile.
let derivedDataPath: String?
Path to the derived data directory.
let distributeExternal: Bool
Whether to distribute to external testers.
let exportArchivePath: String?
Input archive path for the export step.
let exportOutputDirectory: String?
Output directory for the exported IPA.
let googlePlayServiceAccountData: Data?
Raw service account JSON data for Google Play authentication.
let gradleProjectDir: String
Directory containing the Gradle root project.
let gradlewPath: String?
Explicit path to the gradlew wrapper script.
let iosBuildSystem: BuildSystem
Resolved iOS build system. BuildSystem.native for Swift-only Xcode projects; .flutter, .reactNative, or .kmp when the iOS app is produced by a cross-platform tool.
let kmpArchiveTarget: String
KMP iOS framework target used for archives.
let kmpBuildTarget: String
KMP iOS framework target used for local builds.
let kmpSharedModule: String
KMP Gradle module containing shared iOS framework tasks.
let kmpTestTask: String
KMP iOS test Gradle task.
let metadataDirectory: String
Local directory containing metadata files.
let phasedRelease: Bool
Whether to use phased release.
let platform: Platform
Resolved target platform.
let processedFiles: [String]
Files that were successfully read while resolving this configuration.
let projectGenerationAutoGenerate: Bool
Whether to auto-generate the project when the output is missing.
let projectGenerationCommand: String?
Shell command to run for project generation.
let projectGenerationOutputProject: String?
Path to the generated output project (e.g. MyApp.xcodeproj).
let projectGenerationSpecPath: String?
Path to the project spec file (e.g. project.yml).
let projectGenerationTool: String?
Project generation tool name (e.g. xcodegen, tuist).
let projectRoot: String
Directory used for project-relative tool execution. Defaults to the Shipfile directory.
let screenshotDevices: [String]
Simulator device names for screenshot capture.
let screenshotLocales: [String]
Locale identifiers for screenshot capture.
let screenshotOutputDirectory: String
Output directory for organized screenshots.
let screenshotScheme: String?
Xcode scheme for screenshot UI tests.
let skipWaitingForBuildProcessing: Bool
Whether to skip waiting for build processing.
let slackChannel: String?
Default Slack channel for notifications.
let slackWebhookUrl: String?
Slack webhook URL for notifications.
let submitForReview: Bool
Whether to submit for review after metadata push.
let teamID: String?
The Apple Developer Team ID.
let teamIDFromTargetBuildSettings: Bool
Whether the team ID was inferred from Xcode target build settings.
let testFlightChangelog: String?
Release notes for the TestFlight build.
let testFlightGroups: [String]
Beta group names for TestFlight distribution.
let vaultPassword: String?
Passphrase for the encrypted certificate repository.
let versioningBuildKey: String
YAML key for the build number in the project spec (default: CURRENT_PROJECT_VERSION).
let versioningMarketingKey: String
YAML key for the marketing version in the project spec (default: MARKETING_VERSION).
let versioningSource: String
Source of version information.
let versioningSpecPath: String?
Path to the project spec file for project_spec versioning source.
let versioningStrategy: String
Build number increment strategy.
let workflows: [String : WorkflowConfig]
Named release workflows from the Shipfile.
let xcargs: [String : String]
Additional xcargs for xcodebuild.

Instance Methods

func overriding(buildVariant: String?, flavor: String?, app: AppConfig?, build: BuildConfig?, archive: ArchiveConfig?, export: ExportConfig?, codeSigning: CodeSigningConfig?) -> ResolvedConfig
Returns a copy of this configuration with workflow-level overrides applied.
func overriding(gradleProjectDir: String) -> ResolvedConfig
Returns a copy of this config with the specified Android build variant and/or flavor overridden.

Relationships

Conforms To

Swift.Sendable
Swift.SendableMetatype