step.yml

#
# A couple of useful guides & docs:
#
# - Main Bitrise CLI docs: https://github.com/bitrise-io/bitrise/tree/master/_docs
# - Step Development Guideline: https://github.com/bitrise-io/bitrise/blob/master/_docs/step-development-guideline.md
# - Bitrise.yml format spec: https://github.com/bitrise-io/bitrise/blob/master/_docs/bitrise-yml-format-spec.md
# - Bitrise docs: http://devcenter.bitrise.io/
# - Bitrise CLI guides: http://devcenter.bitrise.io/bitrise-cli/

title: |-
  [BETA] Firebase App Distribution
summary: |
  [BETA] Distributes your builds via Firebase App Distribution
description: |
  [BETA] Uploads your app binaries to Firebase and sends email to your testers.
website: https://github.com/guness/bitrise-step-firebase-app-distribution
source_code_url: https://github.com/guness/bitrise-step-firebase-app-distribution
support_url: https://github.com/guness/bitrise-step-firebase-app-distribution/issues

project_type_tags:
  - ios
  - android
  - xamarin
  - react-native
  - cordova
  - ionic
  - flutter
type_tags:
  - deploy

is_requires_admin_user: true
is_always_run: false
is_skippable: false
run_if: ""

toolkit:
  bash:
    entry_file: step.sh

inputs:
  - firebase_token:
    opts:
      title: Firebase Token
      description: |
        Firebase CI access token. You can create it by `firebase login:ci` on your local machine.

        It is something in the form of `1/a1gqPSI3r-RLgCQO47pJW7WdmqdypiJMO`
      is_sensitive: true
  - service_credentials_file:
    opts:
      title: Service Credentials File
      description: |
        The path or HTTP URL to your [service account](https://firebase.google.com/docs/app-distribution/android/distribute-gradle#authenticate_using_a_service_account) private key JSON file.
        Required only if you use service account authentication.
  - app_path: "$BITRISE_IPA_PATH|$BITRISE_APK_PATH|$BITRISE_AAB_PATH"
    opts:
      title: App Path
      description: |-
        Path of IPA, APK or AAB file to deploy.

        Default values:
        iOS: `$BITRISE_IPA_PATH`
        Android: `$BITRISE_APK_PATH|$BITRISE_AAB_PATH`
      is_required: true
  - app:
    opts:
      title: Firebase App ID
      description: |
        You can find the App ID in the Firebase console, on the [General Settings page](https://console.firebase.google.com/project/_/settings/general/).

        It is something in the form of:

        `1:1234567890:android:0a1b2c3d4e5f67890`
      is_required: true
  - release_notes:
    opts:
      title: Release Notes
      description: |
        Release notes for this build.
      is_required: false
  - release_notes_length:
    opts:
      title: Max Length for Release Notes
      description: |
        Maximum allowed length for release notes. Beyond that the notes will be trimmed in order to prevent a failure on firebase side.
      is_required: false
  - release_notes_file:
    opts:
      title: Release Notes File
      description: |
        Text file containing release notes for this build.
      is_required: false
  - testers:
    opts:
      title: Testers
      description: |
        The email addresses of the testers you want to invite.

        You can specify the testers as a comma-separated list of email addresses:

        `ali@example.com, bri@example.com, cal@example.com`
      is_required: false
  - groups:
    opts:
      title: Test Groups
      description: |
        The tester groups you want to invite (refer to [Manage testers](https://firebase.google.com/docs/app-distribution/manage-testers)).
        Groups are specified using group aliases, which you can look up in the Firebase console.

        You can specify the groups as a comma-separated list:

        `qa-team, trusted-testers`
      is_required: false
  - flags:
    opts:
      title: Additional Command Flags
      description: |
        Additional flags to be appended to Firebase command.
        ie. you can specify file inputs for groups, and testers.
      is_required: false
  - upgrade_firebase_tools: "false"
    opts:
      title: "Enable Firebase Tools Upgrade"
      summary: Firebase tools will be upgraded if enabled.
      description: Firebase tools will be upgraded if enabled.
      is_required: true
      value_options:
        - "false"
        - "true"
  - is_debug: "false"
    opts:
      category: Debug
      title: "Enable Debug Mode"
      summary: The step will print more verbose logs if enabled.
      description: The step will print more verbose logs if enabled.
      is_required: true
      value_options:
        - "false"
        - "true"

outputs:
  - FIREBASE_CONSOLE_URL:
    opts:
      title: Firebase Console URL
      summary: The firebase console URL of the deployed app
  - FIREBASE_APP_DISTRIBUTION_URL:
    opts:
      title: Firebase App Distribution URL
      summary: Share this release with testers who have access
  - FIREBASE_APP_DISTRIBUTION_RELEASE_ID: null
    opts:
      title: Firebase App Distribution Release ID
      summary: The Firebase App Distribution Release ID of the uploaded build.