step definition update (#42)

Author: godrei

step.yml

@@ -1,28 +1,14 @@
-title: "Deploy to iTunes Connect / TestFlight (with Deliver)"
-summary: Upload the archive to iTunes Connect / TestFlight and you can also submit it for review.
+title: "Deploy to iTunes Connect"
+summary: Upload screenshots, metadata and binaries to [iTunes Connect](https://itunesconnect.apple.com/) and submit your app for App Store review.
 description: |-
-  Deploy to iTunes Connect / TestFlight, using the
-  fantastic [Deliver](https://github.com/fastlane/fastlane/tree/master/deliver)
-  Ruby gem.
-
-  **If this is the very first build** of the app
-  you try to deploy to iTunes Connect / TestFlight then you might want to upload the first
-  build manually to make sure it fulfills the initial iTunes Connect / TestFlight submission
-  verification process.
-
-  **Be advised** that this
-  step uses a well maintained, open source tool which
-  uses *undocumented and unsupported APIs* (because the current
-  iTunes Connect / TestFlight platform does not have a documented and supported API)
-  to perform the deployment.
-  This means that when the API changes
-  **this step might fail until the tool is updated**.
-
-  ## Setup guide and notes
-
-  * Register an app on iTunes Connect / TestFlight, on the **My Apps** page. Click on the *plus sign* and select the **New App** option. This requires an **admin** account.
-  * Requires an **App Store iOS distibution Provisioning Profile**
-  * Every build which you want to push to iTunes Connect / TestFlight have to have a **unique build and version number** pair (*increment either or both before a new deploy to iTunes Connect*)
+  Upload screenshots, metadata and binaries to [iTunes Connect](https://itunesconnect.apple.com/) and submit your app for App Store review, 
+  using the fantastic [deliver](https://docs.fastlane.tools/actions/deliver/) fastlane action.
+
+  Setup guide and notes:
+
+  * Register an app on iTunes Connect, on the **My Apps** page. Click on the *plus sign* and select the **New App** option. This requires an **admin** account.
+  * Requires an app signed with **App Store iOS distibution Provisioning Profile**.
+  * Every build which you want to push to iTunes Connect have to have a **unique build and version number** pair (*increment either or both before a new deploy to iTunes Connect*).
 website: https://github.com/bitrise-io/steps-deploy-to-itunesconnect-deliver
 source_code_url: https://github.com/bitrise-io/steps-deploy-to-itunesconnect-deliver
 support_url: https://github.com/bitrise-io/steps-deploy-to-itunesconnect-deliver/issues
@@ -53,75 +39,83 @@ inputs:
   - ipa_path: "$BITRISE_IPA_PATH"
     opts:
       title: "IPA path"
-      summary: ""
       description: |-
-        Path of the IPA file, to be deployed to iTunes Connect
+        Path to your IPA file, to be deployed.
+
+        **NOTE:** This input or `PKG path` is required.
   - pkg_path: "$BITRISE_PKG_PATH"
     opts:
       title: "PKG path"
-      summary: ""
       description: |-
-        Path of the PKG file, to be deployed to iTunes Connect
+        Path to your PKG file, to be deployed.
+
+        **NOTE:** This input or `IPA path` is required.
+  - platform: "ios"
+    opts:
+      title: "Platform"
+      description: The platform will be delivered to iTunes Connect.
+      is_required: true
+      value_options:
+      - "ios"
+      - "osx"
+      - "appletvos"
   - itunescon_user: ""
     opts:
-      title: "iTunes Connect: User Apple ID (email)"
-      summary: ""
-      description: |-
-        Login Apple ID (email) for the iTunes Connect site.
-
-        *Make sure that this email is verified,
-        your Apple ID cannot be used until you verify it
-        on Apple's website!*
+      title: "Apple ID"
+      description: Login Apple ID for the iTunes Connect site.
       is_required: true
   - password: ""
     opts:
-      title: "iTunes Connect: Password"
-      summary: ""
-      description: |-
-        Password for the specified User Apple ID.
-
-        **Note:** if your password
-        contains special characters
-        and you experience problems, please
-        consider changing your password
-        to something with only
-        alphanumeric characters.
+      title: "Password"
+      description: Password for the specified Apple ID.
       is_required: true
   - app_password: ""
     opts:
-      title: "iTunes Connect: Application Specific Password"
-      summary: ""
+      title: "Application Specific Password"
       description: |-
-        an Application specific password for the Apple ID.
+        An Application specific password for the Apple ID.
 
-        **Note:** Application specific passwords can be created on the
+        **NOTE:** Application specific passwords can be created on the
         [AppleID Website](https://appleid.apple.com). It can be used to
         surpass Two Factor Authentication.
       is_required: false
+  - team_id: ""
+    opts:
+      title: "Team ID"
+      description: |-
+        The App's *Team ID* on iTunes Connect.
+
+        **NOTE:** This field or `Team name` is required when using iTunes Connect account
+        linked to multiple publish team.
+  - team_name: ""
+    opts:
+      title: "Team name"
+      description: |-
+        The App's *Team Name* on iTunes Connect.
+
+        **NOTE:** This field or `Team ID` is required when using iTunes Connect account
+        linked to multiple publish team.
   - app_id: ""
     opts:
-      title: "iTunes Connect: App Apple ID"
-      summary: ""
+      title: "App Apple ID"
       description: |-
         The App's *Apple ID* on iTunes Connect.
 
-        This input or `bundle_id` is required
+        **NOTE:** This input or `App Bundle ID` is required.
 
-        Open the **App's page on iTunes Connect**,
-        click on **App Information**, scroll down to the *General Information* section,
-        copy the *Apple ID*'s value from here (numeric, like 846814360)
+        Open the **App's page on iTunes Connect**, click on **App Information**,
+        scroll down to the *General Information* section,
+        copy the *Apple ID*'s value from here (numeric, like 846814360).
   - bundle_id: ""
     opts:
-      title: "iTunes Connect: App Bundle ID"
-      summary: ""
+      title: "App Bundle ID"
       description: |-
         The App's *Bundle ID* on iTunes Connect.
 
-        This input or app_id is required
+        **NOTE:** This input or `App Apple ID` is required.
   - submit_for_review: "no"
     opts:
       title: "Submit for Review?"
-      summary: ""
       description: |
         Wait for the submission to be processed and then
         submit the app for review for this specific version?
@@ -139,87 +133,49 @@ inputs:
         to iTunes Connect and only the review submission failed.
       value_options: ["yes", "no"]
       is_required: true
-      is_expand: false
   - skip_metadata: "yes"
     opts:
       title: "Skip Metadata?"
-      summary: ""
-      description: |
-        Flag to skip uploading the appstore metadata.
+      description: Don't upload the metadata. This will still upload screenshots.
       value_options: ["yes", "no"]
       is_required: true
-      is_expand: false
   - skip_screenshots: "yes"
     opts:
       title: "Skip Screenshots?"
-      summary: ""
-      description: |
-        Flag to skip uploading changes to appstore screenshots.
+      description: Don't upload the screenshots.
       value_options: ["yes", "no"]
       is_required: true
-      is_expand: false
-  - team_id: ""
-    opts:
-      title: "iTunes Connect: Team ID"
-      summary: ""
-      description: |-
-        The App's *Team ID* on iTunes Connect.
-
-        This field is required when using iTunes Connect account
-        linked to multiple publish team.
-
-        Use this input or `team_name` to specify the team.
-  - team_name: ""
+  - gemfile_path: ./Gemfile
     opts:
-      title: "iTunes Connect: Team name"
-      summary: ""
-      description: |-
-        The App's *Team Name* on iTunes Connect.
-
-        This field is required when using iTunes Connect account
-        linked to multiple publish team.
+      category: Debug
+      title: "Gemfile path"
+      description: |
+        Path to the `Gemfile` which contains `fastlane` gem.
 
-        Use this input or `team_id` to specify the team.
-  - platform: "ios"
+        If `Gemfile` not exist or does not contain fastlane gem and 
+        if `fastlane version` input not specified, latest fastlen version will be used.
+  - fastlane_version: "latest"
     opts:
-      title: "Platform"
-      summary: ""
+      category: Debug
+      title: "fastlane version"
       description: |-
-        The platform will be delivered to iTunes Connect.
-      is_required: true
-      value_options:
-      - "ios"
-      - "osx"
-      - "appletvos"
+        This option lets you specify a specific version of the `fastlane` gem to be installed.
   - options:
     opts:
+      category: Debug
       title: " Additional options for `deliver` call"
-      summary: ""
       description: |-
         Options added to the end of the `deliver` call.
 
         If you want to add more options, list that separated by space character.
+        
         Example: `--skip_metadata --skip_screenshots`
-  - gemfile_path: ./Gemfile
-    opts:
-      title: "Gemfile path"
-      description: |
-        Path to the Gemfile which contains `fastlane` gem.
-
-        If Gemfile not exist or does not contain fastlane gem:
-
-        - if `fastlane_version` input not specified, latest version will be used
-  - fastlane_version: "latest"
-    opts:
-      title: "Fastlane version"
-      summary: "Install a specific version of the `fastlane` gem."
-      description: |-
-        This option lets you specify a specific version of the `fastlane` gem to be installed.
   - itms_upload_parameters: "-t DAV"
     opts:
-      title: "DELIVER_ITMSTRANSPORTER_ADDITIONAL_UPLOAD_PARAMETERS configuration"
-      summary: "Configure the protocol used to upload binaries"
+      category: Debug
+      title: "Transporter delivery method"
       description: |-
-        deliver uses the iTunes Transporter to upload metadata and binaries. This variable allows you to change the protocol variables used to upload the files.
+        `deliver` uses the iTunes Transporter to upload metadata and binaries.  
+        In case you are behind a firewall, you can specify a different transporter protocol using this input.
 
-outputs: []
+        Read more on Apple [Transporter User Guide](https://help.apple.com/itc/transporteruserguide/#/apdATD1E1288-D1E1A1303-D1E1288A1126).