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: |-
  API Build Trigger
summary: |
  Triggers a build using the Bitrise REST API.
description: |
  This step is meant to replace bitrise-step-trigger-bitrise-workflow which uses the deprecated app.bitrise.io endpoint.
website: https://github.com/peartherapeutics/bitrise-step-api-build-trigger
source_code_url: https://github.com/peartherapeutics/bitrise-step-api-build-trigger
support_url: https://github.com/peartherapeutics/bitrise-step-api-build-trigger/issues
host_os_tags:
  - osx-10.10
  - ubuntu-16.04

# If this step should be available only for certain project types
# just uncomment this `project_type_tags` section and include all the
# project types supported by the step. If the step can be used for all
# project types then you can just remove this section.
# If no `project_type_tags` specified (or specified as an empty array)
# that means the step can be used for any project type.
# You can find more information about project type tags in the Step Development Guideline:
# https://github.com/bitrise-io/bitrise/blob/master/_docs/step-development-guideline.md
#
# project_type_tags:
#   - ios
#   - macos
#   - android
#   - xamarin
#   - react-native
#   - cordova
#   - ionic

# Type tags are used for categorizing steps, for easier step discovery in Step Libraries.
# You can find more information about type tags in the Step Development Guideline:
# https://github.com/bitrise-io/bitrise/blob/master/_docs/step-development-guideline.md
type_tags:
  - build

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

deps:
  brew: []
  apt_get: []

toolkit:
  go:
    package_name: github.com/peartherapeutics/bitrise-step-api-build-trigger


inputs:
  - bitrise_api_token: "$BITRISE_API_TOKEN"
    opts:
      title: "Bitrise.io API Token"
      summary: Personal Access Token for bitrise.io API.
      description: |-
        Personal Access Token for bitrise.io API.

        See [The Authentication Article on the devcenter](https://devcenter.bitrise.io/api/authentication/) for instructions on how to obtain a token.
      is_expand: true
      is_required: true
      is_sensitive: true
  - triggered_app_slug: "$BITRISE_API_BUILD_TRIGGER_STEP_APP_SLUG"
    opts:
      title: "Triggered App Slug"
      summary: App slug for the build you want to trigger on bitrise.io.
      description: ""
      is_expand: true
      is_required: true
  - triggered_branch: "$BITRISE_API_BUILD_TRIGGER_STEP_BRANCH"
    opts:
      title: "Triggered Branch"
      summary: Branch name for the build you want to trigger.
      description: ""
      is_expand: true
      is_required: true
  - triggered_workflow: "$BITRISE_API_BUILD_TRIGGER_STEP_TRIGGERED_WORKFLOW"
    opts:
      title: "Triggered Workflow ID"
      summary: Workflow ID (name) you want to trigger. If empty, trigger map will be used instead.
      description: |-
        Workflow ID (name) you want to trigger. If empty, trigger map will be used instead.

        See [Setting a workflow for the build on devcenter](https://devcenter.bitrise.io/api/build-trigger/#setting-a-workflow-for-the-build).
      is_expand: true
      is_required: false
  - trigger_message: "$BITRISE_API_BUILD_TRIGGER_STEP_MESSAGE"
    opts:
      title: "Triggered Build Message"
      summary: Message for the build you want to trigger.
      description: ""
      is_expand: true
      is_required: false
  - verbose: "false"
    opts:
      title: Enable verbose logging
      summary: "Enable verbose log option for better debug"
      description: "Enable verbose log option for better debug"
      is_expand: true
      is_required: true
      value_options:
        - "true"
        - "false"

outputs:
  - BITRISE_API_BUILD_TRIGGER_STEP_RESULT_BUILD_SLUG:
    opts:
      title: "Resulting Build Slug"
      summary: Build slug of the triggered build.
      description: ""
  - BITRISE_API_BUILD_TRIGGER_STEP_RESULT_BUILD_NUMBER:
    opts:
      title: "Resulting Build Number"
      summary: Build number of the triggered build.
      description: ""
  - BITRISE_API_BUILD_TRIGGER_STEP_RESULT_BUILD_URL:
    opts:
      title: "Resulting Build URL"
      summary: URL of the triggered build.
      description: ""
  - BITRISE_API_BUILD_TRIGGER_STEP_RESULT_TRIGGERED_WORKFLOW:
    opts:
      title: "Resulting triggered workflow"
      summary: Workflow name that was triggered.
      description: ""