step.yml

title: Cordova archive
summary: Archives your Cordova project
description: |-
  Archives your Cordova project.

  First, the step prepare your Cordova project by calling either:

  - `cordova "platform" "rm" "<platform>"`
  - `cordova "platform" "add" "<platform>"`

  Or: 

  - `cordova "prepare" "<platform>"`

  Then it archives the project by calling:

  - `cordova "build" "--debug|--release" "--device|--emulator" "<platform>" "--buildConfig=$BITRISE_CORDOVA_BUILD_CONFIGURATION"`
website: https://github.com/bitrise-community/steps-cordova-archive
source_code_url: https://github.com/bitrise-community/steps-cordova-archive
support_url: https://github.com/bitrise-community/steps-cordova-archive/issues
project_type_tags:
- cordova
type_tags:
- build
deps:
  brew:
  - name: go
  - name: gradle
toolkit:
  go:
    package_name: github.com/bitrise-community/steps-cordova-archive
inputs:
  - platform: "ios,android"
    opts:
      title: "Platform to use in cordova-cli commands"
      description: |-
        Specify this input to apply cordova-cli commands to the desired platforms only.

        `cordova build [OTHER_PARAMS] <platform>`

      value_options:
      - "ios,android"
      - "ios"
      - "android"
      is_required: true
  - configuration: release
    opts:
      title: "Build command configuration"
      description: |-
        Specify build command configuration.

        `cordova build [OTHER_PARAMS] [--release | --debug]`
      value_options:
      - release
      - debug
      is_required: true
  - target: device
    opts:
      title: "Build command target"
      description: |-
        Specify build command target.

        `cordova build [OTHER_PARAMS] [--device | --emulator]`
      value_options:
      - device
      - emulator
      is_required: true
  - build_config: $BITRISE_CORDOVA_BUILD_CONFIGURATION
    opts:
      title: "Build configuration path to describe code signing properties"
      description: |-
        Path to the build configuration file (build.json), which describes code signing properties.
  - add_platform: "true"
    opts:
      title: "Should add platforms as part of the prepare step?"
      description: |-
        Specify whether to add platforms during prepare. If false, prepare command will be used instead.

        `cordova platform add <platform>` or `cordova prepare <platform>`
      value_options:
      - "true"
      - "false"
      is_required: true
  - readd_platform: "true"
    opts:
      title: "Should remove platforms as part of the prepare step?"
      description: |-
        Specify whether to remove platforms and then re-add (overwrites some config.xml values).

        Only applies if _"Should add platforms as prepare step?"_ is `true`.

        `cordova platform rm <platform>`
      value_options:
      - "true"
      - "false"
      is_required: true
  - cordova_version: 
    opts:
      title: "Cordova version"
      description: |-
        The version of cordova you want to use.

        If the value is set to `latest`, the step will update to the latest cordova version.
        Leave this input field empty to use the preinstalled cordova version.
  - workdir: $BITRISE_SOURCE_DIR
    opts:
      title: "Working directory"
      summary: ""
      description: |-
        Root directory of your Cordova project, where your Cordova config.xml exists.
      is_required: true
  - options:
    opts:
      title: "Options to append to the cordova-cli build command"
      description: |-
        Use this input to specify custom options, to append to the end of the cordova-cli build command.

        For Xcode 10 build issues add `--buildFlag="-UseModernBuildSystem=0"` to options string.

        Example:
        - `--browserify`

        `cordova build [OTHER_PARAMS] [options]`
outputs:
  - BITRISE_IPA_PATH:
    opts:
      title: The created ios .ipa file's path
  - BITRISE_APP_DIR_PATH:
    opts:
      title: The created ios .app dir's path
  - BITRISE_APP_PATH:
    opts:
      title: The created ios .app.zip file's path
  - BITRISE_DSYM_DIR_PATH:
    opts:
      title: The created ios .dSYM dir's path
  - BITRISE_DSYM_PATH:
    opts:
      title: The created ios .dSYM.zip file's path
  - BITRISE_APK_PATH: ""
    opts:
      title: The created android .apk file's path