step.yml

title: "TestFairy Deploy"
summary: Deploy your App to TestFairy.
description: |-
  Deploy your awesome App to Testfairy easily, making use of multiple configuration options.
  
  * Set tester groups to be notified
  * Enable email notification for the build
  * Enable in-app notification of new versions
  * Set recording duration
  * Enable or disable video recording
  * Add your comments
  
  Once you're done setting up, you can simply let TestFairy do its magic!
  
  To use this step you have to register
  an account on [TestFairy.com](http://testfairy.com/).

website: https://github.com/bitrise-steplib/steps-testfairy-deploy
source_code_url: https://github.com/bitrise-steplib/steps-testfairy-deploy
support_url: https://github.com/bitrise-steplib/steps-testfairy-deploy/issues

host_os_tags:
  - "osx-10.10"

project_type_tags:
  - ios
  - xamarin
  - react-native
  - cordova
  - ionic
  - flutter

type_tags:
  - "test"

is_requires_admin_user: false
is_always_run: false
is_skippable: false

inputs:
  - api_key: ""
    opts:
      title: TestFairy API key
      summary: TestFairy API key
      description: |-
        API key from TestFairy.


        **NOTE** You can find your API key under the settings menu.
      is_required: true
      is_sensitive: true
  - server_endpoint: ""
    opts:
      title: Private cloud endpoint
      summary: Private cloud endpoint for TestFairy
      description: |-
        If you are using a private cloud endpoint for TestFairy, specify it here
  - ipa_path: "$BITRISE_IPA_PATH"
    opts:
      title: IPA path
      summary: IPA path
      description: Path for the IPA to upload to TestFairy.
      is_required: true
  - dsym_path: "$BITRISE_DSYM_PATH"
    opts:
      title: dSYM path
      summary: dSYM path
      description: Path for the dSYM to upload to TestFairy.
  - tester_groups: ""
    opts:
      title: Tester groups
      summary: Tester groups
      description: |-
        Tester Groups that will be notified when the app is ready.
        Setup groups in your TestFairy account testers page.   
  - notify: "off"
    opts:
      title: Email notification
      summary: Email notification
      description: Sets if should email testers about new version.
      value_options:
        - "on"
        - "off"
  - auto_update: "off"
    opts:
      title: "Auto update"
      summary: ""
      description: |-
        If auto update is on all users will be prompt to update
        to this build next time they run the app.
      value_options:
        - "on"
        - "off"
  - max_test_duration: 10m
    opts:
      title: Recording duration
      summary: Recording duration
      description: Maximum session recording length, eg 20m or 1h. Maximum 24h.
  - video_recording: "off"
    opts:
      title: Video recording
      summary: Video recording
      description: Sets if video recording is enabled for this build.
      value_options:
        - "on"
        - "wifi"
        - "off"
  - comment: ""
    opts:
      title: Comments
      summary: Comments
      description: Comment text will be included in the email sent to testers.
outputs: 
  - TESTFAIRY_PUBLIC_INSTALL_PAGE_URL:
    opts:
      title: Public Install Page URL
      description: |-
        Public Install Page's URL