Uploads binaries (.ipa / .pkg files) to App Store Connect.
Description
Upload your binaries to App Store Connect using Apple's Application Loader. You can upload iOS, macOS, or Apple TV apps with the Step. The Step does not upload metadata, screenshots, nor does it submit your app for review. For that, use the Deploy to App Store Connect with Deliver Step.
This Step, however, does NOT build your binary: to create an IPA or PKG file, you need the right version of the Xcode Archive Step, or any other Step that is capable of building a binary file.
Before you start using this Step, you need to do a couple of things:
- Register an app on the My Apps page of App Store Connect. Click on the plus sign and select the New App option. This requires an admin account.
- This Step requires an app signed with App Store Distibution provisioning profile. Make sure that you use the correct code signing files and the correct export method with the Step that builds your binary.
- Every build that you want to push to the App Store Connect must have a unique build and version number pair. Increment either or both before a new deploy to the App Store Connect.
To deploy your app with the Step:
- Make sure that either the IPA path or the PKG path input has a valid value. The default value is perfect for most cases: it points to the output generated by the Xcode Archive Step.
- Set up your connection depending on which authentication method you wish to use:
- Use a previously configured Bitrise Apple Developer connection: Set the Bitrise Apple Developer Connection to
automatic(this is the default setting),api_keyorapple_id. - Provide manual Step inputs: Add authentication data depending on which authentication method you wish to use, either Apple ID or API key authentication. Set the Bitrise Apple Developer Connection to
off. Use only one of the authentication methods.- For API key: Provide your API Key: URL (for example, https://URL/TO/AuthKey_something.p8 or file:///PATH/TO/AuthKey_something.p8) and the API Key: Issuer ID inputs.
- For Apple ID: Use the Apple Developer connection based on Apple ID authentication. If no app-specific password has been added to the used connection, the Apple ID: App-specific password Step input will be used. Other authentication-related Step inputs are ignored.
- Use a previously configured Bitrise Apple Developer connection: Set the Bitrise Apple Developer Connection to
Use only one of the authentication methods, if you add both the Apple ID and the API key inputs the step will fail.
Make sure your Apple ID credentials are correct. Be aware that if you use two-factor authentication, you need to set up a connection with Apple ID.
Always make sure that Platform input is set to the correct value.
The Step can also fail if the Xcode Archive Step - or any other Step that builds your binary - did not generate an IPA or PKG with a app-store export method.
Add this step directly to your workflow in the Bitrise Workflow Editor.
You can also run this step directly with Bitrise CLI.
Inputs
| Key | Description | Flags | Default |
|---|---|---|---|
connection |
The input determines the method used for Apple Service authentication. By default, any enabled Bitrise Apple Developer connection is used and other authentication-related Step inputs are ignored. There are two types of Apple Developer connection you can enable on Bitrise: one is based on an API key of the App Store Connect API, the other is the Apple ID authentication. You can choose which type of Bitrise Apple Developer connection to use or you can tell the Step to only use Step inputs for authentication: - automatic: Use any enabled Apple Developer connection, either based on Apple ID authentication or API key authentication. Step inputs are only used as a fallback. API key authentication has priority over Apple ID authentication in both cases. - api_key: Use the Apple Developer connection based on API key authentication. Authentication-related Step inputs are ignored. - apple_id: Use the Apple Developer connection based on Apple ID authentication and the Application-specific password Step input. Other authentication-related Step inputs are ignored. - off: Do not use any Apple Developer Connection. Only authentication-related Step inputs are considered. |
required | automatic |
api_key_path |
Specify the path in an URL format where your API key is stored. For example: https://URL/TO/AuthKey_[KEY_ID].p8 or file:///PATH/TO/AuthKey_[KEY_ID].p8. NOTE: The Step will only recognize the API key if the filename includes the KEY_ID value as shown on the examples above. You can upload your key on the Generic File Storage tab in the Workflow Editor and set the Environment Variable for the file here. For example: $BITRISEIO_MYKEY_URL |
||
api_issuer |
Issuer ID. Required if API Key: URL (api_key_path) is specified. |
||
itunescon_user |
Email for Apple ID login. | sensitive | |
password |
Password for the specified Apple ID. | sensitive | |
app_password |
Use this input if TFA is enabled on the Apple ID but no app-specific password has been added to the used Bitrise Apple ID connection. NOTE: Application-specific passwords can be created on the AppleID Website. It can be used to bypass two-factor authentication. | sensitive | |
ipa_path |
Path to your IPA file to be deployed. NOTE: This input or PKG path is required. |
$BITRISE_IPA_PATH |
|
pkg_path |
Path to your PKG file to be deployed. NOTE: This input or IPA path is required. |
$BITRISE_PKG_PATH |
|
platform |
Specify the platform of the file. When auto is selected the step uses the Info.plist to set the platform. |
auto |
|
retries |
Retry times when failed, set to 0 for infinite retry |
10 |
|
altool_options |
Options added to the end of the altool call. You can use multiple options, separated by a space character. Example: --notarize-app --asc-provider" <<provider_id>> |
Outputs
There are no outputs defined in this stepWe welcome pull requests and issues against this repository.
For pull requests, work on your changes in a forked repository and use the Bitrise CLI to run step tests locally.
Learn more about developing steps: