Options
All
  • Public
  • Public/Protected
  • All
Menu

Main Class

Hierarchy

  • FastlaneBase
    • Fastlane

Index

Constructors

Methods

Constructors

constructor

  • new Fastlane(port?: number, isInteractive?: boolean, debug?: boolean): Fastlane
  • Parameters

    • Optional port: number
    • Optional isInteractive: boolean
    • Optional debug: boolean

    Returns Fastlane

Methods

adb

  • see adb --help for more details

    Parameters

    Returns Promise<string>

    The output of the adb command

adbDevices

  • Fetches device list via adb, e.g. run an adb command on all connected devices.

    Parameters

    Returns Promise<any>

    Returns an array of all currently connected android devices (ex: )

addExtraPlatforms

addGitTag

  • This will automatically tag your build with the following format: <grouping>/<lane>/<prefix><build_number><postfix>, where:| |

    • grouping is just to keep your tags organised under one 'folder', defaults to 'builds'|
    • lane is the name of the current fastlane lane, if chosen to be included via 'includes_lane' option, which defaults to 'true'|
    • prefix is anything you want to stick in front of the version number, e.g. 'v'|
    • postfix is anything you want to stick at the end of the version number, e.g. '-RC1'|
    • build_number is the build number, which defaults to the value emitted by the increment_build_number action|

      | For example, for build 1234 in the 'appstore' lane, it will tag the commit with builds/appstore/1234.

    Parameters

    Returns Promise<any>

appStoreBuildNumber

  • Returns the current build number of either the live or testflight version - it is useful for getting the build_number of the current or ready-for-sale app version, and it also works on non-live testflight version. If you need to handle more build-trains please see latest_testflight_build_number.

    Parameters

    Returns Promise<any>

appStoreConnectApiKey

appaloosa

  • Appaloosa is a private mobile application store. This action offers a quick deployment on the platform. You can create an account, push to your existing account, or manage your user groups. We accept iOS and Android applications.

    Parameters

    Returns Promise<any>

appetize

  • If you provide a public_key, this will overwrite an existing application. If you want to have this build as a new app version, you shouldn't provide this value.

    To integrate appetize into your GitHub workflow check out the device_grid guide.

    Parameters

    Returns Promise<any>

appetizeViewingUrlGenerator

appium

appledoc

appstore

  • Using upload_to_app_store after build_app and capture_screenshots will automatically upload the latest ipa and screenshots with no other configuration.

    If you don't want to verify an HTML preview for App Store builds, use the :force option. This is useful when running fastlane on your Continuous Integration server: _upload_to_app_store_(force: true) If your account is on multiple teams and you need to tell the iTMSTransporter which 'provider' to use, you can set the :itc_provider option to pass this info.

    Parameters

    Returns Promise<any>

apteligent

artifactory

automaticCodeSigning

  • Configures Xcode's Codesigning options of all targets in the project

    Parameters

    Returns Promise<any>

    The current status (boolean) of codesigning after modification

backupFile

backupXcarchive

badge

  • Please use the badge plugin instead. This action will add a light/dark badge onto your app icon. You can also provide your custom badge/overlay or add a shield for more customization. More info: https://github.com/HazAT/badge Note*: If you want to reset the badge back to default, you can use sh 'git checkout -- <path>/Assets.xcassets/'.

    Parameters

    Returns Promise<any>

buildAndUploadToAppetize

buildAndroidApp

  • Run ./gradlew tasks to get a list of all available gradle tasks for your project

    Parameters

    Returns Promise<any>

    The output of running the gradle task

buildApp

buildIosApp

buildMacApp

bundleInstall

captureAndroidScreenshots

captureIosScreenshots

captureScreenshots

carthage

cert

  • Important*: It is recommended to use match according to the codesigning.guide for generating and maintaining your certificates. Use cert directly only if you want full control over what's going on and know more about codesigning. Use this action to download the latest code signing identity.

    Parameters

    Returns Promise<any>

changelogFromGitCommits

  • By default, messages will be collected back to the last tag, but the range can be controlled

    Parameters

    Returns Promise<string>

    Returns a String containing your formatted git commits

chatwork

checkAppStoreMetadata

cleanBuildArtifacts

  • This action deletes the files that get created in your repo as a result of running the gym and sigh commands. It doesn't delete the fastlane/report.xml though, this is probably more suited for the .gitignore.

    Useful if you quickly want to send out a test build by dropping down to the command line and typing something like fastlane beta, without leaving your repo in a messy state afterwards.

    Parameters

    Returns Promise<any>

cleanCocoapodsCache

clearDerivedData

clipboard

cloc

close

  • close(): Promise<any>
  • Returns Promise<any>

cocoapods

commitGithubFile

commitVersionBump

  • This action will create a 'Version Bump' commit in your repo. Useful in conjunction with increment_build_number. It checks the repo to make sure that only the relevant files have changed. These are the files that increment_build_number (agvtool) touches:| |

    • All .plist files|
    • The .xcodeproj/project.pbxproj file|

      | Then commits those files to the repo. Customize the message with the :message option. It defaults to 'Version Bump'. If you have other uncommitted changes in your repo, this action will fail. If you started off in a clean repo, and used the ipa and or sigh actions, then you can use the clean_build_artifacts action to clean those temporary files up before running this action.

    Parameters

    Returns Promise<any>

copyArtifacts

  • This action copies artifacts to a target directory. It's useful if you have a CI that will pick up these artifacts and attach them to the build. Useful e.g. for storing your .ipas, .dSYM.zips, .mobileprovisions, .certs. Make sure your :target_path is ignored from git, and if you use reset_git_repo, make sure the artifacts are added to the exclude list.

    Parameters

    Returns Promise<any>

createAppOnManagedPlayStore

createAppOnline

createKeychain

createPullRequest

createXcframework

  • Utility for packaging multiple build configurations of a given library or framework into a single xcframework.

    If you want to package several frameworks just provide one of:

    An array containing the list of frameworks using the :frameworks parameter (if they have no associated dSYMs): ['FrameworkA.framework', 'FrameworkB.framework']

    A hash containing the list of frameworks with their dSYMs using the :frameworks_with_dsyms parameter: { 'FrameworkA.framework' => {}, 'FrameworkB.framework' => { dsyms: 'FrameworkB.framework.dSYM' } }

    If you want to package several libraries just provide one of:

    An array containing the list of libraries using the :libraries parameter (if they have no associated headers or dSYMs): ['LibraryA.so', 'LibraryB.so']

    A hash containing the list of libraries with their headers and dSYMs using the :libraries_with_headers_or_dsyms parameter: { 'LibraryA.so' => { dsyms: 'libraryA.so.dSYM' }, 'LibraryB.so' => { headers: 'headers' } }

    Finally specify the location of the xcframework to be generated using the :output parameter.

    Parameters

    Returns Promise<any>

danger

debug

defaultPlatform

deleteKeychain

deliver

  • Using upload_to_app_store after build_app and capture_screenshots will automatically upload the latest ipa and screenshots with no other configuration.

    If you don't want to verify an HTML preview for App Store builds, use the :force option. This is useful when running fastlane on your Continuous Integration server: _upload_to_app_store_(force: true) If your account is on multiple teams and you need to tell the iTMSTransporter which 'provider' to use, you can set the :itc_provider option to pass this info.

    Parameters

    Returns Promise<any>

deploygate

doAction

  • doAction(action: string, argObj: {}): Promise<any>
  • Parameters

    • action: string
    • argObj: {}

    Returns Promise<any>

dotgpgEnvironment

download

downloadAppPrivacyDetailsFromAppStore

downloadDsyms

  • This action downloads dSYM files from App Store Connect after the ipa gets re-compiled by Apple. Useful if you have Bitcode enabled.| |

    ```ruby| lane :refresh_dsyms do| download_dsyms # Download dSYM files from iTC| upload_symbols_to_crashlytics # Upload them to Crashlytics| clean_build_artifacts # Delete the local dSYM files| end|

    ```|

    |

    Parameters

    Returns Promise<any>

downloadFromPlayStore

downloadUniversalApkFromGooglePlay

dsymZip

  • You can manually specify the path to the xcarchive (not needed if you use xcodebuild/xcarchive to build your archive)

    Parameters

    Returns Promise<any>

echo

ensureBundleExec

  • This action will check if you are using bundle exec to run fastlane. You can put it into before_all to make sure that fastlane is ran using the bundle exec fastlane command.

    Parameters

    Returns Promise<any>

ensureEnvVars

ensureGitBranch

  • This action will check if your git repo is checked out to a specific branch. You may only want to make releases from a specific branch, so ensure_git_branch will stop a lane if it was accidentally executed on an incorrect branch.

    Parameters

    Returns Promise<any>

ensureGitStatusClean

  • A sanity check to make sure you are working in a repo that is clean. Especially useful to put at the beginning of your Fastfile in the before_all block, if some of your other actions will touch your filesystem, do things to your git repo, or just as a general reminder to save your work. Also needed as a prerequisite for some other actions like reset_git_repo.

    Parameters

    Returns Promise<any>

ensureNoDebugCode

  • You don't want any debug code to slip into production. This can be used to check if there is any debug code still in your codebase or if you have things like // TO DO or similar.

    Parameters

    Returns Promise<any>

ensureXcodeVersion

  • If building your app requires a specific version of Xcode, you can invoke this command before using gym. For example, to ensure that a beta version of Xcode is not accidentally selected to build, which would make uploading to TestFlight fail. You can either manually provide a specific version using version: or you make use of the .xcode-version file. Using the strict parameter, you can either verify the full set of version numbers strictly (i.e. 11.3.1) or only a subset of them (i.e. 11.3 or 11).

    Parameters

    Returns Promise<any>

environmentVariable

erb

  • Renders an ERB template with :placeholders given as a hash via parameter. If no :destination is set, it returns the rendered template as string.

    Parameters

    Returns Promise<any>

fastlaneVersion

  • Add this to your Fastfile to require a certain version of fastlane. Use it if you use an action that just recently came out and you need it.

    Parameters

    Returns Promise<any>

flock

frameScreenshots

  • Uses frameit to prepare perfect screenshots for the App Store, your website, QA or emails. You can add background and titles to the framed screenshots as well.

    Parameters

    Returns Promise<any>

frameit

  • Uses frameit to prepare perfect screenshots for the App Store, your website, QA or emails. You can add background and titles to the framed screenshots as well.

    Parameters

    Returns Promise<any>

gcovr

getBuildNumber

getBuildNumberRepository

  • This action will get the build number according to what the SCM HEAD reports. Currently supported SCMs are svn (uses root revision), git-svn (uses svn revision), git (uses short hash) and mercurial (uses short hash or revision number). There is an option, :use_hg_revision_number, which allows to use mercurial revision number instead of hash.

    Parameters

    Returns Promise<any>

    The build number from the current repository

getCertificates

  • Important*: It is recommended to use match according to the codesigning.guide for generating and maintaining your certificates. Use cert directly only if you want full control over what's going on and know more about codesigning. Use this action to download the latest code signing identity.

    Parameters

    Returns Promise<any>

getGithubRelease

getInfoPlistValue

  • Get a value from a plist file, which can be used to fetch the app identifier and more information about your app

    Parameters

    Returns Promise<string>

getIpaInfoPlistValue

  • This is useful for introspecting Info.plist files for .ipa files that have already been built.

    Parameters

    Returns Promise<string>

    Returns the value in the .ipa's Info.plist corresponding to the passed in Key

getManagedPlayStorePublishingRights

getProvisioningProfile

  • Note*: It is recommended to use match according to the codesigning.guide for generating and maintaining your provisioning profiles. Use sigh directly only if you want full control over what's going on and know more about codesigning.

    Parameters

    Returns Promise<string>

    The UUID of the profile sigh just fetched/generated

getPushCertificate

  • Additionally to the available options, you can also specify a block that only gets executed if a new profile was created. You can use it to upload the new profile to your server. Use it like this:| |

    ```ruby| get_push_certificate(| new_profile: proc do|

    your upload code|

    end| )|

    ```|

    |

    Parameters

    Returns Promise<any>

getVersionNumber

  • This action will return the current version number set on your project. It first looks in the plist and then for '$(MARKETING_VERSION)' in the build settings.

    Parameters

    Returns Promise<string>

gitAdd

gitBranch

  • If no branch could be found, this action will return an empty string. If FL_GIT_BRANCH_DONT_USE_ENV_VARS is true, it'll ignore CI ENV vars. This is a wrapper for the internal action Actions.git_branch

    Parameters

    Returns Promise<string>

gitCommit

gitPull

gitRemoteBranch

  • If no default remote branch could be found, this action will return nil. This is a wrapper for the internal action Actions.git_default_remote_branch_name

    Parameters

    Returns Promise<string>

gitSubmoduleUpdate

gitTagExists

  • Checks if the git tag with the given name exists in the current repo

    Parameters

    Returns Promise<any>

    Boolean value whether the tag exists or not

githubApi

googlePlayTrackReleaseNames

googlePlayTrackVersionCodes

gradle

  • Run ./gradlew tasks to get a list of all available gradle tasks for your project

    Parameters

    Returns Promise<any>

    The output of running the gradle task

gym

hgAddTag

hgCommitVersionBump

  • The mercurial equivalent of the commit_version_bump git action. Like the git version, it is useful in conjunction with increment_build_number. It checks the repo to make sure that only the relevant files have changed, these are the files that increment_build_number (agvtool) touches:| |

    • All .plist files|
    • The .xcodeproj/project.pbxproj file|

      | Then commits those files to the repo. Customize the message with the :message option, defaults to 'Version Bump' If you have other uncommitted changes in your repo, this action will fail. If you started off in a clean repo, and used the ipa and or sigh actions, then you can use the clean_build_artifacts action to clean those temporary files up before running this action.

    Parameters

    Returns Promise<any>

hgEnsureCleanStatus

hgPush

  • The mercurial equivalent of push_to_git_remote. Pushes your local commits to a remote mercurial repo. Useful when local changes such as adding a version bump commit or adding a tag are part of your lane’s actions.

    Parameters

    Returns Promise<any>

hipchat

  • Send a message to room (by default) or a direct message to @username with success (green) or failure (red) status.

    Parameters

    Returns Promise<any>

hockey

  • HockeyApp will be no longer supported and will be transitioned into App Center on November 16, 2019. Please migrate over to App Center

    Symbols will also be uploaded automatically if a app.dSYM.zip file is found next to app.ipa. In case it is located in a different place you can specify the path explicitly in the :dsym parameter. More information about the available options can be found in the HockeyApp Docs.

    Parameters

    Returns Promise<any>

ifttt

  • Connect to the IFTTT Maker Channel. An IFTTT Recipe has two components: a Trigger and an Action. In this case, the Trigger will fire every time the Maker Channel receives a web request (made by this fastlane action) to notify it of an event. The Action can be anything that IFTTT supports: email, SMS, etc.

    Parameters

    Returns Promise<any>

import

  • This is useful if you have shared lanes across multiple apps and you want to store a Fastfile in a separate folder. The path must be relative to the Fastfile this is called from.

    Parameters

    Returns Promise<any>

importCertificate

  • Import certificates (and private keys) into the current default keychain. Use the create_keychain action to create a new keychain.

    Parameters

    Returns Promise<any>

importFromGit

  • This is useful if you have shared lanes across multiple apps and you want to store the Fastfile in a remote git repository.

    Parameters

    Returns Promise<any>

incrementBuildNumber

incrementVersionNumber

installOnDevice

  • Installs the ipa on the device. If no id is given, the first found iOS device will be used. Works via USB or Wi-Fi. This requires ios-deploy to be installed. Please have a look at ios-deploy. To quickly install it, use brew install ios-deploy

    Parameters

    Returns Promise<any>

installProvisioningProfile

installXcodePlugin

installr

ipa

isCi

  • The return value of this method is true if fastlane is currently executed on Travis, Jenkins, Circle or a similar CI service

    Parameters

    Returns Promise<any>

isDebug

  • isDebug(): boolean
  • Returns boolean

jazzy

jira

  • Leave a comment on a Jira ticket

    Parameters

    Returns Promise<any>

    A hash containing all relevant information of the Jira comment Access Jira comment 'id', 'author', 'body', and more

laneContext

lastGitCommit

  • Return last git commit hash, abbreviated commit hash, commit message and author

    Parameters

    Returns Promise<any>

    Returns the following dict: {commit_hash: "commit hash", abbreviated_commit_hash: "abbreviated commit hash" author: "Author", author_email: "author email", message: "commit message"} (ex: [object Object])

lastGitTag

  • If you are using this action on a shallow clone, the default with some CI systems like Bamboo, you need to ensure that you have also pulled all the git tags appropriately. Assuming your git repo has the correct remote set you can issue sh('git fetch --tags'). Pattern parameter allows you to filter to a subset of tags.

    Parameters

    Returns Promise<string>

latestTestflightBuildNumber

  • Provides a way to have increment_build_number be based on the latest build you uploaded to iTC. Fetches the most recent build number from TestFlight based on the version number. Provides a way to have increment_build_number be based on the latest build you uploaded to iTC.

    Parameters

    Returns Promise<any>

    Integer representation of the latest build number uploaded to TestFlight (ex: 2)

lcov

log

  • log(...args: any): void
  • Parameters

    • Rest ...args: any

    Returns void

mailgun

makeChangelogFromJenkins

