Paresed 11 March 2021 from code at https://github.com/fastlane/fastlane
Name | Type | Description | Default | Remarks |
---|---|---|---|---|
abc | An invalid test feature | "nothing" | ||
ANDROID_GCM_SENDER_ID | GCM SENDER ID | |||
ANDROID_TOKEN | ANDROID GCM KEY | |||
APNS_ENV | APNS environment | 'production') | ||
APNS_P12 | APNS P12 File (in .p12 format) | |||
APNS_P12_PASSWORD | APNS P12 password | |||
APP_STORE_CONNECT_API_KEY | Hash | Your App Store Connect API Key information (https://docs.fastlane.tools/app-store-connect-api/#use-return-value-and-pass-in-as-an-option) | Identical to SIGH_API_KEY | |
APP_STORE_CONNECT_API_KEY_DURATION | The token session duration | Spaceship::ConnectAPI::Token::MAX_TOKEN_DURATION | ||
APP_STORE_CONNECT_API_KEY_IN_HOUSE | Is App Store or Enterprise (in house) team? App Store Connect API cannot determine this on its own (yet) | |||
APP_STORE_CONNECT_API_KEY_IS_KEY_CONTENT_BASE64 | Boolean | Whether :key_content is Base64 encoded or not | false) | |
APP_STORE_CONNECT_API_KEY_ISSUER_ID | The issuer ID | |||
APP_STORE_CONNECT_API_KEY_KEY | The content of the key p8 file | |||
APP_STORE_CONNECT_API_KEY_KEY_FILEPATH | The path to the key p8 file | |||
APP_STORE_CONNECT_API_KEY_KEY_ID | The key ID | |||
APP_STORE_CONNECT_API_KEY_PATH | Path to your App Store Connect API Key JSON file (https://docs.fastlane.tools/app-store-connect-api/#using-fastlane-api-key-json-file) | Identical to SIGH_API_KEY_PATH | ||
APPETIZE_API_HOST | Appetize API host | 'api.appetize.io' | ||
APPETIZE_API_TOKEN | Integer | The number of seconds to wait until automatically ending the session due to user inactivity. Must be 30, 60, 90, 120, 180, 300, 600, 1800, 3600 or 7200. Default is 120 | ||
APPETIZE_FILE_PATH | Path to zipped build on the local filesystem. Either this or url must be specified |
|||
APPETIZE_NOTE | Notes you wish to add to the uploaded app | |||
APPETIZE_PLATFORM | Platform. Either ios or android |
'ios') | ||
APPETIZE_PUBLICKEY | Public key of the app you wish to update | Actions.lane_context[SharedValues::APPETIZE_PUBLIC_KEY] | ||
APPETIZE_TIMEOUT | Integer | The number of seconds to wait until automatically ending the session due to user inactivity. Must be 30, 60, 90, 120, 180, 300, 600, 1800, 3600 or 7200. Default is 120 | ||
APPETIZE_URL | URL from which the ipa file can be fetched. Alternative to :path | |||
APPETIZE_VIEWING_URL_GENERATOR_BASE | Base URL of Appetize service | "https://appetize.io/embed" | ||
APPETIZE_VIEWING_URL_GENERATOR_COLOR | Color of the device | "black" | ||
APPETIZE_VIEWING_URL_GENERATOR_DEVICE | iphone4s | Device type: iphone4s, iphone5s, iphone6, iphone6plus, ipadair, iphone6s, iphone6splus, ipadair2, nexus5, nexus7 or nexus9 | "iphone5s") | |
APPETIZE_VIEWING_URL_GENERATOR_LANGUAGE | Device language in ISO 639-1 language code, e.g. 'de' | |||
APPETIZE_VIEWING_URL_GENERATOR_LAUNCH_URL | Specify a deep link to open when your app is launched | |||
APPETIZE_VIEWING_URL_GENERATOR_ORIENTATION | Device orientation | "portrait" | ||
APPETIZE_VIEWING_URL_GENERATOR_OS_VERSION | The operating system version on which to run your app, e.g. 10.3, 8.0 | |||
APPETIZE_VIEWING_URL_GENERATOR_PARAMS | Specify params value to be passed to Appetize | |||
APPETIZE_VIEWING_URL_GENERATOR_PROXY | Hash | Specify a HTTP proxy to be passed to Appetize | 4723 | |
APPETIZE_VIEWING_URL_GENERATOR_SCALE | Scale of the simulator | |||
APPSTORE_BUILD_NUMBER_API_KEY | Hash | Your App Store Connect API Key information (https://docs.fastlane.tools/app-store-connect-api/#use-return-value-and-pass-in-as-an-option) | Identical to APP_STORE_CONNECT_API_KEY | |
APPSTORE_BUILD_NUMBER_API_KEY_PATH | Path to your App Store Connect API Key JSON file (https://docs.fastlane.tools/app-store-connect-api/#using-fastlane-api-key-json-file) | Identical to APP_STORE_CONNECT_API_KEY_PATH | ||
APPSTORE_BUILD_NUMBER_LIVE | Query the live version (ready-for-sale) | true) | ||
APPSTORE_BUILD_NUMBER_LIVE_TEAM_ID | The ID of your App Store Connect team if you're in multiple teams | CredentialsManager::AppfileConfig.try_fetch_value(:itc_team_id) | ||
APPSTORE_PLATFORM | The platform to use (optional) | "ios" | ||
asdf | Array | bar | ['5', '4', '3', '2' | |
CERT_API_KEY | Hash | Your App Store Connect API Key information (https://docs.fastlane.tools/app-store-connect-api/#use-return-value-and-pass-in-as-an-option) | Identical to DELIVER_API_KEY, APP_STORE_CONNECT_API_KEY | |
CERT_API_KEY_PATH | Path to your App Store Connect API Key JSON file (https://docs.fastlane.tools/app-store-connect-api/#using-fastlane-api-key-json-file) | Identical to DELIVER_API_KEY_PATH, APP_STORE_CONNECT_API_KEY_PATH | ||
CERT_DEVELOPMENT | Boolean | Create a development certificate instead of a distribution one | false) | |
CERT_FILE_NAME | The filename of certificate to store | |||
CERT_FORCE | Boolean | Create a certificate even if an existing certificate exists | false) | |
CERT_GENERATE_APPLE_CERTS | Boolean | Create a certificate type for Xcode 11 and later (Apple Development or Apple Distribution) | FastlaneCore::Helper.mac? && FastlaneCore::Helper.xcode_at_least?('11') | |
CERT_KEYCHAIN_PASSWORD | This might be required the first time you access certificates on a new mac. For the login/default keychain this is your macOS account password | |||
CERT_KEYCHAIN_PATH | Path to a custom keychain | Dir["#{Dir.home}/Library/Keychains/login.keychain", "#{Dir.home}/Library/Keychains/login.keychain-db"].last | ||
CERT_OUTPUT_PATH | The path to a directory in which all certificates and private keys should be stored | ".") | ||
CERT_PLATFORM | nil | Set the provisioning profile's platform (ios, macos, tvos) | "ios" | |
CERT_SKIP_SET_PARTITION_LIST | Boolean | Skips setting the partition list (which can sometimes take a long time). Setting the partition list is usually needed to prevent Xcode from prompting to allow a cert to be used for signing | false) | |
CERT_TEAM_ID | The ID of your Developer Portal team if you're in multiple teams | CredentialsManager::AppfileConfig.try_fetch_value(:team_id) | ||
CERT_TEAM_NAME | The name of your Developer Portal team if you're in multiple teams | CredentialsManager::AppfileConfig.try_fetch_value(:team_name) | ||
CERT_TYPE | Create specific certificate type (takes precedence over :development) | |||
CERT_USERNAME | Your Apple ID Username | user | ||
CHATWORK_API_TOKEN | ChatWork API Token | |||
CODE_SIGNING_IDENTITY | Code signing identity | |||
CRASHLYTICS_API_TOKEN | Crashlytics API Key | |||
CRASHLYTICS_APK_PATH | Path to your APK file | Actions.lane_context[SharedValues::GRADLE_APK_OUTPUT_PATH] | ||
CRASHLYTICS_APP_ID | Firebase Crashlytics APP ID | |||
CRASHLYTICS_BUILD_SECRET | Crashlytics Build Secret | |||
CRASHLYTICS_DEBUG | Crashlytics debug option (true/false) | false | ||
CRASHLYTICS_EMAILS | Pass email addresses of testers, separated by commas | |||
CRASHLYTICS_FRAMEWORK_PATH | Path to the submit binary in the Crashlytics bundle (iOS) or crashlytics-devtools.jar file (Android) |
|||
CRASHLYTICS_GROUPS | The groups used for distribution, separated by commas | |||
CRASHLYTICS_IPA_PATH | Path to your IPA file. Optional if you use the gym or xcodebuild action | Actions.lane_context[SharedValues::IPA_OUTPUT_PATH] | ||
CRASHLYTICS_NOTES | The release notes as string - uses :notes_path under the hood | |||
CRASHLYTICS_NOTES_PATH | Path to the release notes | |||
CRASHLYTICS_NOTIFICATIONS | Crashlytics notification option (true/false) | true | ||
CURRENT_BUILD_NUMBER_LIVE | Query the live version (ready-for-sale) | false) | ||
DELIVER_API_KEY | Hash | Your App Store Connect API Key information (https://docs.fastlane.tools/app-store-connect-api/#use-return-value-and-pass-in-as-an-option) | Identical to APP_STORE_CONNECT_API_KEY | |
DELIVER_API_KEY_PATH | Path to your App Store Connect API Key JSON file (https://docs.fastlane.tools/app-store-connect-api/#using-fastlane-api-key-json-file) | Identical to APP_STORE_CONNECT_API_KEY_PATH | ||
DELIVER_APP_ICON_PATH | Metadata: The path to the app icon | |||
DELIVER_APP_ID | The more tests a plugin has, the better | |||
DELIVER_APP_IDENTIFIER | The bundle identifier of your app | CredentialsManager::AppfileConfig.try_fetch_value(:app_identifier) | ||
DELIVER_APP_RATING_CONFIG_PATH | Hash | Extra information for the submission (e.g. compliance specifications, IDFA settings) | ||
DELIVER_APP_REVIEW_ATTACHMENT_FILE | Hash | Metadata: Localised marketing url | ||
DELIVER_APP_VERSION | The version that should be edited or created | |||
DELIVER_APPLE_WATCH_APP_ICON_PATH | Metadata: The path to the Apple Watch app icon | |||
DELIVER_AUTO_RELEASE_DATE | Integer | Date in milliseconds for automatically releasing on pending approval (Can not be used together with automatic_release ) |
||
DELIVER_AUTOMATIC_RELEASE | Boolean | Should the app be automatically released once it's approved? (Can not be used together with auto_release_date ) |
||
DELIVER_BUILD_NUMBER | If set the given build number (already uploaded to iTC) will be used instead of the current built one | |||
DELIVER_COPYRIGHT | Metadata: The copyright notice | |||
DELIVER_DEV_PORTAL_TEAM_ID | The short ID of your Developer Portal team, if you're in multiple teams. Different from your iTC team ID! | CredentialsManager::AppfileConfig.try_fetch_value(:team_id) | ||
DELIVER_DEV_PORTAL_TEAM_NAME | The name of your Developer Portal team if you're in multiple teams | CredentialsManager::AppfileConfig.try_fetch_value(:team_name) | ||
DELIVER_EDIT_LIVE | Modify live metadata, this option disables ipa upload and screenshot upload | |||
DELIVER_FORCE | Skip verification of HTML preview file | false) | ||
DELIVER_IGNORE_LANGUAGE_DIRECTORY_VALIDATION | Ignore errors when invalid languages are found in metadata and screenshot directories | false | ||
DELIVER_INDIVUDAL_METADATA_ITEMS | Array | An array of localized metadata items to upload individually by language so that errors can be identified. E.g. ['name', 'keywords', 'description']. Note: slow | ||
DELIVER_IPA_PATH | Path to your ipa file | Dir["*.ipa"].sort_by { | x | |
DELIVER_ITC_PROVIDER | The provider short name to be used with the iTMSTransporter to identify your team. This value will override the automatically detected provider short name. To get provider short name run pathToXcode.app/Contents/Applications/Application\\ Loader.app/Contents/itms/bin/iTMSTransporter -m provider -u 'USERNAME' -p 'PASSWORD' -account_type itunes_connect -v off . The short names of providers should be listed in the second column |
CredentialsManager::AppfileConfig.try_fetch_value(:itc_provider) | ||
DELIVER_LANGUAGES | Array | Metadata: List of languages to activate | ||
DELIVER_METADATA_PATH | Path to the folder containing the metadata files | |||
DELIVER_OVERWRITE_SCREENSHOTS | Clear all previously uploaded screenshots before uploading the new ones | false) | ||
DELIVER_PHASED_RELEASE | Enable the phased release feature of iTC | false) | ||
DELIVER_PKG_PATH | Path to your pkg file | Dir["*.pkg"].sort_by { | x | |
DELIVER_PLATFORM | The platform to use (optional) | false | ||
DELIVER_PRECHECK_DEFAULT_RULE_LEVEL | The default precheck rule level unless otherwise configured | :warn) | ||
DELIVER_PRICE_TIER | The price tier of this application | |||
DELIVER_PRIMARY_CATEGORY | Metadata: The english name of the primary category (e.g. Business , Books ) |
|||
DELIVER_PRIMARY_FIRST_SUB_CATEGORY | Metadata: The english name of the primary first sub category (e.g. Educational , Puzzle ) |
|||
DELIVER_PRIMARY_SECOND_SUB_CATEGORY | Metadata: The english name of the primary second sub category (e.g. Educational , Puzzle ) |
|||
DELIVER_REJECT_IF_POSSIBLE | Rejects the previously submitted build if it's in a state where it's possible | false) | ||
DELIVER_RESET_RATINGS | Reset the summary rating when you release a new version of the application | false) | ||
DELIVER_RUN_PRECHECK_BEFORE_SUBMIT | Run precheck before submitting to app review | true) | ||
DELIVER_SCREENSHOTS_PATH | Path to the folder containing the screenshots | |||
DELIVER_SECONDARY_CATEGORY | Metadata: The english name of the secondary category (e.g. Business , Books ) |
|||
DELIVER_SECONDARY_FIRST_SUB_CATEGORY | Metadata: The english name of the secondary first sub category (e.g. Educational , Puzzle ) |
|||
DELIVER_SECONDARY_SECOND_SUB_CATEGORY | Metadata: A hash containing the review information | |||
DELIVER_SKIP_APP_VERSION_UPDATE | Don’t create or update the app version that is being prepared for submission | false) | ||
DELIVER_SKIP_BINARY_UPLOAD | Skip uploading an ipa or pkg to App Store Connect | false) | ||
DELIVER_SKIP_METADATA | Don't upload the metadata (e.g. title, description). This will still upload screenshots | false) | ||
DELIVER_SKIP_SCREENSHOTS | Don't upload the screenshots | false) | ||
DELIVER_SUBMIT_FOR_REVIEW | Submit the new version for Review after uploading everything | false) | ||
DELIVER_TEAM_ID | The ID of your App Store Connect team if you're in multiple teams | CredentialsManager::AppfileConfig.try_fetch_value(:itc_team_id) | ||
DELIVER_TEAM_NAME | The name of your App Store Connect team if you're in multiple teams | CredentialsManager::AppfileConfig.try_fetch_value(:itc_team_name) | ||
DELIVER_USE_LIVE_VERSION | Force usage of live version rather than edit version | false) | ||
DELIVER_USER | Optional: Your Apple ID | user | ||
DELIVER_USERNAME | Your Apple ID Username | user | ||
DEMO_ACCOUNT_REQUIRED | Hash | Do you need a demo account when Apple does review? | ||
DEPLOYGATE_API_TOKEN | Deploygate API Token | |||
DEPLOYGATE_APK_PATH | Path to your APK file | Actions.lane_context[SharedValues::GRADLE_APK_OUTPUT_PATH] | ||
DEPLOYGATE_DISABLE_NOTIFY | Disables Push notification emails | |||
DEPLOYGATE_DISTRIBUTION_KEY | Target Distribution Key | |||
DEPLOYGATE_DISTRIBUTION_NAME | Target Distribution Name | |||
DEPLOYGATE_IPA_PATH | Path to your IPA file. Optional if you use the gym or xcodebuild action | Actions.lane_context[SharedValues::IPA_OUTPUT_PATH] | ||
DEPLOYGATE_MESSAGE | Release Notes | "No changelog provided") | ||
DEPLOYGATE_RELEASE_NOTE | Release note for distribution page | false | ||
DEPLOYGATE_USER | Target username or organization name | |||
DERIVED_DATA_PATH | Custom path for derivedData | |||
DISABLE_XCPRETTY | Disable xcpretty formatting of build output | |||
DOTGPG_FILE | Path to your gpg file | Dir["dotgpg/*.gpg"].last | ||
DOWNLOAD_DSYMS_AFTER_UPLOADED_DATE | The uploaded date after which you wish to download dSYMs | |||
DOWNLOAD_DSYMS_APP_IDENTIFIER | The bundle identifier of your app | CredentialsManager::AppfileConfig.try_fetch_value(:app_identifier) | ||
DOWNLOAD_DSYMS_BUILD_NUMBER | The app build_number for dSYMs you wish to download | |||
DOWNLOAD_DSYMS_MIN_VERSION | The minimum app version for dSYMs you wish to download | |||
DOWNLOAD_DSYMS_OUTPUT_DIRECTORY | Where to save the download dSYMs, defaults to the current path | |||
DOWNLOAD_DSYMS_PLATFORM | The app platform for dSYMs you wish to download (ios, appletvos) | :ios) | ||
DOWNLOAD_DSYMS_TEAM_ID | The ID of your App Store Connect team if you're in multiple teams | CredentialsManager::AppfileConfig.try_fetch_value(:itc_team_id) | ||
DOWNLOAD_DSYMS_TEAM_NAME | The name of your App Store Connect team if you're in multiple teams | CredentialsManager::AppfileConfig.try_fetch_value(:itc_team_name) | ||
DOWNLOAD_DSYMS_USERNAME | Your Apple ID Username for App Store Connect | user | ||
DOWNLOAD_DSYMS_VERSION | The app version for dSYMs you wish to download, pass in 'latest' to download only the latest build's dSYMs or 'live' to download only the live version dSYMs | |||
DOWNLOAD_DSYMS_WAIT_FOR_DSYM_PROCESSING | Wait for dSYMs to process | false | ||
DOWNLOAD_DSYMS_WAIT_TIMEOUT | Array | Number of seconds to wait for dSYMs to process | false | |
FASTLANE_APP_IDENTIFIER | The bundle identifier of your app | CredentialsManager::AppfileConfig.try_fetch_value(:app_identifier) | ||
FASTLANE_ITC_TEAM_ID | The ID of your App Store Connect team if you're in multiple teams | CredentialsManager::AppfileConfig.try_fetch_value(:itc_team_id) | ||
FASTLANE_ITC_TEAM_NAME | The name of your App Store Connect team if you're in multiple teams | CredentialsManager::AppfileConfig.try_fetch_value(:itc_team_name) | ||
FASTLANE_RESET_SIMULATOR_OS_VERSIONS | Which OS versions of Simulators you want to reset content and settings, this does not remove/recreate the simulators | |||
FASTLANE_RESET_SIMULATOR_VERSIONS | Which OS versions of Simulators you want to reset content and settings, this does not remove/recreate the simulators | |||
FASTLANE_TEAM_ID | The ID of your Developer Portal team if you're in multiple teams | CredentialsManager::AppfileConfig.try_fetch_value(:team_id) | ||
FASTLANE_TEAM_NAME | The name of your Developer Portal team if you're in multiple teams | CredentialsManager::AppfileConfig.try_fetch_value(:team_name) | ||
FASTLANE_USER | Your Apple ID Username for App Store Connect | user | ||
FASTLANE_USERNAME | Your Apple ID Username | user | ||
FL_[[NAME_UP]]_API_TOKEN | API Token for [[NAME_CLASS]] | |||
FL_[[NAME_UP]]_DEVELOPMENT | Create a development certificate instead of a distribution one | |||
FL_ADB_COMMAND | All commands you want to pass to the adb command, e.g. kill-server |
|||
FL_ADB_PATH | Array | The optional extra platforms to support | "" | |
FL_ANDROID_SERIAL | Android serial of the device to use for this command | "") | ||
FL_APP_IDENTIFIER | Application Product Bundle Identifier | |||
FL_APPLEDOC_CLEAN_OUTPUT | Remove contents of output path before starting | false) | ||
FL_APPLEDOC_COMPANY_ID | Company UTI (i.e. reverse DNS name) | |||
FL_APPLEDOC_CREATE_DOCSET | Create documentation set | false) | ||
FL_APPLEDOC_CREATE_HTML | Create HTML | false) | ||
FL_APPLEDOC_DOCSET_ATOM_FILENAME | DocSet atom feed filename | |||
FL_APPLEDOC_DOCSET_BUNDLE_FILENAME | DocSet bundle filename | |||
FL_APPLEDOC_DOCSET_BUNDLE_ID | DocSet bundle identifier | |||
FL_APPLEDOC_DOCSET_BUNDLE_NAME | DocSet bundle name | |||
FL_APPLEDOC_DOCSET_CERT_ISSUER | DocSet certificate issuer | |||
FL_APPLEDOC_DOCSET_CERT_SIGNER | DocSet certificate signer | |||
FL_APPLEDOC_DOCSET_COPYRIGHT | DocSet copyright message | |||
FL_APPLEDOC_DOCSET_DESC | DocSet description | |||
FL_APPLEDOC_DOCSET_FALLBACK_URL | DocSet fallback URL | |||
FL_APPLEDOC_DOCSET_FEED_FORMATS | DocSet feed formats. Separated by a comma [atom,xml] | |||
FL_APPLEDOC_DOCSET_FEED_NAME | DocSet feed name | |||
FL_APPLEDOC_DOCSET_FEED_URL | DocSet feed URL | |||
FL_APPLEDOC_DOCSET_INSTALL_PATH | DocSet installation path | |||
FL_APPLEDOC_DOCSET_MIN_XCODE_VERSION | DocSet min. Xcode version | |||
FL_APPLEDOC_DOCSET_PACKAGE_FILENAME | DocSet package (.xar,.tgz) filename | |||
FL_APPLEDOC_DOCSET_PACKAGE_URL | DocSet package (.xar) URL | |||
FL_APPLEDOC_DOCSET_PLATFORM_FAMILY | DocSet platform family | |||
FL_APPLEDOC_DOCSET_PUBLISHER_ID | DocSet publisher identifier | |||
FL_APPLEDOC_DOCSET_PUBLISHER_NAME | DocSet publisher name | |||
FL_APPLEDOC_DOCSET_XML_FILENAME | DocSet xml feed filename | |||
FL_APPLEDOC_EXCLUDE_OUTPUT | Exclude given path from output | |||
FL_APPLEDOC_HTML_ANCHORS | The html anchor format to use in DocSet HTML | |||
FL_APPLEDOC_IGNORE | Ignore given path | |||
FL_APPLEDOC_INCLUDE | Include static doc(s) at path | |||
FL_APPLEDOC_INDEX_DESC | File including main index description | |||
FL_APPLEDOC_INPUT | Path(s) to source file directories or individual source files. Accepts a single path or an array of paths | |||
FL_APPLEDOC_INSTALL_DOCSET | Install documentation set to Xcode | false) | ||
FL_APPLEDOC_LOGFORMAT | Log format [0-3] | |||
FL_APPLEDOC_NO_CREATE_DOCSET | Create HTML and skip creating a DocSet | false) | ||
FL_APPLEDOC_OPTIONS | Documentation generation options | |||
FL_APPLEDOC_OPTIONS_CROSSREF_FORMAT | Cross reference template regex | |||
FL_APPLEDOC_OPTIONS_DOCS_SECTION_TITLE | Title of the documentation section (defaults to \ | |||
FL_APPLEDOC_OPTIONS_EXIT_THRESHOLD | Exit code threshold below which 0 is returned | 2, optional: true) | ||
FL_APPLEDOC_OUTPUT | Output path | |||
FL_APPLEDOC_PROJECT_COMPANY | Project company | |||
FL_APPLEDOC_PROJECT_NAME | Project name | |||
FL_APPLEDOC_PROJECT_VERSION | Project version | |||
FL_APPLEDOC_PUBLISH_DOCSET | Prepare DocSet for publishing | false) | ||
FL_APPLEDOC_TEMPLATES | Template files path | |||
FL_APPLEDOC_VERBOSE | Log verbosity level [0-6,xcode] | |||
FL_APPLEDOC_WARNINGS | Documentation generation warnings | |||
FL_APTELIGENT_API_KEY | Apteligent App API key e.g. IXPQIi8yCbHaLliqzRoo065tH0lxxxxx | |||
FL_APTELIGENT_APP_ID | Apteligent App ID key e.g. 569f5c87cb99e10e00c7xxxx | |||
FL_APTELIGENT_FILE | dSYM.zip file to upload to Apteligent | |||
FL_ARTIFACTORY_API_KEY | Artifactory API key | |||
FL_ARTIFACTORY_ENDPOINT | Artifactory endpoint | |||
FL_ARTIFACTORY_FILE | File to be uploaded to artifactory | |||
FL_ARTIFACTORY_PASSWORD | Artifactory password | |||
FL_ARTIFACTORY_PROPERTIES | Artifact properties hash | {} | ||
FL_ARTIFACTORY_PROXY_ADDRESS | Proxy address | nil | ||
FL_ARTIFACTORY_PROXY_PASSWORD | Proxy password | nil | ||
FL_ARTIFACTORY_PROXY_PORT | Proxy port | nil | ||
FL_ARTIFACTORY_PROXY_USERNAME | Proxy username | nil | ||
FL_ARTIFACTORY_READ_TIMEOUT | Read timeout | nil | ||
FL_ARTIFACTORY_REPO | Artifactory repo to put the file in | |||
FL_ARTIFACTORY_REPO_PATH | Path to deploy within the repo, including filename | |||
FL_ARTIFACTORY_SSL_PEM_FILE | Location of pem file to use for ssl verification | nil | ||
FL_ARTIFACTORY_SSL_VERIFY | Verify SSL | true | ||
FL_ARTIFACTORY_USERNAME | Artifactory username | |||
FL_BADGE_ALPHA | Adds and alpha badge instead of the default beta one | |||
FL_BADGE_ALPHA_CHANNEL | Keeps/adds an alpha channel to the icon (useful for android icons) | |||
FL_BADGE_CUSTOM | Add your custom overlay/badge image | |||
FL_BADGE_DARK | Adds a dark flavored badge ontop of your icon | |||
FL_BADGE_GLOB | Glob pattern for finding image files | |||
FL_BADGE_NO_BADGE | Hides the beta badge | |||
FL_BADGE_PATH | Sets the root path to look for AppIcons | '.' | ||
FL_BADGE_SHIELD | Add a shield to your app icon from shields.io | |||
FL_BADGE_SHIELD_GRAVITY | Position of shield on icon. Default: North - Choices include: NorthWest, North, NorthEast, West, Center, East, SouthWest, South, SouthEast | |||
FL_BADGE_SHIELD_IO_TIMEOUT | Set custom duration for the timeout of the shields.io request in seconds | |||
FL_BADGE_SHIELD_NO_RESIZE | String | The scheme to build. Can also be passed using the xcodebuild parameter |
{} | |
FL_BUILD_NUMBER_BUILD_NUMBER | Change to a specific version. When you provide this parameter, Apple Generic Versioning does not have to be enabled | |||
FL_BUILD_NUMBER_HIDE_ERROR_WHEN_VERSIONING_DISABLED | Used during fastlane init to hide the error message |
false | ||
FL_BUILD_NUMBER_PROJECT | optional, you must specify the path to your main Xcode project if it is not in the project root directory | |||
FL_BUNDLE_INSTALL_BINSTUBS | Generate bin stubs for bundled gems to ./bin | |||
FL_BUNDLE_INSTALL_CLEAN | Run bundle clean automatically after install | false) | ||
FL_BUNDLE_INSTALL_DEPLOYMENT | Install using defaults tuned for deployment and CI environments | false) | ||
FL_BUNDLE_INSTALL_FULL_INDEX | Use the rubygems modern index instead of the API endpoint | false) | ||
FL_BUNDLE_INSTALL_GEMFILE | Use the specified gemfile instead of Gemfile | |||
FL_BUNDLE_INSTALL_JOBS | Boolean | Install gems using parallel workers | ||
FL_BUNDLE_INSTALL_LOCAL | Do not attempt to fetch gems remotely and use the gem cache instead | false) | ||
FL_BUNDLE_INSTALL_NO_CACHE | Don't update the existing gem cache | false) | ||
FL_BUNDLE_INSTALL_NO_PRUNE | Don't remove stale gems from the cache | false) | ||
FL_BUNDLE_INSTALL_PATH | Specify a different path than the system default ($BUNDLE_PATH or $GEM_HOME). Bundler will remember this value for future installs on this machine | |||
FL_BUNDLE_INSTALL_QUIET | Only output warnings and errors | false) | ||
FL_BUNDLE_INSTALL_RETRY | Boolean | Retry network and git requests that have failed | ||
FL_BUNDLE_INSTALL_SHEBANG | Specify a different shebang executable name than the default (usually 'ruby') | |||
FL_BUNDLE_INSTALL_STANDALONE | Make a bundle that can work without the Bundler runtime | |||
FL_BUNDLE_INSTALL_SYSTEM | Install to the system location ($BUNDLE_PATH or $GEM_HOME) even if the bundle was previously installed somewhere else for this application | false) | ||
FL_BUNDLE_INSTALL_TRUST_POLICY | Sets level of security when dealing with signed gems. Accepts LowSecurity , MediumSecurity and HighSecurity as values |
|||
FL_BUNDLE_INSTALL_WITH | Include gems that are part of the specified named group | |||
FL_BUNDLE_INSTALL_WITHOUT | Exclude gems that are part of the specified named group | |||
FL_CARTHAGE_ARCHIVE | Boolean | Archive built frameworks from the current project | false) | |
FL_CARTHAGE_CACHE_BUILDS | Output name for the archive, could be applied only along with the archive command. Use following format *.framework.zip | [] | ||
FL_CARTHAGE_COMMAND | Carthage dependencies to update, build or bootstrap | [] | ||
FL_CARTHAGE_CONFIGURATION | Define which build configuration to use when building | |||
FL_CARTHAGE_DERIVED_DATA | Use derived data folder at path | |||
FL_CARTHAGE_EXECUTABLE | Boolean | Controls inclusion of merge commits when collecting the changelog. Valid values: #{GIT_MERGE_COMMIT_FILTERING_OPTIONS.map { | o | |
FL_CARTHAGE_LOG_PATH | Path to the xcode build output | |||
FL_CARTHAGE_NEW_RESOLVER | Use new resolver when resolving dependency graph | |||
FL_CARTHAGE_NO_BUILD | Boolean | When bootstrapping Carthage do not build | ||
FL_CARTHAGE_NO_CHECKOUT | Boolean | When bootstrapping Carthage do not checkout | ||
FL_CARTHAGE_NO_SKIP_CURRENT | Boolean | Don't skip building the Carthage project (in addition to its dependencies) | ||
FL_CARTHAGE_PLATFORM | Define which platform to build for | |||
FL_CARTHAGE_PROJECT_DIRECTORY | Define the directory containing the Carthage project | |||
FL_CARTHAGE_TOOLCHAIN | Define which xcodebuild toolchain to use when building | |||
FL_CARTHAGE_USE_BINARIES | Boolean | Check out dependency repositories even when prebuilt frameworks exist | ||
FL_CARTHAGE_USE_NETRC | Boolean | Use .netrc for downloading frameworks | ||
FL_CARTHAGE_USE_SSH | Boolean | Use SSH for downloading GitHub repositories | ||
FL_CARTHAGE_USE_SUBMODULES | Boolean | Add dependencies as Git submodules | ||
FL_CARTHAGE_USE_XCFRAMEWORKS | Boolean | Create xcframework bundles instead of one framework per platform (requires Xcode 12+) | false) | |
FL_CARTHAGE_VERBOSE | Boolean | Print xcodebuild output inline | ||
FL_CHATWORK_MESSAGE | The message to post on ChatWork | |||
FL_CHATWORK_ROOMID | The room ID | |||
FL_CHATWORK_SUCCESS | Was this build successful? (true/false) | true | ||
FL_CLEAN_BUILD_ARTIFACTS_EXCLUDE_PATTERN | Exclude all files from clearing that match the given Regex pattern: e.g. '.*.mobileprovision' | nil | ||
FL_CLEAN_COCOAPODS_CACHE_DEVELOPMENT | Pod name to be removed from cache | |||
FL_CLIPBOARD_VALUE | The string that should be copied into the clipboard | |||
FL_CLOC_BINARY_PATH | Where the cloc binary lives on your system (full path including 'cloc') | '/usr/local/bin/cloc') | ||
FL_CLOC_EXCLUDE_DIR | Comma separated list of directories to exclude | |||
FL_CLOC_OUTPUT_DIRECTORY | Where to put the generated report file | "build") | ||
FL_CLOC_SOURCE_DIRECTORY | Where to look for the source code (relative to the project root folder) | "") | ||
FL_CLOC_XML | Should we generate an XML File (if false, it will generate a plain text file)? | |||
FL_COCOAPODS_ALLOW_ROOT | false | |||
FL_COCOAPODS_ANSI | Show output with ANSI codes | true) | ||
FL_COCOAPODS_CLEAN | (Option renamed as clean_install) Remove SCM directories | true) | ||
FL_COCOAPODS_CLEAN_INSTALL | Execute a full pod installation ignoring the content of the project cache | false) | ||
FL_COCOAPODS_DEPLOYMENT | false | |||
FL_COCOAPODS_INTEGRATE | (Option removed from cocoapods) Integrate the Pods libraries into the Xcode project(s) | |||
FL_COCOAPODS_PODFILE | Explicitly specify the path to the Cocoapods' Podfile. You can either set it to the Podfile's path or to the folder containing the Podfile file | nil) | ||
FL_COCOAPODS_REPO_UPDATE | Add --repo-update flag to pod install command |
false) | ||
FL_COCOAPODS_SILENT | Execute command without logging output | false) | ||
FL_COCOAPODS_TRY_REPO_UPDATE_ON_ERROR | false | |||
FL_COCOAPODS_USE_BUNDLE_EXEC | Use bundle exec when there is a Gemfile presented | true) | ||
FL_COCOAPODS_VERBOSE | Show more debugging information | false) | ||
FL_CODE_SIGN_IDENTITY | Code signing identity type (iPhone Developer, iPhone Distribution) | |||
FL_COMMIT_BUMP_MESSAGE | The commit message when committing the version bump | "Version Bump") | ||
FL_COMMIT_GITHUB_FILE_API_BEARER | Use a Bearer authorization token. Usually generated by Github Apps, e.g. GitHub Actions GITHUB_TOKEN environment variable | nil) | ||
FL_COMMIT_GITHUB_FILE_API_TOKEN | Personal API Token for GitHub - generate one at https://github.com/settings/tokens | ENV["GITHUB_API_TOKEN"] | ||
FL_COMMIT_GITHUB_FILE_BRANCH | The branch that the file should be committed on (default: master) | 'master' | ||
FL_COMMIT_GITHUB_FILE_MESSAGE | The commit message. Defaults to the file name | |||
FL_COMMIT_GITHUB_FILE_REPOSITORY_NAME | The path to your repo, e.g. 'fastlane/fastlane' | |||
FL_COMMIT_GITHUB_FILE_SECURE | Optionally disable secure requests (ssl_verify_peer) | true | ||
FL_COMMIT_GITHUB_FILE_SERVER_URL | The server url. e.g. 'https://your.internal.github.host/api/v3' (Default: 'https://api.github.com') | "https://api.github.com" | ||
FL_COMMIT_INCLUDE_SETTINGS | A list of extra files to be included in the version bump (string array or comma-separated string) | [] | ||
FL_CREATE_XCFRAMEWORK_ALLOW_INTERNAL_DISTRIBUTION | Boolean | Specifies that the created xcframework contains information not suitable for public distribution | ||
FL_CREATE_XCFRAMEWORK_FRAMEWORKS | Array | Frameworks to add to the target xcframework | ||
FL_CREATE_XCFRAMEWORK_LIBRARIES | Hash | Libraries to add to the target xcframework, with their corresponding headers | ||
FL_CREATE_XCFRAMEWORK_OUTPUT | String | The path to write the xcframework to | ||
FL_DANGER_BASE | A branch/tag/commit to use as the base of the diff. [master | dev | stable] | |
FL_DANGER_DANGERFILE | The location of your Dangerfile | |||
FL_DANGER_FAIL_ON_ERRORS | Should always fail the build process, defaults to false | false) | ||
FL_DANGER_GITHUB_API_TOKEN | GitHub API token for danger | |||
FL_DANGER_HEAD | A branch/tag/commit to use as the head. [master | dev | stable] | |
FL_DANGER_ID | The identifier of this Danger instance | |||
FL_DANGER_NEW_COMMENT | Makes Danger post a new comment instead of editing its previous one | false) | ||
FL_DANGER_PR | Run danger on a specific pull request. e.g. \ | |||
FL_DANGER_REMOVE_PREVIOUS_COMMENT | Makes Danger remove all previous comment and create a new one in the end of the list | false) | ||
FL_DANGER_USE_BUNDLE_EXEC | Use bundle exec when there is a Gemfile presented | true) | ||
FL_DANGER_VERBOSE | Show more debugging information | false) | ||
FL_DISPLAY_NAME | Display name to force resigned ipa to use | |||
FL_DOWNLOAD_URL | The URL that should be downloaded | |||
FL_ENSURE_GIT_BRANCH_NAME | The branch that should be checked for. String that can be either the full name of the branch or a regex e.g. ^feature\/.*$ to match |
|||
FL_ENSURE_GIT_STATUS_CLEAN_IGNORED_FILE | The flag whether to ignore file the git status if the repo is dirty | |||
FL_ENSURE_GIT_STATUS_CLEAN_SHOW_DIFF | The flag whether to show the git diff if the repo is dirty | false | ||
FL_ENSURE_GIT_STATUS_CLEAN_SHOW_UNCOMMITTED_CHANGES | The flag whether to show uncommitted changes if the repo is dirty | false | ||
FL_ENSURE_NO_DEBUG_CODE_EXCLUDE | Exclude a certain pattern from the search | |||
FL_ENSURE_NO_DEBUG_CODE_EXCLUDE_DIRS | Array | An array of dirs that should not be included in the search | ||
FL_ENSURE_NO_DEBUG_CODE_EXTENSION | The extension that should be searched for | |||
FL_ENSURE_NO_DEBUG_CODE_EXTENSIONS | An array of file extensions that should be searched for | |||
FL_ENSURE_NO_DEBUG_CODE_PATH | The directory containing all the source files | "." | ||
FL_ENSURE_NO_DEBUG_CODE_TEXT | The text that must not be in the code base | |||
FL_ENSURE_XCODE_VERSION | Boolean | Should the version be verified strictly (all 3 version numbers), or matching only the given version numbers (i.e. 11.3 == 11.3.x ) |
||
FL_ERB_DST | Destination file | |||
FL_ERB_PLACEHOLDERS | Placeholders given as a hash | {} | ||
FL_ERB_SRC | ERB Template File | |||
FL_ERB_TRIM_MODE | Trim mode applied to the ERB | BASE_URL | ||
FL_FORCE_COMMIT | Forces the commit, even if other files than the ones containing the version number have been modified | false | ||
FL_GET_GITHUB_RELEASE_URL | The path to your repo, e.g. 'KrauseFx/fastlane' | |||
FL_GET_GITHUB_RELEASE_VERSION | The version tag of the release to check | |||
FL_GET_INFO_PLIST_PARAM_NAME | Name of parameter | |||
FL_GET_INFO_PLIST_PATH | Path to plist file you want to read | |||
FL_GET_IPA_INFO_PLIST_VALUE_IPA | Path to IPA | Actions.lane_context[SharedValues::IPA_OUTPUT_PATH] | ||
FL_GET_IPA_INFO_PLIST_VALUE_KEY | Name of parameter | |||
FL_GIT_PUSH_LOCAL_BRANCH | The local branch to push from. Defaults to the current branch | |||
FL_GIT_PUSH_PUSH_OPTION | Array | Array of strings to be passed using the '--push-option' option | ||
FL_GIT_PUSH_REMOTE | The remote to push to | 'origin') | ||
FL_GIT_PUSH_REMOTE_BRANCH | The remote branch to push to. Defaults to the local branch | |||
FL_GIT_PUSH_TAG | The tag to push to remote | |||
FL_GIT_PUSH_USE_NO_VERIFY | Boolean | Whether or not to use --no-verify | false) | |
FL_GIT_PUSH_USE_SET_UPSTREAM | Boolean | Whether or not to use --set-upstream | false) | |
FL_GIT_TAG_BUILD_NUMBER | The build number. Defaults to the result of increment_build_number if you're using it | Actions.lane_context[Actions::SharedValues::BUILD_NUMBER] | ||
FL_GIT_TAG_COMMIT | The commit or object where the tag will be set. Defaults to the current HEAD | |||
FL_GIT_TAG_FORCE | Force adding the tag | false) | ||
FL_GIT_TAG_GROUPING | Is used to keep your tags organised under one 'folder' | 'builds') | ||
FL_GIT_TAG_INCLUDES_LANE | Whether the current lane should be included in the tag and message composition, e.g. '//<build_number>' | true) | ||
FL_GIT_TAG_MESSAGE | The tag message. Defaults to the tag's name | |||
FL_GIT_TAG_POSTFIX | Anything you want to put at the end of the version number (e.g. '-RC1') | '') | ||
FL_GIT_TAG_PREFIX | Anything you want to put in front of the version number (e.g. 'v') | '') | ||
FL_GIT_TAG_SIGN | Your Store id | 'en-US' | ||
FL_GIT_TAG_TAG | Define your own tag text. This will replace all other parameters | |||
FL_GITHUB_API_BEARER | Use a Bearer authorization token. Usually generated by Github Apps, e.g. GitHub Actions GITHUB_TOKEN environment variable | nil) | ||
FL_GITHUB_API_HTTP_METHOD | The HTTP method. e.g. GET / POST | "GET" | ||
FL_GITHUB_API_PATH | The endpoint path. e.g. '/repos/:owner/:repo/readme' | |||
FL_GITHUB_API_REQUEST_BODY | The request body in JSON or hash format | {} | ||
FL_GITHUB_API_REQUEST_RAW_BODY | The request body taken verbatim instead of as JSON, useful for file uploads | |||
FL_GITHUB_API_SECURE | Array | The remote to check. Defaults to origin |
true) | |
FL_GITHUB_API_SERVER_URL | The server url. e.g. 'https://your.internal.github.host/api/v3' (Default: 'https://api.github.com') | "https://api.github.com" | ||
FL_GITHUB_API_TOKEN | Personal API Token for GitHub - generate one at https://github.com/settings/tokens | ENV["GITHUB_API_TOKEN"] | ||
FL_GITHUB_API_URL | Optional headers to apply | {} | ||
FL_GITHUB_RELEASE_API_BEARER | Use a Bearer authorization token. Usually generated by Github Apps, e.g. GitHub Actions GITHUB_TOKEN environment variable | nil) | ||
FL_GITHUB_RELEASE_API_TOKEN | Personal API Token for GitHub - generate one at https://github.com/settings/tokens | ENV["GITHUB_API_TOKEN"] | ||
FL_GITHUB_RELEASE_SERVER_URL | The server url. e.g. 'https://your.internal.github.host/api/v3' (Default: 'https://api.github.com') | "https://api.github.com" | ||
FL_HG_COMMIT_TEST_DIRTY_FILES | A list of dirty files passed in for testing | "file1, file2") | ||
FL_HG_COMMIT_TEST_EXP_FILES | A list of expected changed files passed in for testing | "file1 | ||
FL_HG_PUSH_DESTINATION | The destination to push to | '' | ||
FL_HG_PUSH_FORCE | Force push to remote | false) | ||
FL_HG_TAG_TAG | Tag to create | |||
FL_HIPCHAT_CHANNEL | The room or @username | |||
FL_HIPCHAT_CUSTOM_COLOR | Specify a custom color, this overrides the success boolean. Can be one of 'yellow', 'red', 'green', 'purple', 'gray', or 'random' | |||
FL_HIPCHAT_FROM | Name the message will appear to be sent from | "fastlane" | ||
FL_HIPCHAT_INCLUDE_HTML_HEADER | Should html formatted messages include a preformatted header? (true/false) | true | ||
FL_HIPCHAT_MESSAGE | The message to post on HipChat | '') | ||
FL_HIPCHAT_MESSAGE_FORMAT | Format of the message to post. Must be either 'html' or 'text' | "html" | ||
FL_HIPCHAT_SUCCESS | Was this build successful? (true/false) | true | ||
FL_HOCKEY_API_TOKEN | API Token for Hockey Access | |||
FL_HOCKEY_APK | Path to your APK file | Actions.lane_context[SharedValues::GRADLE_APK_OUTPUT_PATH] | ||
FL_HOCKEY_BUILD_SERVER_URL | The URL of the build job on your build server | |||
FL_HOCKEY_BUNDLE_SHORT_VERSION | The bundle_short_version of your application, required when using create_update |
|||
FL_HOCKEY_BUNDLE_VERSION | The bundle_version of your application, required when using create_update |
|||
FL_HOCKEY_BYPASS_CDN | Flag to bypass Hockey CDN when it uploads successfully but reports error | false) | ||
FL_HOCKEY_COMMIT_SHA | The Git commit SHA for this build | |||
FL_HOCKEY_CREATE_STATUS | Download status for initial version creation when create_update is true: \ | "2") | ||
FL_HOCKEY_CREATE_UPDATE | Set true if you want to create then update your app as opposed to just upload it. | false | ||
FL_HOCKEY_DSA_SIGNATURE | DSA signature for sparkle updates for macOS | "" | ||
FL_HOCKEY_DSYM | Path to your symbols file. For iOS and Mac provide path to app.dSYM.zip. For Android provide path to mappings.txt file | Actions.lane_context[SharedValues::DSYM_OUTPUT_PATH] | ||
FL_HOCKEY_IPA | Path to your IPA file. Optional if you use the gym or xcodebuild action. For Mac zip the .app. For Android provide path to .apk file. In addition you could use this to upload .msi, .zip, .pkg, etc if you use the 'create_update' mechanism | Actions.lane_context[SharedValues::IPA_OUTPUT_PATH] | ||
FL_HOCKEY_MANDATORY | Set to \ | "0") | ||
FL_HOCKEY_NOTES | Beta Notes | Actions.lane_context[SharedValues::FL_CHANGELOG] | ||
FL_HOCKEY_NOTES_TYPE | Notes type for your :notes, \ | "1") | ||
FL_HOCKEY_NOTIFY | Notify testers? \ | "1") | ||
FL_HOCKEY_OWNER_ID | ID for the owner of the app | |||
FL_HOCKEY_PUBLIC_IDENTIFIER | App id of the app you are targeting, usually you won't need this value. Required, if upload_dsym_only set to true |
|||
FL_HOCKEY_RELEASE_TYPE | Release type of the app: \ | "0") | ||
FL_HOCKEY_REPOSITORY_URL | The URL of your source repository | |||
FL_HOCKEY_STATUS | Download status: \ | "2") | ||
FL_HOCKEY_STRATEGY | Strategy: 'add' = to add the build as a new build even if it has the same build number (default); 'replace' = to replace a build with the same build number | "add" | ||
FL_HOCKEY_TAGS | Comma separated list of tags which will receive access to the build | |||
FL_HOCKEY_TEAMS | Comma separated list of team ID numbers to which this build will be restricted | |||
FL_HOCKEY_TIMEOUT | Integer | Request timeout in seconds | ||
FL_HOCKEY_UPLOAD_DSYM_ONLY | Flag to upload only the dSYM file to hockey app | false) | ||
FL_HOCKEY_USERS | Comma separated list of user ID numbers to which this build will be restricted | |||
FL_IMPORT_CERT_KEYCHAIN_PASSWORD | Boolean | The path to a directory where the repository should be cloned into. This is ignored if version is not specified. Defaults to nil , which causes the repository to be cloned on every call, to a temporary directory |
nil | |
FL_INSTALL_PROVISIONING_PROFILE_PATH | String | Path to provisioning profile | ||
FL_IOD_DEVICE_ID | id of the device / if not set defaults to first found device | |||
FL_IOD_EXTRA | Extra Commandline arguments passed to ios-deploy | |||
FL_IOD_IPA | The IPA file to put on the device | Actions.lane_context[SharedValues::IPA_OUTPUT_PATH] | ||
FL_IOD_WIFI | Do not search for devices via WiFi | |||
FL_JIRA_COMMENT_TEXT | Pattern to filter tags when looking for last one. Limit tags to ones matching given shell glob. If pattern lacks ?, *, or [, * at the end is implied | nil | ||
FL_JIRA_CONTEXT_PATH | Appends to the url (ex: \ | "") | ||
FL_JIRA_PASSWORD | Password for Jira | |||
FL_JIRA_SITE | URL for Jira instance | |||
FL_JIRA_TICKET_ID | Ticket ID for Jira, i.e. IOS-123 | |||
FL_JIRA_USERNAME | Username for JIRA instance | |||
FL_LCOV_ARCH | The build arch where will search .gcda files | "i386") | ||
FL_LCOV_OUTPUT_DIR | The output directory that coverage data will be stored. If not passed will use coverage_reports as default value | |||
FL_LCOV_PROJECT_NAME | Name of the project | |||
FL_LCOV_SCHEME | Scheme of the project | |||
FL_NEXUS_ENDPOINT | Nexus endpoint e.g. http://nexus:8081 | |||
FL_NEXUS_FILE | File to be uploaded to Nexus | |||
FL_NEXUS_MAJOR_VERSION | Integer | Nexus major version | 2 | |
FL_NEXUS_MOUNT_PATH | Nexus mount path (Nexus 3 instances have this configured as empty by default) | "/nexus" | ||
FL_NEXUS_PASSWORD | Nexus password | |||
FL_NEXUS_PROXY_ADDRESS | Proxy address | |||
FL_NEXUS_PROXY_PASSWORD | Proxy password | |||
FL_NEXUS_PROXY_PORT | Shell command to run when the notification is clicked | 'fastlane') | ||
FL_NEXUS_PROXY_USERNAME | Proxy username | |||
FL_NEXUS_REPO_CLASSIFIER | Nexus repository artifact classifier (optional) | |||
FL_NEXUS_REPO_GROUP_ID | Nexus repository group id e.g. com.company | |||
FL_NEXUS_REPO_ID | Nexus repository id e.g. artefacts | |||
FL_NEXUS_REPO_PROJECT_NAME | Nexus repository commandect name. Only letters, digits, underscores(_), hyphens(-), and dots(.) are allowed | |||
FL_NEXUS_REPO_PROJECT_VERSION | Nexus repository commandect version | |||
FL_NEXUS_SSL_VERIFY | Verify SSL | true | ||
FL_NEXUS_USERNAME | Nexus username | |||
FL_NEXUS_VERBOSE | Make detailed output | false | ||
FL_NO_UPDATE | Don't update during this run. This is used internally | false) | ||
FL_NUMBER_OF_COMMITS_ALL | Returns number of all commits instead of current branch | 'html' | ||
FL_OCLINT_ALLOW_DUPLICATED_VIOLATIONS | Allow duplicated violations in the OCLint report | false) | ||
FL_OCLINT_ENABLE_CLANG_STATIC_ANALYZER | Enable Clang Static Analyzer, and integrate results into OCLint report | false) | ||
FL_OCLINT_ENABLE_GLOBAL_ANALYSIS | Compile every source, and analyze across global contexts (depends on number of source files, could results in high memory load) | false) | ||
FL_OCLINT_LIST_ENABLED_RULES | List enabled rules | false) | ||
FL_POD_LIB_LINT_ALLOW_WARNINGS | Array | The sources of repos you want the pod spec to lint with, separated by commas | ||
FL_POD_LIB_LINT_ANALYZE | Boolean | Use bundle exec when there is a Gemfile presented | false | |
FL_POD_LIB_LINT_EXTERNAL_PODSPECS | String | The SWIFT_VERSION that should be used to lint the spec. This takes precedence over a .swift-version file | ||
FL_POD_LIB_LINT_FAIL_FAST | Boolean | Lint skips checks that apply only to public specs | false | |
FL_POD_LIB_LINT_INCLUDE_PODSPECS | String | A Glob of additional ancillary podspecs which are used for linting via :podspec. If there | ||
FL_POD_LIB_LINT_NO_CLEAN | Boolean | Lint skips validation of subspecs | false | |
FL_POD_LIB_LINT_NO_SUBSPECS | Lint against specific platforms (defaults to all platforms supported by | |||
FL_POD_LIB_LINT_PLATFORMS | Boolean | Lint skips validating that the pod can be imported (available since cocoapods >= 1.3) | false | |
FL_POD_LIB_LINT_PODSPEC | Boolean | Allow output detail in console | ||
FL_POD_LIB_LINT_PRIVATE | Boolean | Lint skips checks that would require to download and build the spec | false | |
FL_POD_LIB_LINT_QUICK | Boolean | Lint leaves the build directory intact for inspection | false | |
FL_POD_LIB_LINT_SKIP_IMPORT_VALIDATION | Boolean | Lint skips building and running tests during validation (available since cocoapods >= 1.3) | false | |
FL_POD_LIB_LINT_SKIP_TESTS | Boolean | Validate with the Xcode Static Analysis tool (available since cocoapods >= 1.6.1) | false | |
FL_POD_LIB_LINT_SOURCES | String | A specific subspec to lint instead of the entire spec | ||
FL_POD_LIB_LINT_SUBSPEC | String | A Glob of additional ancillary podspecs which are used for linting via :path (available since cocoapods >= 1.7) | ||
FL_POD_LIB_LINT_SWIFT_VERSION | Boolean | Lint uses static libraries to install the spec | false | |
FL_POD_LIB_LINT_USE_BUNDLE | String | Path of spec to lint | ||
FL_POD_LIB_LINT_USE_LIBRARIES | Boolean | Lint using modular libraries (available since cocoapods >= 1.6) | false | |
FL_POD_LIB_LINT_USE_MODULAR_HEADERS | Boolean | Lint stops on the first failing platform or subspec | false | |
FL_POD_LIB_LINT_VERBOSE | Boolean | Allow warnings during pod lint | ||
FL_POD_PUSH_ALLOW_WARNINGS | Boolean | Allow lint to use static libraries to install the spec | ||
FL_POD_PUSH_PATH | The repo you want to push. Pushes to Trunk by default | |||
FL_POD_PUSH_REPO | Boolean | Allow warnings during pod push | ||
FL_POD_PUSH_SKIP_IMPORT_VALIDATION | Boolean | Lint skips building and running tests during validation | ||
FL_POD_PUSH_SKIP_TESTS | Boolean | Convert the podspec to JSON before pushing it to the repo | ||
FL_POD_PUSH_SOURCES | The SWIFT_VERSION that should be used to lint the spec. This takes precedence over a .swift-version file | |||
FL_POD_PUSH_SWIFT_VERSION | Boolean | Lint skips validating that the pod can be imported | ||
FL_POD_PUSH_SYNCHRONOUS | Enable multi-line inputs by providing an end text (e.g. 'END') which will stop the user input | false | ||
FL_POD_PUSH_USE_BUNDLE_EXEC | The Podspec you want to push | |||
FL_POD_PUSH_USE_JSON | Boolean | Show more debugging information | false | |
FL_POD_PUSH_USE_LIBRARIES | Array | The sources of repos you want the pod spec to lint with, separated by commas | ||
FL_POD_PUSH_USE_MODULAR_HEADERS | Boolean | If validation depends on other recently pushed pods, synchronize | ||
FL_POD_PUSH_VERBOSE | Boolean | Use modular headers option during validation | ||
FL_PROJECT_PROVISIONING_CERTIFICATE_PATH | Path to apple root certificate | "/tmp/AppleIncRootCertificate.cer") | ||
FL_PROJECT_PROVISIONING_CODE_SIGN_IDENTITY | Code sign identity for build configuration | |||
FL_PROJECT_PROVISIONING_PROFILE_BUILD_CONFIGURATION | A filter for the build configuration name. Use a standard regex. Applied to all configurations if not specified | |||
FL_PROJECT_PROVISIONING_PROFILE_FILE | Path to provisioning profile (.mobileprovision) | Actions.lane_context[SharedValues::SIGH_PROFILE_PATH] | ||
FL_PROJECT_PROVISIONING_PROFILE_FILTER | Legacy option, use 'target_filter' instead | |||
FL_PROJECT_PROVISIONING_PROFILE_TARGET_FILTER | A filter for the target name. Use a standard regex | |||
FL_PROJECT_PROVISIONING_PROJECT_PATH | Path to your Xcode project | |||
FL_PROJECT_SIGNING_BUILD_CONFIGURATIONS | Array | Specify build_configurations you want to toggle the signing mech. (default to all configurations) | ||
FL_PROJECT_SIGNING_PROJECT_PATH | Path to your Xcode project | Dir['*.xcodeproj'].first | ||
FL_PROJECT_SIGNING_TARGETS | Array | Specify targets you want to toggle the signing mech. (default to all targets) | ||
FL_PROJECT_SIGNING_UDID | ENV["SIGH_UUID"] | |||
FL_PROJECT_SIGNING_UUID | The UUID of the provisioning profile you want to use | ENV["SIGH_UUID"] | ||
FL_PROJECT_TARGET | Array | Name of the targets you want to update | ||
FL_PROJECT_TEAM_ID | The Team ID you want to use | ENV["TEAM_ID"] | ||
FL_PROJECT_USE_AUTOMATIC_SIGNING | Defines if project should use automatic signing | false) | ||
FL_PROVISIONING_PROFILE | Provisioning profile UUID to use for code signing | |||
FL_PROVISIONING_PROFILE_SPECIFIER | Provisioning profile name to use for code signing | |||
FL_PUSH_GIT_FORCE | Boolean | Force push to remote | false) | |
FL_PUSH_GIT_FORCE_WITH_LEASE | Boolean | Force push with lease to remote | false) | |
FL_PUSH_GIT_TAGS | Boolean | Whether tags are pushed to remote | true) | |
FL_PUTS_MESSAGE | Message to be printed out | |||
FL_READ_PODSPEC_PATH | Path to the podspec to be read | Dir['.podspec'].first | ||
FL_REGISTER_DEVICE_API_KEY | Hash | Your App Store Connect API Key information (https://docs.fastlane.tools/app-store-connect-api/#use-return-value-and-pass-in-as-an-option) | Identical to APP_STORE_CONNECT_API_KEY | |
FL_REGISTER_DEVICE_API_KEY_PATH | Path to your App Store Connect API Key JSON file (https://docs.fastlane.tools/app-store-connect-api/#using-fastlane-api-key-json-file) | Identical to APP_STORE_CONNECT_API_KEY_PATH | ||
FL_REGISTER_DEVICE_NAME | Provide the name of the device to register as | |||
FL_REGISTER_DEVICE_PLATFORM | Provide the platform of the device to register as (ios, mac) | platform.empty? ? "ios" : platform | ||
FL_REGISTER_DEVICE_UDID | Provide the UDID of the device to register as | |||
FL_REGISTER_DEVICES_API_KEY | Hash | Your App Store Connect API Key information (https://docs.fastlane.tools/app-store-connect-api/#use-return-value-and-pass-in-as-an-option) | Identical to APP_STORE_CONNECT_API_KEY | |
FL_REGISTER_DEVICES_API_KEY_PATH | Path to your App Store Connect API Key JSON file (https://docs.fastlane.tools/app-store-connect-api/#using-fastlane-api-key-json-file) | Identical to APP_STORE_CONNECT_API_KEY_PATH | ||
FL_REGISTER_DEVICES_DEVICES | Hash | A hash of devices, with the name as key and the UDID as value | ||
FL_REGISTER_DEVICES_FILE | Provide a path to a file with the devices to register. For the format of the file see the examples | |||
FL_RESET_GIT_DISREGARD_GITIGNORE | Setting this to true will clean the whole repository, ignoring anything in your local .gitignore. Set this to true if you want the equivalent of a fresh clone, and for all untracked and ignore files to also be removed | true) | ||
FL_RESET_GIT_EXCLUDE | You can pass a string, or array of, file pattern(s) here which you want to have survive the cleaning process, and remain on disk, e.g. to leave the artifacts directory you would specify exclude: 'artifacts' . Make sure this pattern is also in your gitignore! See the gitignore documentation for info on patterns |
|||
FL_RESET_GIT_FILES | Array of files the changes should be discarded. If not given, all files will be discarded | |||
FL_RESET_GIT_FORCE | Skip verifying of previously clean state of repo. Only recommended in combination with files option |
false) | ||
FL_RESET_GIT_SKIP_CLEAN | Skip 'git clean' to avoid removing untracked files like .env |
false) | ||
FL_RESIGN_BUNDLE_ID | Set new bundle ID during resign (CFBundleIdentifier ) |
|||
FL_RESIGN_BUNDLE_VERSION | Bundle version to force resigned ipa to use (CFBundleVersion ) |
|||
FL_RESIGN_ENTITLEMENTS | Path to the entitlement file to use, e.g. myApp/MyApp.entitlements |
|||
FL_RESIGN_IPA | Path to the ipa file to resign. Optional if you use the gym or xcodebuild action | Actions.lane_context[SharedValues::IPA_OUTPUT_PATH] | ||
FL_RESIGN_KEYCHAIN_PATH | Original file name you want to restore | |||
FL_RESIGN_PROVISIONING_PROFILE | Path to your provisioning_profile. Optional if you use sigh | Actions.lane_context[SharedValues::SIGH_PROFILE_PATH] | ||
FL_RESIGN_SHORT_VERSION | Short version string to force resigned ipa to use (CFBundleShortVersionString ) |
|||
FL_RESIGN_SIGNING_IDENTITY | Code signing identity to use. e.g. iPhone Distribution: Luka Mirosevic (0123456789) |
|||
FL_RESIGN_VERSION | Version number to force resigned ipa to use. Updates both CFBundleShortVersionString and CFBundleVersion values in Info.plist . Applies for main app and all nested apps or extensions |
|||
FL_RSYNC_DST | destination file/folder | |||
FL_RSYNC_EXTRA | Port | "-av" | ||
FL_RSYNC_SRC | source file/folder | |||
FL_SCP_DOWNLOAD | Download | |||
FL_SCP_UPLOAD | Upload | |||
FL_SET_CHANGELOG_API_KEY | Hash | Your App Store Connect API Key information (https://docs.fastlane.tools/app-store-connect-api/#use-return-value-and-pass-in-as-an-option) | Identical to APP_STORE_CONNECT_API_KEY | |
FL_SET_CHANGELOG_API_KEY_PATH | Path to your App Store Connect API Key JSON file (https://docs.fastlane.tools/app-store-connect-api/#using-fastlane-api-key-json-file) | Identical to APP_STORE_CONNECT_API_KEY_PATH | ||
FL_SET_CHANGELOG_CHANGELOG | Changelog text that should be uploaded to App Store Connect | |||
FL_SET_CHANGELOG_PLATFORM | The platform of the app (ios, appletvos, mac) | "ios" | ||
FL_SET_CHANGELOG_TEAM_ID | The ID of your App Store Connect team if you're in multiple teams | CredentialsManager::AppfileConfig.try_fetch_value(:itc_team_id) | ||
FL_SET_CHANGELOG_TEAM_NAME | The name of your App Store Connect team if you're in multiple teams | CredentialsManager::AppfileConfig.try_fetch_value(:itc_team_name) | ||
FL_SET_CHANGELOG_VERSION | The version number to create/update | |||
FL_SET_GITHUB_RELEASE_COMMITISH | Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master) | |||
FL_SET_GITHUB_RELEASE_DESCRIPTION | Description of this release | Actions.lane_context[SharedValues::FL_CHANGELOG] | ||
FL_SET_GITHUB_RELEASE_IS_DRAFT | Whether the release should be marked as draft | false | ||
FL_SET_GITHUB_RELEASE_IS_PRERELEASE | Whether the release should be marked as prerelease | false | ||
FL_SET_GITHUB_RELEASE_NAME | Name of this release | |||
FL_SET_GITHUB_RELEASE_REPOSITORY_NAME | The path to your repo, e.g. 'fastlane/fastlane' | |||
FL_SET_GITHUB_RELEASE_TAG_NAME | Pass in the tag name | |||
FL_SET_GITHUB_RELEASE_UPLOAD_ASSETS | Array | Path to assets to be uploaded with the release | ||
FL_SET_INFO_PLIST_OUTPUT_FILE_NAME | Path to the output file you want to generate | |||
FL_SET_INFO_PLIST_PARAM_NAME | Name of key in plist | |||
FL_SET_INFO_PLIST_PARAM_VALUE | Value to setup | |||
FL_SET_INFO_PLIST_PATH | Path to plist file you want to update | |||
FL_SET_INFO_PLIST_SUBPARAM_NAME | Name of subkey in plist | |||
FL_SET_POD_KEY_ITEM_KEY | The key to be saved with cocoapods-keys | |||
FL_SET_POD_KEY_ITEM_VALUE | The value to be saved with cocoapods-keys | |||
FL_SET_POD_KEY_PROJECT | The project name | true) | ||
FL_SET_POD_KEY_USE_BUNDLE_EXEC | Use bundle exec when there is a Gemfile presented | true) | ||
FL_SETUP_CI_FORCE | Force setup, even if not executed by CI | false) | ||
FL_SETUP_CI_PROVIDER | CI provider. If none is set, the provider is detected automatically | |||
FL_SETUP_CIRCLECI_FORCE | Force setup, even if not executed by CircleCI | |||
FL_SETUP_JENKINS_ADD_KEYCHAIN_TO_SEARCH_LIST | Add to keychain search list | :replace) | ||
FL_SETUP_JENKINS_DERIVED_DATA_PATH | The directory where built products and other derived data will go | "./derivedData") | ||
FL_SETUP_JENKINS_FORCE | Force setup, even if not executed by Jenkins | false) | ||
FL_SETUP_JENKINS_OUTPUT_DIRECTORY | The directory in which the ipa file should be stored in | "./output") | ||
FL_SETUP_JENKINS_RESULT_BUNDLE | Produce the result bundle describing what occurred will be placed | |||
FL_SETUP_JENKINS_SET_CODE_SIGNING_IDENTITY | Set code signing identity from CODE_SIGNING_IDENTITY environment | true) | ||
FL_SETUP_JENKINS_SET_DEFAULT_KEYCHAIN | Set keychain as default | true) | ||
FL_SETUP_JENKINS_UNLOCK_KEYCHAIN | Unlocks keychain | true) | ||
FL_SETUP_TRAVIS_FORCE | Force setup, even if not executed by travis | |||
FL_SLACK_ATTACHMENT_PROPERTIES | Merge additional properties in the slack attachment, see https://api.slack.com/docs/attachments | {} | ||
FL_SLACK_CHANNEL | #channel or @username | |||
FL_SLACK_DEFAULT_PAYLOADS | Specifies default payloads to include. Pass an empty array to suppress all the default payloads | ['lane', 'test_result', 'git_branch', 'git_author', 'last_git_commit', 'last_git_commit_hash'] | ||
FL_SLACK_FAIL_ON_ERROR | Should an error sending the slack notification cause a failure? (true/false) | true | ||
FL_SLACK_ICON_URL | Overrides the webhook's image property if use_webhook_configured_username_and_icon is false | "https://fastlane.tools/assets/img/fastlane_icon.png" | ||
FL_SLACK_LINK_NAMES | Find and link channel names and usernames (true/false) | false | ||
FL_SLACK_MESSAGE | The message that should be displayed on Slack. This supports the standard Slack markup language | |||
FL_SLACK_PAYLOAD | Add additional information to this post. payload must be a hash containing any key with any value | {} | ||
FL_SLACK_PRETEXT | This is optional text that appears above the message attachment block. This supports the standard Slack markup language | |||
FL_SLACK_SUCCESS | Was this build successful? (true/false) | true | ||
FL_SLACK_USE_WEBHOOK_CONFIGURED_USERNAME_AND_ICON | Use webhook's default username and icon settings? (true/false) | false | ||
FL_SLACK_USERNAME | Overrides the webhook's username property if use_webhook_configured_username_and_icon is false | "fastlane" | ||
FL_SLATHER_ARCH | Specify which architecture the binary file is in. Needed for universal binaries | |||
FL_SLATHER_BINARY_BASENAME | Array | Basename of the binary file, this should match the name of your bundle excluding its extension (i.e. YourApp [for YourApp.app bundle]) | ||
FL_SLATHER_BINARY_FILE | Array | Binary file name to be used for code coverage | ||
FL_SLATHER_BUILD_DIRECTORY | The location of the build output | |||
FL_SLATHER_BUILDKITE_ENABLED | Boolean | Tell slather that it is running on Buildkite | ||
FL_SLATHER_CIRCLECI_ENABLED | Boolean | Tell slather that it is running on CircleCI | ||
FL_SLATHER_COBERTURA_XML_ENABLED | Boolean | Tell slather that it should output results as Cobertura XML format | ||
FL_SLATHER_CONFIGURATION | Configuration to use when calling slather (since slather-2.4.1) | |||
FL_SLATHER_COVERALLS_ENABLED | Boolean | Tell slather that it should post data to Coveralls | ||
FL_SLATHER_DECIMALS | The amount of decimals to use for % coverage reporting | false | ||
FL_SLATHER_GUTTER_JSON_ENABLED | Boolean | Tell slather that it should output results as Gutter JSON format | ||
FL_SLATHER_HTML_ENABLED | Boolean | Tell slather that it should output results as static HTML pages | ||
FL_SLATHER_IGNORE | Array | Tell slather to ignore files matching a path or any path from an array of paths | ||
FL_SLATHER_INPUT_FORMAT | The input format that slather should look for | |||
FL_SLATHER_JENKINS_ENABLED | Boolean | Tell slather that it is running on Jenkins | ||
FL_SLATHER_JSON_ENABLED | Boolean | Tell slather that it should output results as static JSON report | ||
FL_SLATHER_LLVM_COV_ENABLED | Tell slather that it should output results as llvm-cov show format | |||
FL_SLATHER_OUTPUT_DIRECTORY | Tell slather the location of for your output files | |||
FL_SLATHER_PROJ | The project file that slather looks at | |||
FL_SLATHER_SCHEME | Scheme to use when calling slather | |||
FL_SLATHER_SHOW_ENABLED | Boolean | Tell slather that it should open static html pages automatically | false) | |
FL_SLATHER_SIMPLE_OUTPUT_ENABLED | Boolean | Tell slather that it should output results to the terminal | ||
FL_SLATHER_SONARQUBE_XML_ENABLED | Boolean | Tell slather that it should output results as SonarQube Generic XML format | ||
FL_SLATHER_SOURCE_DIRECTORY | Tell slather the location of your source files | |||
FL_SLATHER_SOURCE_FILES | A Dir.glob compatible pattern used to limit the lookup to specific source files. Ignored in gcov mode | false | ||
FL_SLATHER_TEAMCITY_ENABLED | Boolean | Tell slather that it is running on TeamCity | ||
FL_SLATHER_TRAVIS_ENABLED | Boolean | Tell slather that it is running on TravisCI | ||
FL_SLATHER_TRAVIS_PRO_ENABLED | Boolean | Tell slather that it is running on TravisCI Pro | ||
FL_SLATHER_USE_BUNDLE_EXEC | Boolean | Use bundle exec to execute slather. Make sure it is in the Gemfile | false) | |
FL_SLATHER_VERBOSE | Boolean | Tell slather to enable verbose mode | ||
FL_SLATHER_WORKSPACE | The workspace that slather looks at | |||
FL_SONAR_LOGIN | Pass the Sonar Login token (e.g: xxxxxxprivate_token_XXXXbXX7e) | |||
FL_SONAR_ORGANIZATION | Key of the organization on SonarCloud | |||
FL_SONAR_RUNNER_ARGS | Pass additional arguments to sonar-scanner. Be sure to provide the arguments with a leading -D e.g. FL_SONAR_RUNNER_ARGS=\ |
|||
FL_SONAR_RUNNER_BRANCH_NAME | Pass the branch name which is getting scanned | |||
FL_SONAR_RUNNER_EXCLUSIONS | Comma-separated paths to directories to be excluded from the analysis | |||
FL_SONAR_RUNNER_PROJECT_KEY | The key sonar uses to identify the project, e.g. name.gretzki.awesomeApp . Must either be specified here or inside the sonar project configuration file |
|||
FL_SONAR_RUNNER_PROJECT_LANGUAGE | Language key, e.g. objc | |||
FL_SONAR_RUNNER_PROJECT_NAME | The name of the project that gets displayed on the sonar report page. Must either be specified here or inside the sonar project configuration file | |||
FL_SONAR_RUNNER_PROJECT_VERSION | The project's version that gets displayed on the sonar report page. Must either be specified here or inside the sonar project configuration file | |||
FL_SONAR_RUNNER_PROPERTIES_PATH | The path to your sonar project configuration file; defaults to sonar-project.properties |
|||
FL_SONAR_RUNNER_PULL_REQUEST_BASE | The long-lived branch into which the PR will be merged | |||
FL_SONAR_RUNNER_PULL_REQUEST_BRANCH | The name of the branch that contains the changes to be merged | |||
FL_SONAR_RUNNER_PULL_REQUEST_KEY | Boolean | Print all URLs requested | false | |
FL_SONAR_RUNNER_SOURCE_ENCODING | Used encoding of source files, e.g., UTF-8 | |||
FL_SONAR_RUNNER_SOURCES_PATH | Comma-separated paths to directories containing source files. Must either be specified here or inside the sonar project configuration file | |||
FL_SONAR_URL | Pass the url of the Sonar server | |||
FL_SPLUNKMINT_API_KEY | Splunk MINT App API key e.g. f57a57ca | |||
FL_SPLUNKMINT_API_TOKEN | Splunk MINT API token e.g. e05ba40754c4869fb7e0b61 | |||
FL_SPLUNKMINT_FILE | dSYM.zip file to upload to Splunk MINT | |||
FL_SPLUNKMINT_PROXY_ADDRESS | Proxy address | |||
FL_SPLUNKMINT_PROXY_PASSWORD | Proxy password | |||
FL_SPLUNKMINT_PROXY_PORT | Proxy port | |||
FL_SPLUNKMINT_PROXY_USERNAME | Proxy username | |||
FL_SPLUNKMINT_UPLOAD_PROGRESS | Show upload progress | false | ||
FL_SPLUNKMINT_VERBOSE | Make detailed output | false | ||
FL_SPM_BUILD_PATH | Specify build/cache directory [default: ./.build] | |||
FL_SPM_COMMAND | The swift command (one of: #{available_commands.join(', ')}) | "build" | ||
FL_SPM_CONFIGURATION | Build with configuration (debug | release) [default: debug] | ||
FL_SPM_DISABLE_SANDBOX | Disable using the sandbox when executing subprocesses | false) | ||
FL_SPM_ENABLE_CODE_COVERAGE | Enables code coverage for the generated Xcode project when using the 'generate-xcodeproj' and the 'test' command | |||
FL_SPM_PACKAGE_PATH | Change working directory before any other operation | |||
FL_SPM_VERBOSE | Increase verbosity of informational output | |||
FL_SPM_XCCONFIG | Use xcconfig file to override swift package generate-xcodeproj defaults | |||
FL_SPM_XCPRETTY_ARGS | String | Pass in xcpretty additional command line arguments (e.g. '--test --no-color' or '--tap --no-utf'), requires xcpretty_output to be specified also | ||
FL_SPM_XCPRETTY_OUTPUT | Specifies the output type for xcpretty. eg. 'test', or 'simple' | |||
FL_SSH_COMMANDS | Commands | |||
FL_SSH_HOST | Hostname | |||
FL_SSH_LOG | Log commands and output | true | ||
FL_SSH_PASSWORD | Password | |||
FL_SSH_PORT | Port | "22" | ||
FL_SSH_USERNAME | Username | |||
FL_SWIFTLINT_COMPILER_LOG_PATH | Compiler log path when mode is :analyze | |||
FL_SWIFTLINT_CONFIG_FILE | ||||
FL_SWIFTLINT_EXECUTABLE | Path to the swiftlint executable on your machine |
|||
FL_SWIFTLINT_FILES | ||||
FL_SWIFTLINT_FORMAT | Boolean | Format code when mode is :autocorrect | false | |
FL_SWIFTLINT_IGNORE_EXIT_STATUS | Boolean | false | ||
FL_SWIFTLINT_MODE | SwiftLint mode: :lint, :autocorrect or :analyze | :lint | ||
FL_SWIFTLINT_NO_CACHE | Boolean | Ignore the cache when mode is :autocorrect or :lint | false | |
FL_SWIFTLINT_OUTPUT_FILE | ||||
FL_SWIFTLINT_PATH | Specify path to lint | |||
FL_SWIFTLINT_QUIET | Boolean | Don't print status logs like 'Linting ' & 'Done linting' | false | |
FL_SWIFTLINT_RAISE_IF_SWIFTLINT_ERROR | Boolean | false | ||
FL_SWIFTLINT_REPORTER | ||||
FL_SWIFTLINT_STRICT | Boolean | false | ||
FL_TEST | ||||
FL_TESTFAIRY_API_KEY | API Key for TestFairy | Actions.lane_context[SharedValues::GRADLE_APK_OUTPUT_PATH] | ||
FL_TESTFAIRY_AUTO_UPDATE | Allows an easy upgrade of all users to the current version. To enable set to 'on' | 'off') | ||
FL_TESTFAIRY_COMMENT | Additional release notes for this upload. This text will be added to email notifications | 'No comment provided') | ||
FL_TESTFAIRY_CUSTOM | Array of custom options. Contact [email protected] for more information | '') | ||
FL_TESTFAIRY_METRICS | Array of metrics to record (cpu,memory,network,phone_signal,gps,battery,mic,wifi) | []) | ||
FL_TESTFAIRY_NOTIFY | Array | Send email to testers | 'off') | |
FL_TESTFAIRY_OPTIONS | Array of options (shake,video_only_wifi,anonymous) | []) | ||
FL_TESTFAIRY_SYMBOLS_FILE | Symbols mapping file | Actions.lane_context[SharedValues::DSYM_OUTPUT_PATH] | ||
FL_TESTFAIRY_TESTERS_GROUPS | Array | Array of tester groups to be notified | []) | |
FL_TESTFAIRY_TIMEOUT | Integer | Request timeout in seconds | ||
FL_TESTFAIRY_UPLOAD_URL | Array | API URL for TestFairy | "https://upload.testfairy.com" | |
FL_TW_ACCESS_TOKEN | Access Token | |||
FL_TW_ACCESS_TOKEN_SECRET | Access Token Secret | |||
FL_TW_CONSUMER_KEY | Consumer Key | |||
FL_TW_CONSUMER_SECRET | Consumer Secret | |||
FL_TW_MESSAGE | The tweet | |||
FL_UNLOCK_KEYCHAIN_ADD_TO_SEARCH_LIST | Add to keychain search list | true) | ||
FL_UNLOCK_KEYCHAIN_PASSWORD | Keychain password | |||
FL_UNLOCK_KEYCHAIN_PATH | Path to the keychain file | "login" | ||
FL_UNLOCK_KEYCHAIN_SET_DEFAULT | Set as default keychain | |||
FL_UPDATE_APP_GROUP_IDENTIFIER_APP_GROUP_IDENTIFIERS | An Array of unique identifiers for the app groups. Eg. ['group.com.test.testapp'] | |||
FL_UPDATE_APP_GROUP_IDENTIFIER_ENTITLEMENTS_FILE_PATH | The path to the entitlement file which contains the app group identifiers | |||
FL_UPDATE_APP_IDENTIFIER_PLIST_PATH | Path to info plist, relative to your Xcode project | ENV['PRODUCE_APP_IDENTIFIER'] | ||
FL_UPDATE_APP_IDENTIFIER_PROJECT_PATH | Path to your Xcode project | Dir['*.xcodeproj'].first | ||
FL_UPDATE_FASTLANE_NIGHTLY | Opt-in to install and use nightly fastlane builds | false | ||
FL_UPDATE_ICLOUD_CONTAINER_IDENTIFIERS_ENTITLEMENTS_FILE_PATH | The path to the entitlement file which contains the iCloud container identifiers | |||
FL_UPDATE_ICLOUD_CONTAINER_IDENTIFIERS_IDENTIFIERS | An Array of unique identifiers for the iCloud containers. Eg. ['iCloud.com.test.testapp'] | |||
FL_UPDATE_KEYCHAIN_ACCESS_GROUPS_ENTITLEMENTS_FILE_PATH | The path to the entitlement file which contains the keychain access groups | |||
FL_UPDATE_KEYCHAIN_ACCESS_GROUPS_IDENTIFIERS | An Array of unique identifiers for the keychain access groups. Eg. ['your.keychain.access.groups.identifiers'] | |||
FL_UPDATE_PLIST_APP_SCHEME | Scheme of info plist | ENV['PRODUCE_APP_IDENTIFIER'] | ||
FL_UPDATE_PLIST_PATH | Path to plist file | |||
FL_UPDATE_PLIST_PROJECT_PATH | Path to your Xcode project | |||
FL_UPDATE_URL_SCHEMES_SCHEMES | Block that is called to update schemes with current schemes passed in as parameter | |||
FL_UPLOAD_SYMBOLS_TO_CRASHLYTICS_BINARY_PATH | The path to the upload-symbols file of the Fabric app | |||
FL_UPLOAD_SYMBOLS_TO_CRASHLYTICS_DEBUG | Boolean | Enable debug mode for upload-symbols | ||
FL_UPLOAD_SYMBOLS_TO_CRASHLYTICS_DSYM_PATH | Path to the DSYM file or zip to upload | ENV[SharedValues::DSYM_OUTPUT_PATH.to_s] | ||
FL_UPLOAD_SYMBOLS_TO_CRASHLYTICS_DSYM_PATHS | Array | Paths to the DSYM files or zips to upload | ||
FL_UPLOAD_SYMBOLS_TO_CRASHLYTICS_DSYM_WORKER_THREADS | Integer | The number of threads to use for simultaneous dSYM upload | 1 | |
FL_UPLOAD_SYMBOLS_TO_CRASHLYTICS_PLATFORM | The platform of the app (ios, appletvos, mac) | "ios" | ||
FL_USE_APP_ENTITLEMENTS | Extract app bundle codesigning entitlements and combine with entitlements from new provisioning profile | |||
FL_VERIFY_BUILD_APP_NAME | Required app name | |||
FL_VERIFY_BUILD_BUILD_PATH | Explicitly set the ipa, app or xcarchive path | |||
FL_VERIFY_BUILD_BUNDLE_IDENTIFIER | Required bundle identifier | |||
FL_VERIFY_BUILD_IPA_PATH | Explicitly set the ipa path | |||
FL_VERIFY_BUILD_PROVISIONING_TYPE | Required type of provisioning | |||
FL_VERIFY_BUILD_PROVISIONING_UUID | Required UUID of provisioning profile | |||
FL_VERIFY_BUILD_TEAM_IDENTIFIER | Required team identifier | |||
FL_VERIFY_BUILD_TEAM_NAME | Required team name | |||
FL_VERIFY_XCODE_XCODE_PATH | The path to the Xcode installation to test | File.expand_path('../../', FastlaneCore::Helper.xcode_path) | ||
FL_VERSION_BUMP_PODSPEC_BUMP_TYPE | The type of this version bump. Available: patch, minor, major | "patch" | ||
FL_VERSION_BUMP_PODSPEC_PATH | You must specify the path to the podspec file to update | Dir["*.podspec"].last | ||
FL_VERSION_BUMP_PODSPEC_VERSION_APPENDIX | Change version appendix to a specific value. For example 1.4.14.4.1 -> 1.4.14.5 | |||
FL_VERSION_BUMP_PODSPEC_VERSION_NUMBER | Change to a specific version. This will replace the bump type value | |||
FL_VERSION_BUMP_PODSPEC_VERSION_REQUIRE_VARIABLE_PREFIX | true by default, this is used for non CocoaPods version bumps only | |||
FL_VERSION_NUMBER_BUMP_TYPE | The type of this version bump. Available: patch, minor, major | "bump" | ||
FL_VERSION_NUMBER_CONFIGURATION | Configuration name, optional. Will be needed if you have altered the configurations from the default or your version number depends on the configuration selected | |||
FL_VERSION_NUMBER_PROJECT | optional, you must specify the path to your main Xcode project if it is not in the project root directory | |||
FL_VERSION_NUMBER_TARGET | Target name, optional. Will be needed if you have more than one non-test target to avoid being prompted to select one | |||
FL_VERSION_NUMBER_VERSION_NUMBER | Change to a specific version. This will replace the bump type value | |||
FL_VERSION_PODSPEC_PATH | You must specify the path to the podspec file | Dir["*.podspec"].last | ||
FL_XCODE_PLUGIN_GITHUB | GitHub repository URL for Xcode plugin | |||
FL_XCODE_PLUGIN_URL | URL for Xcode plugin ZIP file | |||
FL_XCODE_SERVER_GET_ASSETS_BOT_NAME | Name of the Bot to pull assets from | |||
FL_XCODE_SERVER_GET_ASSETS_HOST | IP Address/Hostname of Xcode Server | |||
FL_XCODE_SERVER_GET_ASSETS_INTEGRATION_NUMBER | Optionally you can override which integration's assets should be downloaded. If not provided, the latest integration is used | |||
FL_XCODE_SERVER_GET_ASSETS_KEEP_ALL_ASSETS | Whether to keep all assets or let the script delete everything except for the .xcarchive | false) | ||
FL_XCODE_SERVER_GET_ASSETS_PASSWORD | Password for your Xcode Server | "") | ||
FL_XCODE_SERVER_GET_ASSETS_TARGET_FOLDER | Relative path to a folder into which to download assets | './xcs_assets') | ||
FL_XCODE_SERVER_GET_ASSETS_TRUST_SELF_SIGNED_CERTS | Whether to trust self-signed certs on your Xcode Server | |||
FL_XCODE_SERVER_GET_ASSETS_USERNAME | Username for your Xcode Server | "") | ||
FL_XCODE_VERSION | The version of Xcode to select specified as a Gem::Version requirement string (e.g. '~> 7.1.0') | |||
FL_ZIP_OUTPUT_NAME | The name of the resulting zip file | |||
FL_ZIP_PASSWORD | Encrypt the contents of the zip archive using a password | |||
FL_ZIP_PATH | Path to the directory or file to be zipped | |||
FL_ZIP_SYMLINKS | nil | yo | "123") | |
FL_ZIP_VERBOSE | Boolean | Enable verbose output of zipped file | true | |
FRAMEIT_DEBUG_MODE | Output debug information in framed screenshots | false | ||
FRAMEIT_FORCE_DEVICE_TYPE | Forces a given device type, useful for Mac screenshots, as their sizes vary | |||
FRAMEIT_GOLD_FRAME | Boolean | Use gold device frames. Alias for :gold | ||
FRAMEIT_RESUME | Resume frameit instead of reprocessing all screenshots | false | ||
FRAMEIT_ROSE_GOLD_FRAME | Boolean | Use rose gold device frames. Alias for :rose_gold | ||
FRAMEIT_SCREENSHOTS_PATH | The path to the directory containing the screenshots | Actions.lane_context[SharedValues::SNAPSHOT_SCREENSHOTS_PATH] | ||
FRAMEIT_SILVER_FRAME | Boolean | Use white device frames. Alias for :white | ||
FRAMEIT_USE_LEGACY_IPHONE_5_S | Use iPhone 5s instead of iPhone SE frames | false | ||
FRAMEIT_USE_LEGACY_IPHONE_6_S | Use iPhone 6s frames instead of iPhone 7 frames | false | ||
FRAMEIT_USE_LEGACY_IPHONE_7 | Use iPhone 7 frames instead of iPhone 8 frames | false | ||
FRAMEIT_USE_LEGACY_IPHONE_X | Use iPhone X instead of iPhone XS frames | false | ||
FRAMEIT_USE_LEGACY_IPHONE_XR | Use iPhone XR instead of iPhone 11 frames | false | ||
FRAMEIT_USE_LEGACY_IPHONE_XS | Use iPhone XS instead of iPhone 11 Pro frames | false | ||
FRAMEIT_USE_LEGACY_IPHONE_XS_MAX | [Advanced] A block to customize your screenshots' device orientation | false | ||
FRAMEIT_USE_PLATFORM | Choose a platform, the valid options are IOS, ANDROID and ANY (default is either general platform defined in the fastfile or IOS to ensure backward compatibility) | Platform.symbol_to_constant(Fastlane::Helper::LaneHelper.current_platform) | ||
FRAMEIT_WHITE_FRAME | Boolean | Use white device frames | ||
GITHUB_PULL_REQUEST_API_BEARER | Use a Bearer authorization token. Usually generated by Github Apps, e.g. GitHub Actions GITHUB_TOKEN environment variable | nil) | ||
GITHUB_PULL_REQUEST_API_TOKEN | Personal API Token for GitHub - generate one at https://github.com/settings/tokens | ENV["GITHUB_API_TOKEN"] | ||
GITHUB_PULL_REQUEST_API_URL | The URL of GitHub API - used when the Enterprise (default to https://api.github.com ) |
'https://api.github.com' | ||
GITHUB_PULL_REQUEST_ASSIGNEES | Array | The assignees for the pull request | ||
GITHUB_PULL_REQUEST_BASE | The name of the branch you want your changes pulled into (defaults to master ) |
'master' | ||
GITHUB_PULL_REQUEST_BODY | The contents of the pull request | |||
GITHUB_PULL_REQUEST_DRAFT | Boolean | Indicates whether the pull request is a draft | ||
GITHUB_PULL_REQUEST_HEAD | The name of the branch where your changes are implemented (defaults to the current branch name) | Actions.git_branch | ||
GITHUB_PULL_REQUEST_LABELS | Array | The labels for the pull request | ||
GITHUB_PULL_REQUEST_MILESTONE | Numeric | The milestone ID (Integer) for the pull request | ||
GITHUB_PULL_REQUEST_REPO | The name of the repository you want to submit the pull request to | |||
GITHUB_PULL_REQUEST_REVIEWERS | Array | The reviewers (slug) for the pull request | ||
GITHUB_PULL_REQUEST_TEAM_REVIEWERS | Array | The team reviewers (slug) for the pull request | ||
GITHUB_PULL_REQUEST_TITLE | The title of the pull request | |||
GOOGLE_SERVICES_INFO_PLIST_PATH | Path to GoogleService-Info.plist | |||
GYM_ANALYZE_BUILD_TIME | Analyze the project build time and store the output in 'culprits.txt' file | |||
GYM_ARCHIVE_PATH | The path to the created archive | |||
GYM_BUILD_PATH | The directory in which the archive should be stored in | |||
GYM_BUILDLOG_PATH | The directory where to store the build log | "#{FastlaneCore::Helper.buildlog_path}/gym" | ||
GYM_CATALYST_PLATFORM | String | Platform to build when using a Catalyst enabled app. Valid values are: ios, macos | ||
GYM_CLEAN | Boolean | Should the project be cleaned before building it? | false) | |
GYM_CLONED_SOURCE_PACKAGES_PATH | String | Sets a custom path for Swift Package Manager dependencies | ||
GYM_CODE_SIGNING_IDENTITY | The name of the code signing identity to use. It has to match the name exactly. e.g. 'iPhone Distribution: SunApps GmbH' | |||
GYM_CONFIGURATION | The configuration to use when building the app. Defaults to 'Release' | |||
GYM_DERIVED_DATA_PATH | The directory where built products and other derived data will go | |||
GYM_DESTINATION | Use a custom destination for building the app | |||
GYM_DISABLE_PACKAGE_AUTOMATIC_UPDATES | Boolean | Prevents packages from automatically being resolved to versions other than those recorded in the Package.resolved file |
false) | |
GYM_EXPORT_METHOD | String | Method used to export the archive. Valid values are: app-store, validation, ad-hoc, package, enterprise, development, developer-id and mac-application | ||
GYM_EXPORT_OPTIONS | Hash | Path to an export options plist or a hash with export options. Use 'xcodebuild -help' to print the full set of available options | ||
GYM_EXPORT_TEAM_ID | Optional: Sometimes you need to specify a team id when exporting the ipa file | |||
GYM_EXPORT_XCARGS | Pass additional arguments to xcodebuild for the package phase. Be sure to quote the setting names and values e.g. OTHER_LDFLAGS=\ | |||
GYM_INCLUDE_BITCODE | Boolean | Should the ipa file include bitcode? | ||
GYM_INCLUDE_SYMBOLS | Boolean | Should the ipa file include symbols? | ||
GYM_INSTALLER_CERT_NAME | String | Full name of 3rd Party Mac Developer Installer or Developer ID Installer certificate. Example: 3rd Party Mac Developer Installer: Your Company (ABC1234XWYZ) |
||
GYM_OUTPUT_DIRECTORY | The directory in which the ipa file should be stored in | ".") | ||
GYM_OUTPUT_NAME | The name of the resulting ipa file | |||
GYM_PROJECT | Path to the project file | |||
GYM_RESULT_BUNDLE | Boolean | Should an Xcode result bundle be generated in the output directory | false | |
GYM_RESULT_BUNDLE_PATH | Path to the result bundle directory to create. Ignored if result_bundle if false |
|||
GYM_SCHEME | The project's scheme. Make sure it's marked as Shared |
|||
GYM_SDK | The SDK that should be used for building the application | |||
GYM_SILENT | Hide all information that's not necessary while building | false | ||
GYM_SKIP_ARCHIVE | Boolean | After building, don't archive, effectively not including -archivePath param | ||
GYM_SKIP_BUILD_ARCHIVE | Boolean | Export ipa from previously built xcarchive. Uses archive_path as source | ||
GYM_SKIP_CODESIGNING | Boolean | Build without codesigning | ||
GYM_SKIP_PACKAGE_DEPENDENCIES_RESOLUTION | Boolean | Skips resolution of Swift Package Manager dependencies | false) | |
GYM_SKIP_PACKAGE_IPA | Boolean | Should we skip packaging the ipa? | false) | |
GYM_SKIP_PACKAGE_PKG | Boolean | Should we skip packaging the pkg? | false) | |
GYM_SKIP_PROFILE_DETECTION | Boolean | Do not try to build a profile mapping from the xcodeproj. Match or a manually provided mapping should be used | false) | |
GYM_TOOLCHAIN | The toolchain that should be used for building the application (e.g. com.apple.dt.toolchain.Swift_2_3, org.swift.30p620160816a) | |||
GYM_USE_SYSTEM_SCM | nil | Lets xcodebuild use system's scm configuration | ||
GYM_WORKSPACE | Path to the workspace file | |||
GYM_XCARGS | Pass additional arguments to xcodebuild for the build phase. Be sure to quote the setting names and values e.g. OTHER_LDFLAGS=\ | |||
GYM_XCCONFIG | Use an extra XCCONFIG file to build your app | |||
GYM_XCODE_BUILD_COMMAND | String | Allows for override of the default xcodebuild command |
"env NSUnbufferedIO=YES xcodebuild") | |
HIPCHAT_API_HOST | The host of the HipChat-Server API | "api.hipchat.com" | ||
HIPCHAT_API_TOKEN | Hipchat API Token | |||
HIPCHAT_API_VERSION | Version of the Hipchat API. Must be 1 or 2 | |||
HIPCHAT_NOTIFY_ROOM | Should the people in the room be notified? (true/false) | false | ||
IFTTT_API_KEY | API key | |||
IFTTT_EVENT_NAME | The name of the event that will be triggered | |||
IFTTT_VALUE1 | Extra data sent with the event | |||
IFTTT_VALUE2 | Extra data sent with the event | |||
IFTTT_VALUE3 | Certificate password | "" | ||
INITIAL_BUILD_NUMBER | sets the build number to given value if no build is in current train | 1 | ||
INSTALLR_ADD | Groups to add (e.g. 'exec,ops') | |||
INSTALLR_API_TOKEN | API Token for Installr Access | |||
INSTALLR_IPA_PATH | Path to your IPA file. Optional if you use the gym or xcodebuild action | Actions.lane_context[SharedValues::IPA_OUTPUT_PATH] | ||
INSTALLR_NOTES | Release notes | |||
INSTALLR_NOTIFY | Groups to notify (e.g. 'dev,qa') | |||
IPA_ARCHIVE | Archive project after building | |||
IPA_CLEAN | Clean project before building | |||
IPA_CONFIGURATION | Configuration used to build | |||
IPA_DESTINATION | Build destination. Defaults to current directory | |||
IPA_EMBED | Sign .ipa file with .mobileprovision | |||
IPA_IDENTITY | Identity to be used along with --embed | |||
IPA_IPA | Specify the name of the .ipa file to generate (including file extension) | |||
IPA_PROJECT | Project (.xcodeproj) file to use to build app (automatically detected in current directory, overridden by --workspace option, if passed) | |||
IPA_SCHEME | Scheme used to build app | |||
IPA_SDK | Use SDK as the name or path of the base SDK when building the project | |||
IPA_WORKSPACE | WORKSPACE Workspace (.xcworkspace) file to use to build app (automatically detected in current directory) | |||
IPA_XCARGS | auth_type | Pass additional arguments to xcodebuild when building the app. Be sure to quote multiple args | ||
IPA_XCCONFIG | Use an extra XCCONFIG file to build the app | |||
ITC_USERS | Array | Array of App Store Connect users. If provided, you can limit access to this newly created app for users with the App Manager, Developer, Marketer or Sales roles | ||
ITEM_ENV_VAR | Integer | a description | ||
ITUNESCONNECT_USER | Your Apple ID Username | user | ||
KEYCHAIN_NAME | Keychain the items should be imported to | |||
KEYCHAIN_PASSWORD | Keychain password | "") | ||
KEYCHAIN_PATH | Path to keychain | |||
LATEST_TESTFLIGHT_BUILD_NUMBER_TEAM_ID | The ID of your App Store Connect team if you're in multiple teams | CredentialsManager::AppfileConfig.try_fetch_value(:itc_team_id) | ||
LATEST_TESTFLIGHT_BUILD_NUMBER_TEAM_NAME | The name of your App Store Connect team if you're in multiple teams | CredentialsManager::AppfileConfig.try_fetch_value(:itc_team_name) | ||
LATEST_VERSION | The version number whose latest build number we want | |||
MAILGUN_APIKEY | Mailgun apikey for your mail | |||
MAILGUN_APP_LINK | App Release link | |||
MAILGUN_ATTACHMENT | Mail Attachment filenames, either an array or just one string | |||
MAILGUN_CI_BUILD_LINK | CI Build Link | |||
MAILGUN_CUSTOM_PLACEHOLDERS | Include the commit body along with the summary | "") | ||
MAILGUN_FROM | Mailgun sender name | "Mailgun Sandbox") | ||
MAILGUN_MESSAGE | Message of your mail | |||
MAILGUN_REPLY_TO | Mail Reply to | |||
MAILGUN_SANDBOX_POSTMASTER | Mailgun sandbox domain postmaster for your mail | |||
MAILGUN_SUBJECT | Subject of your mail | "fastlane build") | ||
MAILGUN_SUCCESS | Was this build successful? (true/false) | true | ||
MAILGUN_TEMPLATE_PATH | Mail HTML template | |||
MAILGUN_TO | Destination of your mail | |||
MATCH_ADDITIONAL_CERT_TYPES | Array | Create additional cert types needed for macOS installers (valid values: mac_installer_distribution, developer_id_installer) | ||
MATCH_APP_IDENTIFIER | Array | The bundle identifier(s) of your app (comma-separated string or array of strings) | CredentialsManager::AppfileConfig.try_fetch_value(:app_identifier) | |
MATCH_CLONE_BRANCH_DIRECTLY | Boolean | Clone just the branch specified, instead of the whole repo. This requires that the branch already exists. Otherwise the command will fail | false) | |
MATCH_DERIVE_CATALYST_APP_IDENTIFIER | Boolean | Enable this if you have the Mac Catalyst capability enabled and your project was created with Xcode 11.3 or earlier. Prepends 'maccatalyst.' to the app identifier for the provisioning profile mapping | false) | |
MATCH_FAIL_ON_NAME_TAKEN | Boolean | Should the command fail if it was about to create a duplicate of an existing provisioning profile. It can happen due to issues on Apple Developer Portal, when profile to be recreated was not properly deleted first | false) | |
MATCH_FORCE | Boolean | Renew the provisioning profiles every time you run match | false) | |
MATCH_FORCE_FOR_NEW_DEVICES | Boolean | Renew the provisioning profiles if the device count on the developer portal has changed. Ignored for profile type 'appstore' | false) | |
MATCH_GENERATE_APPLE_CERTS | Boolean | Create a certificate type for Xcode 11 and later (Apple Development or Apple Distribution) | FastlaneCore::Helper.mac? && FastlaneCore::Helper.xcode_at_least?('11') | |
MATCH_GIT_BASIC_AUTHORIZATION | Use a basic authorization header to access the git repo (e.g.: access via HTTPS, GitHub Actions, etc), usually a string in Base64 | nil) | ||
MATCH_GIT_BEARER_AUTHORIZATION | Use a bearer authorization header to access the git repo (e.g.: access to an Azure DevOps repository), usually a string in Base64 | nil) | ||
MATCH_GIT_BRANCH | Specific git branch to use | 'master') | ||
MATCH_GIT_FULL_NAME | git user full name to commit | nil) | ||
MATCH_GIT_PRIVATE_KEY | Use a private key to access the git repo (e.g.: access to GitHub repository via Deploy keys), usually a id_rsa named file or the contents hereof | nil) | ||
MATCH_GIT_URL | URL to the git repo containing all the certificates | |||
MATCH_GIT_USER_EMAIL | git user email to commit | nil) | ||
MATCH_GOOGLE_CLOUD_BUCKET_NAME | Name of the Google Cloud Storage bucket to use | |||
MATCH_GOOGLE_CLOUD_KEYS_FILE | Path to the gc_keys.json file | |||
MATCH_GOOGLE_CLOUD_PROJECT_ID | ID of the Google Cloud project to use for authentication | |||
MATCH_KEYCHAIN_NAME | Keychain the items should be imported to | "login.keychain") | ||
MATCH_KEYCHAIN_PASSWORD | This might be required the first time you access certificates on a new mac. For the login/default keychain this is your macOS account password | |||
MATCH_OUTPUT_PATH | Path in which to export certificates, key and profile | |||
MATCH_PLATFORM | Set the provisioning profile's platform to work with (i.e. ios, tvos, macos, catalyst) | default_platform | ||
MATCH_PROVISIONING_PROFILE_NAME | A custom name for the provisioning profile. This will replace the default provisioning profile name if specified | nil) | ||
MATCH_PROVISIONING_PROFILE_TEMPLATE_NAME | The name of provisioning profile template. If the developer account has provisioning profile templates (aka: custom entitlements), the template name can be found by inspecting the Entitlements drop-down while creating/editing a provisioning profile (e.g. \ | nil) | ||
MATCH_READONLY | Boolean | Only fetch existing certificates and profiles, don't generate new ones | false) | |
MATCH_S3_ACCESS_KEY | S3 access key | |||
MATCH_S3_BUCKET | Name of the S3 bucket | |||
MATCH_S3_OBJECT_PREFIX | Prefix to be used on all objects uploaded to S3 | |||
MATCH_S3_REGION | Name of the S3 region | |||
MATCH_S3_SECRET_ACCESS_KEY | S3 secret access key | |||
MATCH_SHALLOW_CLONE | Boolean | Make a shallow clone of the repository (truncate the history to 1 revision) | false) | |
MATCH_SKIP_CERTIFICATE_MATCHING | Boolean | Set to true if there is no access to Apple developer portal but there are certificates, keys and profiles provided. Only works with match import action | false) | |
MATCH_SKIP_CONFIRMATION | Boolean | Disables confirmation prompts during nuke, answering them with yes | false) | |
MATCH_SKIP_DOCS | Boolean | Skip generation of a README.md for the created git repository | false) | |
MATCH_SKIP_PROVISIONING_PROFILES | Boolean | Skip syncing provisioning profiles | false) | |
MATCH_SKIP_SET_PARTITION_LIST | Boolean | Skips setting the partition list (which can sometimes take a long time). Setting the partition list is usually needed to prevent Xcode from prompting to allow a cert to be used for signing | false) | |
MATCH_STORAGE_MODE | Define where you want to store your certificates | 'git' | ||
MATCH_TYPE | Define the profile type, can be #{Match.environments.join(', ')} | 'development' | ||
MATCH_USERNAME | Your Apple ID Username | user | ||
MATCH_VERBOSE | nil | Print out extra information and all commands | false | |
ONE_SIGNAL_APP_ID | OneSignal App ID. Setting this updates an existing app | |||
ONE_SIGNAL_APP_NAME | OneSignal App Name. This is required when creating an app (in other words, when :app_id is not set, and optional when updating an app |
|||
ONE_SIGNAL_AUTH_KEY | OneSignal Authorization Key | |||
ONE_SIGNAL_ORGANIZATION_ID | Boolean | Use bundle exec when there is a Gemfile presented | true | |
param | Float | Description | ||
PARAM | Object | Description | ||
PEM_ACTIVE_DAYS_LIMIT | Integer | If the current certificate is active for less than this number of days, generate a new one | 30 | |
PEM_APP_IDENTIFIER | The bundle identifier of your app | CredentialsManager::AppfileConfig.try_fetch_value(:app_identifier) | ||
PEM_DEVELOPMENT | Renew the development push certificate instead of the production one | false) | ||
PEM_FILE_NAME | The file name of the generated .pem file | |||
PEM_FORCE | Create a new push certificate, even if the current one is active for 30 (or PEM_ACTIVE_DAYS_LIMIT) more days | false) | ||
PEM_GENERATE_P12_FILE | Generate a p12 file additionally to a PEM file | true) | ||
PEM_OUTPUT_PATH | The path to a directory in which all certificates and private keys should be stored | |||
PEM_P12_PASSWORD | The password that is used for your p12 file | "") | ||
PEM_SAVE_PRIVATEKEY | Set to save the private RSA key | true) | ||
PEM_TEAM_ID | The ID of your Developer Portal team if you're in multiple teams | CredentialsManager::AppfileConfig.try_fetch_value(:team_id) | ||
PEM_TEAM_NAME | The name of your Developer Portal team if you're in multiple teams | CredentialsManager::AppfileConfig.try_fetch_value(:team_name) | ||
PEM_USERNAME | Your Apple ID Username | user | ||
PEM_WEBSITE_PUSH | Create a Website Push certificate | false) | ||
PILOT_API_KEY | Hash | Your App Store Connect API Key information (https://docs.fastlane.tools/app-store-connect-api/#use-return-value-and-pass-in-as-an-option) | Identical to APP_STORE_CONNECT_API_KEY | |
PILOT_API_KEY_PATH | Path to your App Store Connect API Key JSON file (https://docs.fastlane.tools/app-store-connect-api/#using-fastlane-api-key-json-file) | Identical to APP_STORE_CONNECT_API_KEY_PATH | ||
PILOT_APP_IDENTIFIER | The bundle identifier of the app to upload or manage testers (optional) | ENV["TESTFLIGHT_APP_IDENTITIFER"] | ||
PILOT_APP_VERSION | The version number of the application build to distribute. If the version number is not specified, then the most recent build uploaded to TestFlight will be distributed. If specified, the most recent build for the version number will be distributed | |||
PILOT_APPLE_ID | String | Apple ID property in the App Information section in App Store Connect | ENV["TESTFLIGHT_APPLE_ID"] | |
PILOT_BETA_APP_DESCRIPTION | Provide the 'Beta App Description' when uploading a new build | |||
PILOT_BETA_APP_FEEDBACK | Hash | Provide the beta app email when uploading a new build | ||
PILOT_BETA_APP_REVIEW_INFO | Hash | Beta app review information for contact info and demo account | ||
PILOT_BUILD_NUMBER | The build number of the application build to distribute. If the build number is not specified, the most recent build is distributed | |||
PILOT_CHANGELOG | Provide the 'What to Test' text when uploading a new build | |||
PILOT_DEV_PORTAL_TEAM_ID | The short ID of your team in the developer portal, if you're in multiple teams. Different from your iTC team ID! | CredentialsManager::AppfileConfig.try_fetch_value(:team_id) | ||
PILOT_DISTRIBUTE_EXTERNAL | Should the build be distributed to external testers? | false) | ||
PILOT_DISTRIBUTE_ONLY | Distribute a previously uploaded build (equivalent to the fastlane pilot distribute command) |
false | ||
PILOT_EXPIRE_PREVIOUS_BUILDS | Should expire previous builds? | false) | ||
PILOT_GROUPS | Array | Associate tester to one group or more by group name / group id. E.g. `-g \ | ||
PILOT_IPA | Boolean | Path to the ipa file to upload | Dir["*.ipa"].sort_by { | x |
PILOT_ITC_PROVIDER | The provider short name to be used with the iTMSTransporter to identify your team. This value will override the automatically detected provider short name. To get provider short name run pathToXcode.app/Contents/Applications/Application\\ Loader.app/Contents/itms/bin/iTMSTransporter -m provider -u 'USERNAME' -p 'PASSWORD' -account_type itunes_connect -v off . The short names of providers should be listed in the second column |
|||
PILOT_LOCALIZED_APP_INFO | Localized beta app test info for description, feedback email, marketing url, and privacy policy | |||
PILOT_LOCALIZED_BUILD_INFO | Localized beta app test info for what's new | |||
PILOT_NOTIFY_EXTERNAL_TESTERS | Should notify external testers? (Not setting a value will use App Store Connect's default which is to notify) | |||
PILOT_PLATFORM | The platform to use (optional) | 'ios' | ||
PILOT_REJECT_PREVIOUS_BUILD | en-gb description | |||
PILOT_SKIP_SUBMISSION | Skip the distributing action of pilot and only upload the ipa file | false) | ||
PILOT_SKIP_WAITING_FOR_BUILD_PROCESSING | If set to true, the distribute_external option won't work and no build will be distributed to testers. |
false) | ||
PILOT_TEAM_ID | The ID of your App Store Connect team if you're in multiple teams | CredentialsManager::AppfileConfig.try_fetch_value(:itc_team_id) | ||
PILOT_TEAM_NAME | The name of your App Store Connect team if you're in multiple teams | CredentialsManager::AppfileConfig.try_fetch_value(:itc_team_name) | ||
PILOT_TESTER_EMAIL | The tester's email | |||
PILOT_TESTER_FIRST_NAME | The tester's first name | |||
PILOT_TESTER_LAST_NAME | The tester's last name | |||
PILOT_TESTERS_FILE | Path to a CSV file of testers | "./testers.csv" | ||
PILOT_UPDATE_BUILD_INFO_ON_UPLOAD | Update build info immediately after validation. This is deprecated and will be removed in a future release. App Store Connect no longer supports setting build info until after build processing has completed, which is when build info is updated by default | false) | ||
PILOT_USERNAME | Your Apple ID Username | user | ||
PILOT_USES_NON_EXEMPT_ENCRYPTION | Provide the 'Uses Non-Exempt Encryption' for export compliance. This is used if there is 'ITSAppUsesNonExemptEncryption' is not set in the Info.plist | false | ||
PILOT_WAIT_FOR_UPLOADED_BUILD | Use version info from uploaded ipa file to determine what build to use for distribution. If set to false, latest processing or any latest build will be used | false) | ||
PILOT_WAIT_PROCESSING_INTERVAL | Integer | Interval in seconds to wait for App Store Connect processing | 30 | |
PRECHECK_API_KEY | Hash | Your App Store Connect API Key information (https://docs.fastlane.tools/app-store-connect-api/#use-return-value-and-pass-in-as-an-option) | Identical to APP_STORE_CONNECT_API_KEY | |
PRECHECK_API_KEY_PATH | Path to your App Store Connect API Key JSON file (https://docs.fastlane.tools/app-store-connect-api/#using-fastlane-api-key-json-file) | Identical to APP_STORE_CONNECT_API_KEY_PATH | ||
PRECHECK_APP_IDENTIFIER | The bundle identifier of your app | CredentialsManager::AppfileConfig.try_fetch_value(:app_identifier) | ||
PRECHECK_DEFAULT_RULE_LEVEL | The default rule level unless otherwise configured | RULE_LEVELS[:error]) | ||
PRECHECK_INCLUDE_IN_APP_PURCHASES | Should check in-app purchases? | true) | ||
PRECHECK_PLATFORM | The platform to use (optional) | "ios" | ||
PRECHECK_TEAM_ID | The ID of your App Store Connect team if you're in multiple teams | CredentialsManager::AppfileConfig.try_fetch_value(:itc_team_id) | ||
PRECHECK_TEAM_NAME | The name of your App Store Connect team if you're in multiple teams | CredentialsManager::AppfileConfig.try_fetch_value(:itc_team_name) | ||
PRECHECK_USE_LIVE | type | iap desc | self.class.default_value | |
PRECHECK_USERNAME | Your Apple ID Username | user | ||
PRODUCE_APP_IDENTIFIER | App Identifier (Bundle ID, e.g. com.krausefx.app) | CredentialsManager::AppfileConfig.try_fetch_value(:app_identifier) | ||
PRODUCE_APP_IDENTIFIER_SUFFIX | App Identifier Suffix (Ignored if App Identifier does not end with .*) | |||
PRODUCE_APP_NAME | App Name | |||
PRODUCE_COMPANY_NAME | The name of your company. Only required if it's the first app you create | |||
PRODUCE_ENABLE_SERVICES | Array with Spaceship App Services (e.g. #{allowed_services_description}) | {} | ||
PRODUCE_ENABLED_FEATURES | Array with Spaceship App Services | {} | ||
PRODUCE_ITC_TEAM_ID | The ID of your App Store Connect team if you're in multiple teams | CredentialsManager::AppfileConfig.try_fetch_value(:itc_team_id) | ||
PRODUCE_ITC_TEAM_NAME | The name of your App Store Connect team if you're in multiple teams | CredentialsManager::AppfileConfig.try_fetch_value(:itc_team_name) | ||
PRODUCE_LANGUAGE | Primary Language (e.g. 'en-US', 'fr-FR') | "English" | ||
PRODUCE_PLATFORM | The platform to use (optional) | "ios" | ||
PRODUCE_PLATFORMS | Array | The platforms to use (optional) | ||
PRODUCE_SKIP_DEVCENTER | Skip the creation of the app on the Apple Developer Portal | false) | ||
PRODUCE_SKIP_ITC | Skip the creation of the app on App Store Connect | false) | ||
PRODUCE_SKU | SKU Number (e.g. '1234') | Time.now.to_i.to_s | ||
PRODUCE_TEAM_ID | The ID of your Developer Portal team if you're in multiple teams | CredentialsManager::AppfileConfig.try_fetch_value(:team_id) | ||
PRODUCE_TEAM_NAME | The name of your Developer Portal team if you're in multiple teams | CredentialsManager::AppfileConfig.try_fetch_value(:team_name) | ||
PRODUCE_USERNAME | Your Apple ID Username | user | ||
PRODUCE_VERSION | Initial version number (e.g. '1.0') | |||
REGISTER_DEVICE_TEAM_ID | The ID of your Developer Portal team if you're in multiple teams | CredentialsManager::AppfileConfig.try_fetch_value(:team_id) | ||
REGISTER_DEVICE_TEAM_NAME | The name of your Developer Portal team if you're in multiple teams | CredentialsManager::AppfileConfig.try_fetch_value(:team_name) | ||
REGISTER_DEVICES_PLATFORM | The platform to use (optional) | platform.empty? ? "ios" : platform | ||
REGISTER_DEVICES_TEAM_ID | The ID of your Developer Portal team if you're in multiple teams | CredentialsManager::AppfileConfig.try_fetch_value(:team_id) | ||
REGISTER_DEVICES_TEAM_NAME | The name of your Developer Portal team if you're in multiple teams | CredentialsManager::AppfileConfig.try_fetch_value(:team_name) | ||
S3_ACCESS_KEY | AWS Access Key ID | ENV['AWS_ACCESS_KEY_ID'] | ||
S3_ACL | Uploaded object permissions e.g public_read (default), private, public_read_write, authenticated_read | |||
S3_BUCKET | AWS bucket name | ENV['AWS_BUCKET_NAME'] | ||
S3_PATH | S3 'path'. Values from Info.plist will be substituted for keys wrapped in {} | 'v{CFBundleShortVersionString}_b{CFBundleVersion}/') | ||
S3_REGION | AWS region (for bucket creation) | ENV['AWS_REGION'] | ||
S3_SECRET_ACCESS_KEY | AWS Secret Access Key | ENV['AWS_SECRET_ACCESS_KEY'] | ||
S3_SOURCE | Optional source directory e.g. ./build | |||
SAY_MUTE | Boolean | |||
SCAN_APP_NAME | App name to use in slack message and logfile name | |||
SCAN_BUILD_FOR_TESTING | Boolean | Build for testing only, does not run tests | ||
SCAN_BUILDLOG_PATH | The directory where to store the raw log | "#{FastlaneCore::Helper.buildlog_path}/scan" | ||
SCAN_CATALYST_PLATFORM | String | Platform to build when using a Catalyst enabled app. Valid values are: ios, macos | ||
SCAN_CLEAN | Should the project be cleaned before building it? | false) | ||
SCAN_CLONED_SOURCE_PACKAGES_PATH | String | Sets a custom path for Swift Package Manager dependencies | ||
SCAN_CODE_COVERAGE | Boolean | Should the thread sanitizer be turned on? | ||
SCAN_CONCURRENT_WORKERS | Integer | Specify the exact number of test runners that will be spawned during parallel testing. Equivalent to -parallel-testing-worker-count | ||
SCAN_CONFIGURATION | The configuration to use when building the app. Defaults to 'Release' | |||
SCAN_CUSTOM_REPORT_FILE_NAME | Sets custom full report file name when generating a single report | |||
SCAN_DEPLOYMENT_TARGET_VERSION | Target version of the app being build or tested. Used to filter out simulator version | |||
SCAN_DERIVED_DATA_PATH | The directory where build products and other derived data will go | |||
SCAN_DESTINATION | Use only if you're a pro, use the other options instead | |||
SCAN_DEVICE | The name of the simulator type you want to run tests on (e.g. 'iPhone 6') | |||
SCAN_DEVICES | Boolean | The bundle identifier of the app to uninstall (only needed when enabling reinstall_app) | CredentialsManager::AppfileConfig.try_fetch_value(:app_identifier) | |
SCAN_DISABLE_CONCURRENT_TESTING | Should debug build be skipped before test build? | |||
SCAN_DISABLE_PACKAGE_AUTOMATIC_UPDATES | Boolean | Prevents packages from automatically being resolved to versions other than those recorded in the Package.resolved file |
false) | |
SCAN_DISABLE_XCPRETTY | Boolean | Disable xcpretty formatting of build, similar to output_style='raw' but this will also skip the test results table |
||
SCAN_FAIL_BUILD | uploaded version filename | true | ||
SCAN_FORMATTER | A custom xcpretty formatter to use | |||
SCAN_INCLUDE_SIMULATOR_LOGS | Boolean | If the logs generated by the app (e.g. using NSLog, perror, etc.) in the Simulator should be written to the output_directory | false | |
SCAN_MAX_CONCURRENT_SIMULATORS | Boolean | Constrain the number of simulator devices on which to test concurrently. Equivalent to -maximum-concurrent-test-simulator-destinations | false | |
SCAN_ONLY_TEST_CONFIGURATIONS | Array of strings matching test plan configurations to run | |||
SCAN_ONLY_TESTING | Array of strings matching Test Bundle/Test Suite/Test Cases to run | |||
SCAN_OPEN_REPORT | Should the HTML report be opened when tests are completed? | false) | ||
SCAN_OUTPUT_DIRECTORY | The directory in which all reports will be stored | File.join(containing, "test_output") | ||
SCAN_OUTPUT_FILES | Comma separated list of the output files, corresponding to the types provided by :output_types (order should match). If specifying an output type of json-compilation-database with :use_clang_report_name enabled, that option will take precedence | nil) | ||
SCAN_OUTPUT_STYLE | Define how the output should look like. Valid values are: standard, basic, rspec, or raw (disables xcpretty during xcodebuild) | |||
SCAN_OUTPUT_TYPES | Comma separated list of the output types (e.g. html, junit, json-compilation-database) | "html,junit") | ||
SCAN_OUTPUT_XCTESTRUN | Should provide additional copy of .xctestrun file (settings.xctestrun) and place in output path? | false) | ||
SCAN_PROJECT | Path to the project file | |||
SCAN_RESULT_BUNDLE | Integer | Generate the json compilation database with clang naming convention (compile_commands.json) | false) | |
SCAN_SCHEME | The project's scheme. Make sure it's marked as Shared |
|||
SCAN_SDK | The SDK that should be used for building the application | |||
SCAN_SHOULD_ZIP_BUILD_PRODUCTS | Boolean | Should zip the derived data build products and place in output path? | false) | |
SCAN_SKIP_BUILD | Boolean | false) | ||
SCAN_SKIP_PACKAGE_DEPENDENCIES_RESOLUTION | Boolean | Skips resolution of Swift Package Manager dependencies | false) | |
SCAN_SKIP_SLACK | Don't publish to slack, even when an URL is given | false) | ||
SCAN_SKIP_TEST_CONFIGURATIONS | Array of strings matching test plan configurations to skip | |||
SCAN_SKIP_TESTING | Array of strings matching Test Bundle/Test Suite/Test Cases to skip | |||
SCAN_SLACK_CHANNEL | #channel or @username | |||
SCAN_SLACK_DEFAULT_PAYLOADS | Specifies default payloads to include in Slack messages. For more info visit https://docs.fastlane.tools/actions/slack | |||
SCAN_SLACK_ICON_URL | Overrides the webhook's image property if slack_use_webhook_configured_username_and_icon is false | "https://fastlane.tools/assets/img/fastlane_icon.png" | ||
SCAN_SLACK_MESSAGE | The message included with each message posted to slack | |||
SCAN_SLACK_ONLY_ON_FAILURE | Only post on Slack if the tests fail | false) | ||
SCAN_SLACK_USE_WEBHOOK_CONFIGURED_USERNAME_AND_ICON | Boolean | Use webhook's default username and icon settings? (true/false) | false | |
SCAN_SLACK_USERNAME | Overrides the webhook's username property if slack_use_webhook_configured_username_and_icon is false | "fastlane" | ||
SCAN_SUPPRESS_XCODE_OUTPUT | Suppress the output of xcodebuild to stdout. Output is still saved in buildlog_path | |||
SCAN_TEST_WITHOUT_BUILDING | Boolean | Test without building, requires a derived data path | ||
SCAN_TESTPLAN | The testplan associated with the scheme that should be used for testing | |||
SCAN_TOOLCHAIN | The toolchain that should be used for building the application (e.g. com.apple.dt.toolchain.Swift_2_3, org.swift.30p620160816a ) |
|||
SCAN_USE_SYSTEM_SCM | Array | Enabling this option will automatically clear previously generated screenshots before running screengrab | false | |
SCAN_WORKSPACE | Path to the workspace file | |||
SCAN_XCARGS | Pass additional arguments to xcodebuild. Be sure to quote the setting names and values e.g. OTHER_LDFLAGS=\ | |||
SCAN_XCCONFIG | Use an extra XCCONFIG file to build your app | |||
SCAN_XCPRETTY_ARGS | String | Pass in xcpretty additional command line arguments (e.g. '--test --no-color' or '--tap --no-utf') | ||
SCAN_XCTESTRUN | Run tests using the provided .xctestrun file |
|||
SCREENGRAB_OUTPUT_DIRECTORY | Array | Configure the host used by adb to connect, allows running on remote devices farm | true | |
SENTRY_API_KEY | API key for Sentry | |||
SENTRY_AUTH_TOKEN | Authentication token for Sentry | |||
SENTRY_DSYM_PATH | Path to your symbols file. For iOS and Mac provide path to app.dSYM.zip | Actions.lane_context[SharedValues::DSYM_OUTPUT_PATH] | ||
SENTRY_DSYM_PATHS | en-gb description | Actions.lane_context[SharedValues::DSYM_PATHS] | ||
SENTRY_HOST | API host url for Sentry | "https://app.getsentry.com/api/0" | ||
SENTRY_ORG_SLUG | Organization slug for Sentry project | |||
SENTRY_PROJECT_SLUG | Project slug for Sentry | |||
SIGH_AD_HOC | Setting this flag will generate AdHoc profiles instead of App Store Profiles | false | ||
SIGH_API_KEY | Hash | Your App Store Connect API Key information (https://docs.fastlane.tools/app-store-connect-api/#use-return-value-and-pass-in-as-an-option) | Identical to APP_STORE_CONNECT_API_KEY | |
SIGH_API_KEY_PATH | Path to your App Store Connect API Key JSON file (https://docs.fastlane.tools/app-store-connect-api/#using-fastlane-api-key-json-file) | Identical to APP_STORE_CONNECT_API_KEY_PATH | ||
SIGH_APP_IDENTIFIER | The bundle identifier of your app | CredentialsManager::AppfileConfig.try_fetch_value(:app_identifier) | ||
SIGH_CERTIFICATE | The certificate name to use for new profiles, or to renew with. (e.g. \ | |||
SIGH_CERTIFICATE_ID | The ID of the code signing certificate to use (e.g. 78ADL6LVAA) | |||
SIGH_DEVELOPER_ID | Setting this flag will generate Developer ID profiles instead of App Store Profiles | false | ||
SIGH_DEVELOPMENT | Renew the development certificate instead of the production one | false | ||
SIGH_FAIL_ON_NAME_TAKEN | profile_type | Should the command fail if it was about to create a duplicate of an existing provisioning profile. It can happen due to issues on Apple Developer Portal, when profile to be recreated was not properly deleted first | ||
SIGH_FORCE | Renew provisioning profiles regardless of its state - to automatically add all devices for ad hoc profiles | false) | ||
SIGH_IGNORE_PROFILES_WITH_DIFFERENT_NAME | Use in combination with :provisioning_name - when true only profiles matching this exact name will be downloaded | false) | ||
SIGH_OUTPUT_PATH | Directory in which the profile should be stored | ".") | ||
SIGH_PLATFORM | Set the provisioning profile's platform (i.e. ios, tvos, macos, catalyst) | "ios" | ||
SIGH_PROFILE_FILE_NAME | Filename to use for the generated provisioning profile (must include .mobileprovision) | |||
SIGH_PROVISIONING_PROFILE_NAME | The name of the profile that is used on the Apple Developer Portal | |||
SIGH_PROVISIONING_PROFILE_TEMPLATE_NAME | The name of provisioning profile template. If the developer account has provisioning profile templates (aka: custom entitlements), the template name can be found by inspecting the Entitlements drop-down while creating/editing a provisioning profile (e.g. \ | nil) | ||
SIGH_READONLY | Only fetch existing profile, don't generate new ones | false | ||
SIGH_SKIP_CERTIFICATE_VERIFICATION | Skips the verification of the certificates for every existing profiles. This will make sure the provisioning profile can be used on the local machine | false) | ||
SIGH_SKIP_FETCH_PROFILES | Skips the verification of existing profiles which is useful if you have thousands of profiles | false | ||
SIGH_SKIP_INSTALL | By default, the certificate will be added to your local machine. Setting this flag will skip this action | false) | ||
SIGH_TEAM_ID | The ID of your Developer Portal team if you're in multiple teams | CredentialsManager::AppfileConfig.try_fetch_value(:team_id) | ||
SIGH_TEAM_NAME | The name of your Developer Portal team if you're in multiple teams | CredentialsManager::AppfileConfig.try_fetch_value(:team_name) | ||
SIGH_USERNAME | Your Apple ID Username | user | ||
SLACK_URL | Create an Incoming WebHook for your Slack group to post results there | |||
SNAPSHOT_BUILDLOG_PATH | The directory where to store the build log | "#{FastlaneCore::Helper.buildlog_path}/snapshot" | ||
SNAPSHOT_CLEAN | Should the project be cleaned before building it? | false) | ||
SNAPSHOT_CLONED_SOURCE_PACKAGES_PATH | String | Sets a custom path for Swift Package Manager dependencies | ||
SNAPSHOT_CONFIGURATION | The configuration to use when building the app. Defaults to 'Release' | |||
SNAPSHOT_DERIVED_DATA_PATH | The directory where build products and other derived data will go | |||
SNAPSHOT_DISABLE_PACKAGE_AUTOMATIC_UPDATES | Boolean | Prevents packages from automatically being resolved to versions other than those recorded in the Package.resolved file |
false) | |
SNAPSHOT_DISABLE_SLIDE_TO_TYPE | Disable the simulator from showing the 'Slide to type' prompt | false | ||
SNAPSHOT_DISABLE_XCPRETTY | Boolean | Disable xcpretty formatting of build | ||
SNAPSHOT_EXECUTE_CONCURRENT_SIMULATORS | Take snapshots on multiple simulators concurrently. Note: This option is only applicable when running against Xcode 9 | true | ||
SNAPSHOT_NAMESPACE_LOG_FILES | Separate the log files per device and per language | |||
SNAPSHOT_ONLY_TESTING | Array of strings matching Test Bundle/Test Suite/Test Cases to run | |||
SNAPSHOT_OUTPUT_DIRECTORY | The directory where to store the screenshots | output_directory | ||
SNAPSHOT_OUTPUT_SIMULATOR_LOGS | Array | A path to screenshots.html template | ENV["SNAPSHOT_APP_IDENTITIFER"] | |
SNAPSHOT_PROJECT | Path the project file | |||
SNAPSHOT_RESULT_BUNDLE | Should an Xcode result bundle be generated in the output directory | false | ||
SNAPSHOT_SDK | Integer | Should snapshot stop immediately after the tests completely failed on one device? | false | |
SNAPSHOT_SKIP_PACKAGE_DEPENDENCIES_RESOLUTION | Boolean | Skips resolution of Swift Package Manager dependencies | false) | |
SNAPSHOT_SKIP_TESTING | Array of strings matching Test Bundle/Test Suite/Test Cases to skip | |||
SNAPSHOT_SUPPRESS_XCODE_OUTPUT | Boolean | Suppress the output of xcodebuild to stdout. Output is still saved in buildlog_path | ||
SNAPSHOT_TEST_TARGET_NAME | The name of the target you want to test (if you desire to override the Target Application from Xcode) | |||
SNAPSHOT_TEST_WITHOUT_BUILDING | Boolean | Test without building, requires a derived data path | ||
SNAPSHOT_TESTPLAN | The testplan associated with the scheme that should be used for testing | |||
SNAPSHOT_USE_SYSTEM_SCM | nil | German has at least 10 characters | ||
SNAPSHOT_WORKSPACE | Path the workspace file | |||
SNAPSHOT_XCARGS | Pass additional arguments to xcodebuild for the test phase. Be sure to quote the setting names and values e.g. OTHER_LDFLAGS=\ | |||
SNAPSHOT_XCCONFIG | Array | A list of launch arguments which should be used | ['']) | |
SNAPSHOT_XCPRETTY_ARGS | Additional xcpretty arguments | |||
SUPPLY_AAB | Path to the AAB file to upload | Dir["*.aab"].last | ||
SUPPLY_AAB_PATHS | Array | An array of paths to AAB files to upload | ||
SUPPLY_APK | Path to the APK file to upload | Dir["*.apk"].last | ||
SUPPLY_APK_PATHS | Array | An array of paths to APK files to upload | ||
SUPPLY_APP_TITLE | App Title | |||
SUPPLY_CHECK_SUPERSEDED_TRACKS | Boolean | Check the other tracks for superseded versions and disable them | false) | |
SUPPLY_DEACTIVATE_ON_PROMOTE | Array | An array of version codes to retain when publishing a new APK | true) | |
SUPPLY_DEVELOPER_ACCOUNT_ID | The ID of your Google Play Console account. Can be obtained from the URL when you log in (https://play.google.com/apps/publish/?account=... or when you 'Obtain private app publishing rights' (https://developers.google.com/android/work/play/custom-app-api/get-started#retrieve_the_developer_account_id) |
CredentialsManager::AppfileConfig.try_fetch_value(:developer_account_id) | ||
SUPPLY_IN_APP_UPDATE_PRIORITY | Integer | In-app update priority for all the newly added apks in the release. Can take values between [0,5] | ||
SUPPLY_ISSUER | The issuer of the p12 file (email address of the service account) | CredentialsManager::AppfileConfig.try_fetch_value(:issuer) | ||
SUPPLY_JSON_KEY | The path to a file containing service account JSON, used to authenticate with Google | CredentialsManager::AppfileConfig.try_fetch_value(:json_key_file) | ||
SUPPLY_JSON_KEY_DATA | The raw service account JSON data used to authenticate with Google | CredentialsManager::AppfileConfig.try_fetch_value(:json_key_data_raw) | ||
SUPPLY_KEY | The p12 File used to authenticate with Google | Dir["*.p12"].first | ||
SUPPLY_LANGUAGE | Default app language (e.g. 'en_US') | "en_US" | ||
SUPPLY_MAPPING | Path to the mapping file to upload | |||
SUPPLY_MAPPING_PATHS | Array | An array of paths to mapping files to upload | ||
SUPPLY_METADATA_PATH | Path to the directory containing the metadata files | (Dir["./fastlane/metadata/android"] + Dir["./metadata"]).first | ||
SUPPLY_OBB_MAIN_FILE SIZE | Size of 'main' expansion file in bytes | |||
SUPPLY_OBB_MAIN_REFERENCES_VERSION | References version of 'main' expansion file | |||
SUPPLY_OBB_PATCH_FILE SIZE | Size of 'patch' expansion file in bytes | |||
SUPPLY_OBB_PATCH_REFERENCES_VERSION | References version of 'patch' expansion file | |||
SUPPLY_PACKAGE_NAME | The package name of the application to use | CredentialsManager::AppfileConfig.try_fetch_value(:package_name) | ||
SUPPLY_RELEASE_STATUS | Release status (used when uploading new apks/aabs) - valid values are #{Supply::ReleaseStatus::ALL.join(', ')} | Supply::ReleaseStatus::COMPLETED | ||
SUPPLY_ROOT_URL | Root URL for the Google Play API. The provided URL will be used for API calls in place of https://www.googleapis.com/ | |||
SUPPLY_SKIP_UPLOAD_AAB | Boolean | Whether to skip uploading AAB | false) | |
SUPPLY_SKIP_UPLOAD_APK | Boolean | Whether to skip uploading APK | false) | |
SUPPLY_SKIP_UPLOAD_CHANGELOGS | Boolean | Whether to skip uploading changelogs | false) | |
SUPPLY_SKIP_UPLOAD_IMAGES | Boolean | Whether to skip uploading images, screenshots not included | false) | |
SUPPLY_SKIP_UPLOAD_METADATA | Boolean | Whether to skip uploading metadata, changelogs not included | false) | |
SUPPLY_SKIP_UPLOAD_SCREENSHOTS | Boolean | Whether to skip uploading SCREENSHOTS | false) | |
SUPPLY_TIMEOUT | Integer | Timeout for read, open, and send (in seconds) | 300) | |
SUPPLY_TRACK | String | The percentage of the user fraction when uploading to the rollout track (setting to 1 will complete the rollout) | Supply::Tracks::DEFAULT | |
SUPPLY_TRACK_PROMOTE_TO | The track to promote to. The default available tracks are: #{Supply::Tracks::DEFAULTS.join(', ')} | |||
SUPPLY_VALIDATE_ONLY | Boolean | Only validate changes with Google Play rather than actually publish | false) | |
SUPPLY_VERSION_CODE | Integer | Version code (used when updating rollout or promoting specific versions) | CredentialsManager::AppfileConfig.try_fetch_value(:version_code) | |
SUPPLY_VERSION_NAME | Version name (used when uploading new apks/aabs) - defaults to 'versionName' in build.gradle or AndroidManifest.xml | CredentialsManager::AppfileConfig.try_fetch_value(:version_name) | ||
SUPPRESS_OUTPUT | Suppress the output of xcodebuild to stdout. Output is still saved in buildlog_path | |||
TEST_KEY | A test key | |||
TRYOUTS_API_TOKEN | API Token (api_key:api_secret) for Tryouts Access | |||
TRYOUTS_APP_ID | Tryouts application hash | |||
TRYOUTS_BUILD_FILE | Path to your IPA or APK file. Optional if you use the gym or xcodebuild action | Actions.lane_context[SharedValues::IPA_OUTPUT_PATH] | ||
TRYOUTS_NOTES | Release notes | |||
TRYOUTS_NOTES_PATH | Release notes text file path. Overrides the :notes parameter | |||
TRYOUTS_NOTIFY | Notify testers? 0 for no | 1) | ||
TRYOUTS_STATUS | 2 to make your release public. Release will be distributed to available testers. 1 to make your release private. Release won't be distributed to testers. This also prevents release from showing up for SDK update | |||
UPLOAD_APP_PRIVACY_DETAILS_TO_APP_STORE_APP_IDENTIFIER | The bundle identifier of your app | CredentialsManager::AppfileConfig.try_fetch_value(:app_identifier) | ||
UPLOAD_APP_PRIVACY_DETAILS_TO_APP_STORE_JSON_PATH | Path to the app usage data JSON | |||
UPLOAD_APP_PRIVACY_DETAILS_TO_APP_STORE_OUTPUT_JSON_PATH | Path to the app usage data JSON file generated by interactive questions | File.join(DEFAULT_PATH, DEFAULT_FILE_NAME)) | ||
UPLOAD_APP_PRIVACY_DETAILS_TO_APP_STORE_OUTPUT_SKIP_JSON_FILE_SAVING | Boolean | Whether to skip the saving of the JSON file | false) | |
UPLOAD_APP_PRIVACY_DETAILS_TO_APP_STORE_OUTPUT_SKIP_PUBLISH | Boolean | Whether to skip the publishing | ||
UPLOAD_APP_PRIVACY_DETAILS_TO_APP_STORE_OUTPUT_SKIP_UPLOAD | Boolean | Whether to skip the upload and only create the JSON file with interactive questions | false) | |
URBAN_AIRSHIP_DETECT_PROVISIONING_MODE | Boolean | Automatically detect provisioning mode | ||
URBAN_AIRSHIP_DEVELOPMENT_APP_KEY | The development app key | |||
URBAN_AIRSHIP_DEVELOPMENT_APP_SECRET | The development app secret | |||
URBAN_AIRSHIP_PLIST_PATH | Path to Urban Airship configuration Plist | |||
URBAN_AIRSHIP_PRODUCTION_APP_KEY | The production app key | |||
URBAN_AIRSHIP_PRODUCTION_APP_SECRET | The production app secret | |||
USE_HG_REVISION_NUMBER | Use hg revision number instead of hash (ignored for non-hg repos) | false) | ||
XCODE_INSTALL_DOWNLOAD_RETRY_ATTEMPTS | Integer | Number of times the download will be retried in case of failure | ||
XCODE_INSTALL_TEAM_ID | The ID of your team if you're in multiple teams | CredentialsManager::AppfileConfig.try_fetch_value(:team_id) | ||
XCODE_INSTALL_USER | Your Apple ID Username | user | ||
XCODE_PROJECT | The Xcode project | |||
XCODEPROJ_PATH | explicitly specify which xcodeproj to use | |||
XCPRETTY_FORMATTER | A custom xcpretty formatter to use | |||
XCPRETTY_REPORT_HTML | Have xcpretty create a simple HTML report at the provided path | |||
XCPRETTY_REPORT_JSON | Have xcpretty create a JSON compilation database at the provided path | |||
XCPRETTY_REPORT_JUNIT | Have xcpretty create a JUnit-style XML report at the provided path | |||
XCPRETTY_TEST_FORMAT | Use the test (RSpec style) format for build output | |||
XCPRETTY_UTF | Have xcpretty use unicode encoding when reporting builds |