Skip to content

Commit

Permalink
Description language review (#97)
Browse files Browse the repository at this point in the history
* Description language review
Co-authored-by: Krisztián Gödrei <[email protected]>
  • Loading branch information
lpusok authored Feb 4, 2021
1 parent 2e32340 commit c91fdc7
Showing 1 changed file with 8 additions and 9 deletions.
17 changes: 8 additions & 9 deletions step.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ description: |-
To deploy your app with the Step:
1. 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.
1. Set up your connection depending on which authentication method you wish to use:
- Use a previously set up Bitrise Apple Developer Connection, set the **Bitrise Apple Developer Connection** to `automatic` (default), `api_key` or `apple_id`.
- Provide manual step inputs, either with Apple ID or with the App Store Connet API key. Set the **Bitrise Apple Developer Connection** to `off`. Use only one of the authentication methods.
* For the Apple ID: Fill out the **Apple ID: Email**, **Apple ID: Password**. Add the **Apple ID: Application specific password** if you wish to bypass two-factor authentication.
* For the App Store Connect API: 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. Please note that connecting with the App Store Connect API works with XCode 11.0 and above releases.
- Use a previously set up Bitrise Apple Developer connection, set the **Bitrise Apple Developer Connection** to `automatic` (this is the default setting), `api_key` or `apple_id`.
- Provide manual Step inputs: either with Apple ID or with the App Store Connet API key. 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: *Apple IDs with 2FA are not supported.* Fill out the **Apple ID: Email** and the **Apple ID: Password** inputs.
1. To identify the app, set either the **App Store Connect App ID** or the **App Bundle ID**. Note that while neither is marked as **Required**, one of the two MUST have a valid value.
1. If you want to immediately submit your app for an App Store review, set the **Submit for Review?** input to `yes`. Please note that if you do submit the app for review, the Step will be successful only if the submission is accepted by App Store Connect.
Expand Down Expand Up @@ -78,11 +78,11 @@ inputs:
description: |-
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 legacy method of session-based authentication with an Apple ID. 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:
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 legacy method of session-based authentication with an Apple ID. You can choose which type of Bitrise Apple Developer connection to use or you can tell the Step to only use the 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 **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.
- `off`: Do not use any already configured Apple Developer Connection. Only authentication-related Step inputs are considered.
is_required: true
value_options:
- "automatic"
Expand All @@ -95,11 +95,10 @@ inputs:
summary: Path to local or remote file
description: |-
Specify the path in an URL format where your API key is stored.
For example: `https://URL/TO/AuthKey_something.p8` or `file:///PATH/TO/AuthKey_something.p8`.
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: `https://URL/TO/AuthKey_something.p8` or `file:///PATH/TO/AuthKey_something.p8`.
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: ""
Expand Down

0 comments on commit c91fdc7

Please sign in to comment.