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: |-
  Add image overlay
summary: |
  Add icon to an image
description: |
  This step will add icon (on the left and/or right bottom side) on the source image.

  ### Usage

  To give to our step the information about the expected values:
  - Provide the source image's (or folder's) **path**, where we have the image or list of images on which we will add the icon(s)
    - You can provide just one image's path, the step will add icons to this one only
    - You can provide a folder's path where we many images, the step will add icons to them
  - Left **and/or** right icons which will be added on the source image

website: https://github.com/odemolliens/bitrise-step-image-overlayer
source_code_url: https://github.com/odemolliens/bitrise-step-image-overlayer
support_url: https://github.com/odemolliens/bitrise-step-image-overlayer/issues
host_os_tags:
  - osx-10.10
  - ubuntu-16.04
type_tags:
  - utility
is_requires_admin_user: false
is_always_run: true
is_skippable: false
toolkit:
  bash:
    entry_file: step.sh
inputs:
  - source_image: ""
    opts:
      title: "Source image or folder path"
      summary: "Source image or folder path?"
      description: |
        Source image's (or folder's) **path**, where we have the image or list of images on which we will add the icon(s)
          - You can provide just one image's path, the step will add icons to this one only (eg.: `./src/assets/app_icon.png`)
          - You can provide a folder's path where we many images, the step will add icons to them (eg.: `./src/assets/`)
      is_expand: true
      is_required: true
  - left_icon: ""
    opts:
      title: "Left icon's path"
      summary: "Left icon's path"
      description: "The path of the icon which will be added on the left side of the source image(s) (eg. `./src/assets/left_icon.png)"
      is_expand: true
      is_required: false
  - right_icon: ""
    opts:
      title: "Right icon's path"
      summary: "Right icon's path"
      description: "The path of the icon which will be added on the right side of the source image(s) (eg. `./src/assets/right_icon.png)"
      is_expand: true
      is_required: false
  - output_path: ""
    opts:
      title: "Output file's path"
      summary: "Output file's path"
      description: "Per default, the script will replace the original source image. If this key is provided, it will create a new one at this path. (eg. `./src/assets/result.png)"
      is_expand: true
      is_required: false
  - text_color: ""
    opts:
      title: "Text color (hexa color)"
      summary: "Text color (hexa color)"
      description: "If the left_icon and/or right_icon are not images, it will use this key to set the text color in image which will be generated (default: #FFFFFF)"
      is_expand: true
      is_required: false
  - center_icon: "False"
    opts:
      title: "If you want center the icon in the background image"
      summary: "If you want center the icoon in the background image"
      description: "If the value is true, the step will add a mask on full source image and center the left_icon at the middle of source image and the right_icon at the bottom right of the left_icon"
      is_expand: true
      is_required: false
      value_options:
        - "True"
        - "False"
  - archive_result: "True"
    opts:
      title: "If you want archive assets at the end"
      summary: "If you want archive assets at the end"
      description: "If the value is true, the step will compress the folder where we will place all ressources according to this step"
      is_expand: true
      is_required: false
      value_options:
        - "True"
        - "False"
  - export_results: "True"
    opts:
      title: "If you want export assets at the end"
      summary: "If you want export assets at the end"
      description: "If the value is true, the step will export the folder where we will place all ressources according to this step"
      is_expand: true
      is_required: false
      value_options:
        - "True"
        - "False"