Skip to main content

Appcircle-Specific (Reserved) Environment Variables

Here is a list of pre-defined environment variables in Appcircle.

These reserved environment variables are either predetermined by Appcircle or they are set in the build configuration.

You can check how these environment variables are utilized within the related workflow step. For instance, you can set the Xcode version of a build profile through the build configuration, which will then set this value as the AC_XCODE_VERSION environment variable.

You can then use this variable in any workflow step and this variable will be assigned as the default input value of the Xcode Select workflow step. This assignment is editable, meaning that you can either choose to keep it in the same way it is configured or you can change it by specifying a value directly in the step settings or assigning a different environment variable.

For more information on the inputs of the steps and how the variables in the following steps are used, please refer to the documentation of the specific step that is available at https://github.com/appcircleio

iOS & Android common environment variables

VariableDescription
AC_OUTPUT_DIROutput folder path to upload artifacts
AC_TEMP_DIRPath to temp directory
AC_ENV_FILE_PATHPath to the environment file
AC_REPOSITORY_DIRClone repository destination
AC_PROJECT_PATHProject path (For Android, gradlew file path. For iOS, .xcodeproj or .xcworkspace file path)
AC_APPCIRCLESet to true when Appcircle starts a build
AC_METADATA_OUTPUT_PATHMetadata output file path
AC_GIT_URLGit URL of the repository
AC_GIT_COMMITThe Git commit that is built
AC_COMMIT_MESSAGECommit message
AC_COMMIT_TAGSCommit tags
AC_BUILD_NUMBERBuild number (Fetch Details is counted as Build)
AC_BUILD_TIMESTAMPBuild time stamp
AC_GIT_BRANCHThe Git branch that is built (eg: master)
AC_GIT_TARGET_COMMITTarget commit for a Pull or Merge Request
AC_GIT_TARGET_BRANCHTarget branch for a Pull or Merge Request
AC_GIT_PRSet to true if the workflow started for a Pull or Merge Request
AC_PULL_NUMBERPull or Merge Request Number
AC_IS_SUCCESSSet to true if the previous step was successful
AC_WORKFLOW_IDWorkflow UUID
AC_WORKFLOW_NAMEWorkflow Name
AC_PLATFORM_TYPEPlatform Type ObjectiveCSwift, JavaKotlin, Smartface, ReactNative, Flutter
AC_PURPOSEPurpose of the Workflow
Metadata = 0
Build = 1
StoreSubmit = 2
Merge = 3
TagBuild = 4

Android specific environment variables

VariableDescription
ANDROID_HOMEAndroid SDK installation directory
AC_MODULESelected Android module
AC_VARIANTSSelected Android variant
AC_OUTPUT_TYPESelected output type of Android artifact
AC_APK_PATHGenerated APK file path
AC_AAB_PATHGenerated AAB file path
AC_SIGNED_APK_PATHGenerated signed APK file path
AC_SIGNED_AAB_PATHGenerated signed AAB file path
AC_ANDROID_KEYSTORE_PATHSelected Android keystore path
AC_ANDROID_KEYSTORE_PASSWORDPassword for the selected keystore
AC_ANDROID_ALIASSelected alias name
AC_ANDROID_ALIAS_PASSWORDSelected alias password
AC_V2_SIGNSpecifies if signing will use V2
AC_ANDROID_APP_ANALYSIS_PATHLocation of the app analyzer JSON file
JAVA_HOME_8_X64OpenJDK 8 Location
JAVA_HOME_11_X64OpenJDK 11 Location

iOS specific environment variables

VariableDescription
AC_XCODE_LIST_DIRSpecifies the Xcode folder list path
AC_SCHEMESpecifies the project scheme for build
AC_ARCHIVE_FLAGSSpecifies the extra Xcodebuild flag. For example : -configuration DEBUG
AC_XCODE_VERSIONSpecifies the Xcode version
AC_ARCHIVE_PATHArchive path
AC_ARCHIVE_METADATA_PATHArchive metadata path
AC_SIMULATOR_ARCHIVE_PATHSimulator archive path description
AC_METADATA_OUTPUT_PATHMetadata output file description
AC_CERTIFICATESURLs of the certificates
AC_PROVISIONING_PROFILESURLs of the provisioning profiles
AC_EXPORT_DIRSpecifies the path that contains ipa, exportOptions.plistand other exported files
AC_BUNDLE_IDENTIFIERSSpecifies the project bundle identifiers

Smartface specific environment variables

VariableDescription
AC_SMARTFACE_PLAYER_VERSIONSmartface player version
AC_SMARTFACE_CLI_VERSIONSmartface CLI version