Structure

Environment

Reads ShipItSwifty configuration from environment variables.

struct Environment

Overview

Supports both SHIPIT_* prefixed variables (mapping Shipfile YAML keys) and bare secret names for CI compatibility (e.g. ASC_KEY_ID, VAULT_PASSWORD).

Naming Convention

Shipfile YAML keys map to env vars by upper-casing and joining path segments with _, prefixed with SHIPIT_. Nested keys use __ (double-underscore) as section separator.

Shipfile key	Environment variable
`app.scheme`	`SHIPIT_APP__SCHEME`
`app.bundle_id`	`SHIPIT_APP__BUNDLE_ID`
`app_store_connect.key_id`	`SHIPIT_APP_STORE_CONNECT__KEY_ID`
`android.module`	`SHIPIT_ANDROID__MODULE`

Bare Secrets

The following are also read without the SHIPIT_ prefix for CI compatibility:

ASC_KEY_ID
ASC_ISSUER_ID
ASC_PRIVATE_KEY
VAULT_PASSWORD
P12_BASE64
P12_PASSWORD
PROVISIONING_PROFILE_BASE64
GOOGLE_PLAY_SERVICE_ACCOUNT_JSON
GOOGLE_PLAY_SERVICE_ACCOUNT_JSON_PATH
SHIPIT_ANDROID__KEYSTORE_PASSWORD
SHIPIT_ANDROID__KEY_PASSWORD

Topics

Initializers

init(env: [String : String])
Creates an Environment reader from the given dictionary. Defaults to the current process environment.

Instance Properties

var androidBuildSystem: String?
SHIPIT_ANDROID__BUILD_SYSTEM — overrides Android build system detection. Accepts native, flutter, react_native, or kmp.
var androidBuildType: String?
SHIPIT_ANDROID__BUILD_TYPE — Output type: apk or aab
var androidBuildVariant: String?
SHIPIT_ANDROID__BUILD_VARIANT — Gradle build variant (e.g. release)
var androidCLIEnabled: Bool?
SHIPIT_ANDROID__CLI__ENABLED — opt in to AndroidCLI-backed behavior.
var androidCLIExecutablePath: String?
SHIPIT_ANDROID__CLI__EXECUTABLE_PATH — AndroidCLI executable name or path.
var androidCLISDKPath: String?
SHIPIT_ANDROID__CLI__SDK_PATH — Android SDK override passed to AndroidCLI.
var androidGradleProjectDir: String?
SHIPIT_ANDROID__GRADLE_PROJECT_DIR — Directory containing the Gradle root project.
var androidGradlewPath: String?
SHIPIT_ANDROID__GRADLEW_PATH — Path to the gradlew wrapper script
var androidKeyAlias: String?
SHIPIT_ANDROID__KEY_ALIAS — Signing key alias within the keystore
var androidKeyPassword: String?
SHIPIT_ANDROID__KEY_PASSWORD — Key password (secret)
var androidKeystorePassword: String?
SHIPIT_ANDROID__KEYSTORE_PASSWORD — Keystore password (secret)
var androidKeystorePath: String?
SHIPIT_ANDROID__KEYSTORE_PATH — Path to the Android keystore file
var androidModule: String?
SHIPIT_ANDROID__MODULE — Gradle module name (e.g. app)
var androidPackageName: String?
SHIPIT_ANDROID__PACKAGE_NAME — Android application package name (e.g. com.example.app)
var appBundleId: String?
SHIPIT_APP__BUNDLE_ID
var appProject: String?
SHIPIT_APP__PROJECT
var appScheme: String?
SHIPIT_APP__SCHEME
var appTeamId: String?
SHIPIT_APP__TEAM_ID
var appWorkspace: String?
SHIPIT_APP__WORKSPACE
var archiveExportMethod: String?
SHIPIT_ARCHIVE__EXPORT_METHOD
var archiveOutputPath: String?
SHIPIT_ARCHIVE__OUTPUT_PATH
var ascIssuerId: String?
SHIPIT_APP_STORE_CONNECT__ISSUER_ID or bare ASC_ISSUER_ID
var ascKeyId: String?
SHIPIT_APP_STORE_CONNECT__KEY_ID or bare ASC_KEY_ID
var ascKeyPath: String?
SHIPIT_APP_STORE_CONNECT__KEY_PATH or bare ASC_PRIVATE_KEY_PATH
var ascPrivateKey: String?
ASC_PRIVATE_KEY — raw P8 key contents (base64 or PEM)
var buildConfiguration: String?
SHIPIT_BUILD__CONFIGURATION
var buildDerivedDataPath: String?
SHIPIT_BUILD__DERIVED_DATA_PATH
var codeSigningGitUrl: String?
SHIPIT_CODE_SIGNING__GIT_URL
var codeSigningP12Base64: String?
SHIPIT_CODE_SIGNING__P12_BASE64 or bare P12_BASE64
var codeSigningP12Password: String?
SHIPIT_CODE_SIGNING__P12_PASSWORD or bare P12_PASSWORD
var codeSigningP12Path: String?
SHIPIT_CODE_SIGNING__P12_PATH
var codeSigningProvisioningProfileBase64: String?
SHIPIT_CODE_SIGNING__PROVISIONING_PROFILE_BASE64 or bare PROVISIONING_PROFILE_BASE64
var codeSigningProvisioningProfilePath: String?
SHIPIT_CODE_SIGNING__PROVISIONING_PROFILE_PATH
var googlePlayServiceAccountJson: String?
GOOGLE_PLAY_SERVICE_ACCOUNT_JSON — raw service account JSON contents (secret)
var googlePlayServiceAccountJsonPath: String?
GOOGLE_PLAY_SERVICE_ACCOUNT_JSON_PATH — path to service account JSON file
var iosBuildSystem: String?
SHIPIT_IOS__BUILD_SYSTEM — overrides iOS build system detection. Accepts native, flutter, react_native, or kmp.
var iosKMPArchiveTarget: String?
SHIPIT_IOS__KMP_ARCHIVE_TARGET — KMP iOS target for archives.
var iosKMPBuildTarget: String?
SHIPIT_IOS__KMP_BUILD_TARGET — KMP iOS target for local builds.
var iosKMPSharedModule: String?
SHIPIT_IOS__KMP_SHARED_MODULE — Gradle module containing shared KMP framework tasks.
var iosKMPTestTask: String?
SHIPIT_IOS__KMP_TEST_TASK — KMP iOS test Gradle task.
var platform: String?
SHIPIT_PLATFORM — overrides platform auto-detection. Accepts ios or android.
var slackWebhookUrl: String?
SLACK_WEBHOOK_URL
var vaultPassword: String?
VAULT_PASSWORD — passphrase for the encrypted certificate repository

Instance Methods

func value(for: String) -> String?
Returns the raw value for the given environment variable key.

Relationships

Conforms To

Swift.Sendable
Swift.SendableMetatype