step.yml

title: "Deploy to Bitrise.io - Apps, Logs, Artifacts"
summary: |-
  Generic artifacts deployer, attaches the artifacts to bitrise.io builds.
description: |-
  Generic artifacts deployer, attaches the artifacts to bitrise.io builds.

  You'll see the deployed files on bitrise.io, on the build's page,
  in the "Apps and Artifacts" section.
website: https://github.com/bitrise-io/steps-deploy-to-bitrise-io
source_code_url: https://github.com/bitrise-io/steps-deploy-to-bitrise-io
support_url: https://github.com/bitrise-io/steps-deploy-to-bitrise-io/issues
host_os_tags:
  - "osx-10.10"
project_type_tags: []
type_tags:
  - deploy
  - artifact
is_requires_admin_user: false
is_always_run: true
is_skippable: false
run_if: .IsCI
inputs:
  - deploy_path: "$BITRISE_DEPLOY_DIR"
    opts:
      title: "Deploy directory or file path"
      description: |
        Specify the directory or file path which will be deployed.
        If the specified path is a directory then every file
        in the directory will be deployed - but only the
        files in the specified directory, sub-directories
        won't be uploaded. For uploading the directory's content
        recursively you should use the *Compress* option
        which will compress the whole directory, with
        every sub-directory included.

        If you specify a file path then only the specified
        file will be deployed.
      is_required: true
  - is_compress: "false"
    opts:
      title: Compress the artifacts into one file?
      summary: |-
        If this option is allowed the artifacts
        found in the *Deploy directory* folder will be compressed
        into a single (ZIP) file.
      description: |-
        If this option is allowed the artifacts
        found in the *Deploy directory* folder will be compressed
        into a single file.

        If this option is turned off the artifacts
        found in the *Deploy directory* folder will be deployed
        separately.
      is_required: true
      is_expand: false
      value_options:
        - "true"
        - "false"
  - notify_user_groups: "everyone"
    opts:
      title: "Notify: User Groups"
      description: |
        Your App's user groups to notify, comma separated.
        Possible group names:

        * none
        * testers
        * developers
        * admins
        * owner
        * everyone

        An example to notify your developers and testers:

        `testers, developers`

        If you want to notify everyone in your team just specify `everyone`.

        If you don't want to notify anyone set this to `none`.
  - notify_email_list:
    opts:
      title: "Notify: Emails"
      description: |
        Email addresses to notify, comma separated.

        You can specify any email address, the recepients
        don't have to be in your team.
  - is_enable_public_page: "true"
    opts:
      title: "Enable public page for the App?"
      description: |
        If this option is enabled a public install page
        will be available with a long and random URL which can be shared
        with others who are not registered on Bitrise.

        **If you disable this option the Notify Emails option will
        be ignored and the Notify Groups will receive the build's
        URL instead of the public page's URL!**
      is_required: true
      is_expand: false
      value_options:
      - "true"
      - "false"
  - build_url: "$BITRISE_BUILD_URL"
    opts:
      title: "Bitrise Build URL"
      summary: |-
        Unique build URL of this build on Bitrise.io
      description: |-
        Unique build URL of this build on Bitrise.io
      is_required: true
      is_dont_change_value: true
  - build_api_token: "$BITRISE_BUILD_API_TOKEN"
    opts:
      title: Bitrise Build API Token
      summary: |-
        The build's API Token for the build on Bitrise.io
      description: |-
        The build's API Token for the build on Bitrise.io
      is_required: true
      is_dont_change_value: true
outputs:
  - BITRISE_PUBLIC_INSTALL_PAGE_URL:
    opts:
      title: Public Install Page URL
      description: |-
        Public Install Page's URL, if the
        *Enable public page for the App?* option was *enabled*.