match

matchNuke

  • Use the match_nuke action to revoke your certificates and provisioning profiles. Don't worry, apps that are already available in the App Store / TestFlight will still work. Builds distributed via Ad Hoc or Enterprise will be disabled after nuking your account, so you'll have to re-upload a new build. After clearing your account you'll start from a clean state, and you can run match to generate your certificates and profiles again. More information: https://docs.fastlane.tools/actions/match/

    Parameters

    Returns Promise<any>

minFastlaneVersion

  • Add this to your Fastfile to require a certain version of fastlane. Use it if you use an action that just recently came out and you need it.

    Parameters

    Returns Promise<any>

modifyServices

nexusUpload

notarize

notification

notify

numberOfCommits

  • You can use this action to get the number of commits of this branch. This is useful if you want to set the build number to the number of commits. See fastlane actions number_of_commits for more details.

    Parameters

    Returns Promise<any>

    The total number of all commits in current git branch

oclint

  • Run the static analyzer tool OCLint for your project. You need to have a compile_commands.json file in your fastlane directory or pass a path to your file.

    Parameters

    Returns Promise<any>

onesignal

  • You can use this action to automatically create or update a OneSignal application. You can also upload a .p12 with password, a GCM key, or both.

    Parameters

    Returns Promise<any>

optOutCrashReporting

optOutUsage

pem

  • Additionally to the available options, you can also specify a block that only gets executed if a new profile was created. You can use it to upload the new profile to your server. Use it like this:| |

    ```ruby| get_push_certificate(| new_profile: proc do|

    your upload code|

    end| )|

    ```|

    |

    Parameters

    Returns Promise<any>

pilot

podLibLint

  • Test the syntax of your Podfile by linting the pod against the files of its directory

    Parameters

    Returns Promise<any>

podPush

podioItem

precheck

println

produce

prompt

  • You can use prompt to ask the user for a value or to just let the user confirm the next step. When this is executed on a CI service, the passed ci_input value will be returned. This action also supports multi-line inputs using the multi_line_end_keyword option.

    Parameters

    Returns Promise<string>

pushGitTags

  • If you only want to push the tags and nothing else, you can use the push_git_tags action

    Parameters

    Returns Promise<any>

pushToGitRemote

  • Lets you push your local commits to a remote git repo. Useful if you make local changes such as adding a version bump commit (using commit_version_bump) or a git tag (using 'add_git_tag') on a CI server, and you want to push those changes back to your canonical/main repo. If this is a new branch, use the set_upstream option to set the remote branch as upstream.

    Parameters

    Returns Promise<any>

puts

readPodspec

  • This can be used for only specifying a version string in your podspec - and during your release process you'd read it from the podspec by running version = read_podspec['version'] at the beginning of your lane. Loads the specified (or the first found) podspec in the folder as JSON, so that you can inspect its version, files etc. This can be useful when basing your release process on the version string only stored in one place - in the podspec. As one of the first steps you'd read the podspec and its version and the rest of the workflow can use that version string (when e.g. creating a new git tag or a GitHub Release).

    Parameters

    Returns Promise<any>

recreateSchemes

registerDevice

  • This will register an iOS device with the Developer Portal so that you can include it in your provisioning profiles. This is an optimistic action, in that it will only ever add a device to the member center. If the device has already been registered within the member center, it will be left alone in the member center. The action will connect to the Apple Developer Portal using the username you specified in your Appfile with apple_id, but you can override it using the :username option.

    Parameters

    Returns Promise<string>

registerDevices

  • This will register iOS/Mac devices with the Developer Portal so that you can include them in your provisioning profiles. This is an optimistic action, in that it will only ever add new devices to the member center, and never remove devices. If a device which has already been registered within the member center is not passed to this action, it will be left alone in the member center and continue to work. The action will connect to the Apple Developer Portal using the username you specified in your Appfile with apple_id, but you can override it using the username option, or by setting the env variable ENV['DELIVER_USER'].

    Parameters

    Returns Promise<any>

resetGitRepo

  • This action will reset your git repo to a clean state, discarding any uncommitted and untracked changes. Useful in case you need to revert the repo back to a clean state, e.g. after running fastlane. Untracked files like .env will also be deleted, unless :skip_clean is true. It's a pretty drastic action so it comes with a sort of safety latch. It will only proceed with the reset if this condition is met:| |

    • You have called the ensure_git_status_clean action prior to calling this action. This ensures that your repo started off in a clean state, so the only things that will get destroyed by this action are files that are created as a byproduct of the fastlane run.| |

    Parameters

    Returns Promise<any>

resetSimulatorContents

resign

restoreFile

rocket

  • Print an ascii Rocket :rocket:. Useful after using crashlytics or pilot to indicate that your new build has been shipped to outer-space.

    Parameters

    Returns Promise<string>

rsync

  • A wrapper around rsync, which is a tool that lets you synchronize files, including permissions and so on. For a more detailed information about rsync, please see rsync(1) man page.

    Parameters

    Returns Promise<any>

rubyVersion

  • Add this to your Fastfile to require a certain version of ruby. Put it at the top of your Fastfile to ensure that fastlane is executed appropriately.

    Parameters

    Returns Promise<any>

runTests

s3

  • Upload a new build to Amazon S3 to distribute the build to beta testers. Works for both Ad Hoc and Enterprise signed applications. This step will generate the necessary HTML, plist, and version files for you. It is recommended to not store the AWS access keys in the Fastfile. The uploaded version.json file provides an easy way for apps to poll if a new update is available.

    Parameters

    Returns Promise<any>

say

scan

scp

screengrab

send

  • send(__namedParameters: { command: {}; commandType: string }): Promise<any>
  • Parameters

    • __namedParameters: { command: {}; commandType: string }
      • command: {}
      • commandType: string

    Returns Promise<any>

setBuildNumberRepository

  • This action will set the build number according to what the SCM HEAD reports. Currently supported SCMs are svn (uses root revision), git-svn (uses svn revision) and git (uses short hash) and mercurial (uses short hash or revision number). There is an option, :use_hg_revision_number, which allows to use mercurial revision number instead of hash.

    Parameters

    Returns Promise<any>

setChangelog

  • This is useful if you have only one changelog for all languages. You can store the changelog in ./changelog.txt and it will automatically get loaded from there. This integration is useful if you support e.g. 10 languages and want to use the same "What's new"-text for all languages. Defining the version is optional. fastlane will try to automatically detect it if you don't provide one.

    Parameters

    Returns Promise<any>

setDebug

  • setDebug(newValue?: boolean): void
  • Parameters

    • Optional newValue: boolean

    Returns void

setGithubRelease

  • Creates a new release on GitHub. You must provide your GitHub Personal token (get one from https://github.com/settings/tokens/new), the repository name and tag name. By default, that's master. If the tag doesn't exist, one will be created on the commit or branch passed in as commitish. Out parameters provide the release's id, which can be used for later editing and the release HTML link to GitHub. You can also specify a list of assets to be uploaded to the release with the :upload_assets parameter.

    Parameters

    Returns Promise<any>

    A hash containing all relevant information of this release Access things like 'html_url', 'tag_name', 'name', 'body'

setInfoPlistValue

setPodKey

setupCi

    • Creates a new temporary keychain for use with match|
    • Switches match to readonly mode to not create new profiles/cert on CI|
    • Sets up log and test result paths to be easily collectible|

      | This action helps with CI integration. Add this to the top of your Fastfile if you use CI.

    Parameters

    Returns Promise<any>

setupCircleCi

    • Creates a new temporary keychain for use with match|
    • Switches match to readonly mode to not create new profiles/cert on CI|
    • Sets up log and test result paths to be easily collectible|

      | This action helps with CircleCI integration. Add this to the top of your Fastfile if you use CircleCI.

    Parameters

    Returns Promise<any>

setupJenkins

    • Adds and unlocks keychains from Jenkins 'Keychains and Provisioning Profiles Plugin'|
    • Sets unlocked keychain to be used by Match|
    • Sets code signing identity from Jenkins 'Keychains and Provisioning Profiles Plugin'|
    • Sets output directory to './output' (gym, scan and backup_xcarchive)|
    • Sets derived data path to './derivedData' (xcodebuild, gym, scan and clear_derived_data, carthage)|
    • Produce result bundle (gym and scan)|

      | This action helps with Jenkins integration. Creates own derived data for each job. All build results like IPA files and archives will be stored in the ./output directory. The action also works with Keychains and Provisioning Profiles Plugin, the selected keychain will be automatically unlocked and the selected code signing identity will be used. Match will be also set up to use the unlocked keychain and set in read-only mode, if its environment variables were not yet defined. By default this action will only work when fastlane is executed on a CI system.

    Parameters

    Returns Promise<any>

setupTravis

    • Creates a new temporary keychain for use with match|
    • Switches match to readonly mode to not create new profiles/cert on CI|

      | This action helps with Travis integration. Add this to the top of your Fastfile if you use Travis.

    Parameters

    Returns Promise<any>

sh

  • Allows running an arbitrary shell command. Be aware of a specific behavior of sh action with regard to the working directory. For details, refer to Advanced.

    Parameters

    Returns Promise<string>

    Outputs the string and executes it. When running in tests, it returns the actual command instead of executing it

sigh

  • Note*: It is recommended to use match according to the codesigning.guide for generating and maintaining your provisioning profiles. Use sigh directly only if you want full control over what's going on and know more about codesigning.

    Parameters

    Returns Promise<string>

    The UUID of the profile sigh just fetched/generated

skipDocs

  • Tell fastlane to not automatically create a fastlane/README.md when running fastlane. You can always trigger the creation of this file manually by running fastlane docs.

    Parameters

    Returns Promise<any>

slack

  • Create an Incoming WebHook and export this as SLACK_URL. Can send a message to #channel (by default), a direct message to @username or a message to a private group group with success (green) or failure (red) status.

    Parameters

    Returns Promise<any>

slather

snapshot

sonar

sourcedocs

spaceshipLogs

spaceshipStats

splunkmint

spm

ssh

  • Lets you execute remote commands via ssh using username/password or ssh-agent. If one of the commands in command-array returns non 0, it fails.

    Parameters

    Returns Promise<any>

start

  • start(): Promise<void>
  • Returns Promise<void>

supply

swiftlint

syncCodeSigning

teamId

teamName

testfairy

testflight

trainer

  • Convert the Xcode plist log to a JUnit report

    Parameters

    Returns Promise<any>

    A hash with the key being the path of the generated file, the value being if the tests were successful

tryouts

twitter

typetalk

unlockKeychain

  • Unlocks the given keychain file and adds it to the keychain search list. Keychains can be replaced with add_to_search_list: :replace.

    Parameters

    Returns Promise<any>

updateAppGroupIdentifiers

  • Updates the App Group Identifiers in the given Entitlements file, so you can have app groups for the app store build and app groups for an enterprise build.

    Parameters

    Returns Promise<any>

updateAppIdentifier

  • Update an app identifier by either setting CFBundleIdentifier or PRODUCT_BUNDLE_IDENTIFIER, depending on which is already in use.

    Parameters

    Returns Promise<any>

updateCodeSigningSettings

updateFastlane

  • This action will update fastlane to the most recent version - major version updates will not be performed automatically, as they might include breaking changes. If an update was performed, fastlane will be restarted before the run continues.

    If you are using rbenv or rvm, everything should be good to go. However, if you are using the system's default ruby, some additional setup is needed for this action to work correctly. In short, fastlane needs to be able to access your gem library without running in sudo mode.

    The simplest possible fix for this is putting the following lines into your ~/.bashrc or ~/.zshrc file:| |

    export GEM_HOME=~/.gems|
    export PATH=$PATH:~/.gems/bin|
    ```|
    >|
    After the above changes, restart your terminal, then run `mkdir $GEM_HOME` to create the new gem directory. After this, you're good to go!
    
    Recommended usage of the `update_fastlane` action is at the top inside of the `before_all` block, before running any other action.

    Parameters

    Returns Promise<any>

updateIcloudContainerIdentifiers

updateInfoPlist

  • This action allows you to modify your Info.plist file before building. This may be useful if you want a separate build for alpha, beta or nightly builds, but don't want a separate target.

    Parameters

    Returns Promise<any>

updateKeychainAccessGroups

  • Updates the Keychain Group Access Groups in the given Entitlements file, so you can have keychain access groups for the app store build and keychain access groups for an enterprise build.

    Parameters

    Returns Promise<any>

updatePlist

updateProjectCodeSigning

updateProjectProvisioning

  • You should check out the code signing guide before using this action. This action retrieves a provisioning profile UUID from a provisioning profile (.mobileprovision) to set up the Xcode projects' code signing settings in *.xcodeproj/project.pbxproj. The :target_filter value can be used to only update code signing for the specified targets. The :build_configuration value can be used to only update code signing for the specified build configurations of the targets passing through the :target_filter. Example usage is the WatchKit Extension or WatchKit App, where you need separate provisioning profiles. Example: update_project_provisioning(xcodeproj: "..", target_filter: ".*WatchKit App.*").

    Parameters

    Returns Promise<any>

updateProjectTeam

updateUrbanAirshipConfiguration

  • This action updates the AirshipConfig.plist needed to configure the Urban Airship SDK at runtime, allowing keys and secrets to easily be set for the Enterprise and Production versions of the application.

    Parameters

    Returns Promise<any>

updateUrlSchemes

  • This action allows you to update the URL schemes of the app before building it. For example, you can use this to set a different URL scheme for the alpha or beta version of the app.

    Parameters

    Returns Promise<any>

uploadAppPrivacyDetailsToAppStore

uploadSymbolsToCrashlytics

  • This action allows you to upload symbolication files to Crashlytics. It's extra useful if you use it to download the latest dSYM files from Apple when you use Bitcode. This action will not fail the build if one of the uploads failed. The reason for that is that sometimes some of dSYM files are invalid, and we don't want them to fail the complete build.

    Parameters

    Returns Promise<any>

uploadSymbolsToSentry

  • This action allows you to upload symbolication files to Sentry. It's extra useful if you use it to download the latest dSYM files from Apple when you use Bitcode.

    Parameters

    Returns Promise<any>

    The uploaded dSYM path(s)

uploadToAppStore

  • Using upload_to_app_store after build_app and capture_screenshots will automatically upload the latest ipa and screenshots with no other configuration.

    If you don't want to verify an HTML preview for App Store builds, use the :force option. This is useful when running fastlane on your Continuous Integration server: _upload_to_app_store_(force: true) If your account is on multiple teams and you need to tell the iTMSTransporter which 'provider' to use, you can set the :itc_provider option to pass this info.

    Parameters

    Returns Promise<any>

uploadToPlayStore

uploadToPlayStoreInternalAppSharing

uploadToTestflight

validatePlayStoreJsonKey

verifyBuild

  • Verifies that the built app was built using the expected build resources. This is relevant for people who build on machines that are used to build apps with different profiles, certificates and/or bundle identifiers to guard against configuration mistakes.

    Parameters

    Returns Promise<any>

verifyPodKeys

  • Runs a check against all keys specified in your Podfile to make sure they're more than a single character long. This is to ensure you don't deploy with stubbed keys.

    Parameters

    Returns Promise<any>

verifyXcode

versionBumpPodspec

  • You can use this action to manipulate any 'version' variable contained in a ruby file. For example, you can use it to bump the version of a CocoaPods' podspec file. It also supports versions that are not semantic: 1.4.14.4.1. For such versions, there is an option to change the appendix (e.g. 4.1).

    Parameters

    Returns Promise<any>

versionGetPodspec

xcarchive

xcbuild

xcclean

xcexport

xcodeInstall

  • Makes sure a specific version of Xcode is installed. If that's not the case, it will automatically be downloaded by the xcode_install gem. This will make sure to use the correct Xcode for later actions.

    Parameters

    Returns Promise<string>

    The path to the newly installed Xcode version

xcodeSelect

  • Select and build with the Xcode installed at the provided path. Use the xcodes action if you want to select an Xcode:

    • Based on a version specifier or
    • You don't have known, stable paths, as may happen in a CI environment.

    Parameters

    Returns Promise<any>

xcodeServerGetAssets

  • This action downloads assets from your Xcode Server Bot (works with Xcode Server using Xcode 6 and 7. By default, this action downloads all assets, unzips them and deletes everything except for the .xcarchive. If you'd like to keep all downloaded assets, pass keep_all_assets: true. This action returns the path to the downloaded assets folder and puts into shared values the paths to the asset folder and to the .xcarchive inside it.

    Parameters

    Returns Promise<any>

xcodebuild

  • Note*: xcodebuild is a complex command, so it is recommended to use gym for building your ipa file and scan for testing your app instead.

    Parameters

    Returns Promise<any>

xcodes

  • Makes sure a specific version of Xcode is installed. If that's not the case, it will automatically be downloaded by xcodes. This will make sure to use the correct Xcode version for later actions. Note that this action depends on xcodes CLI, so make sure you have it installed in your environment. For the installation guide, see: https://github.com/RobotsAndPencils/xcodes#installation

    Parameters

    Returns Promise<string>

    The path to the newly installed Xcode version

xcov

xctest

xctool

xcversion

zip

  • Compress a file or folder to a zip

    Parameters

    Returns Promise<string>

    The path to the output zip file

Legend

  • Inherited constructor
  • Inherited method
  • Method

Generated using TypeDoc