step.yml

title: Project scanner
summary: Scans repository for iOS, macOS, Android, Fastlane, Cordova, Ionic, React Native and Flutter projects
description: |-
  This Step scans your repository to determine your project's type.

  The Step scans for:

  * **iOS** and **macOS** projects, the Step detects `CocoaPods` and scans Xcode project files for valid Xcode command line configurations.
  * **Android** projects, the Step checks for `build.gradle` files and lists all the Gradle tasks. It also checks for a `gradlew` file.
  * **Fastlane**, the Step detects `Fastfile` and lists the available lanes.
  * **Cordova** projects, the Step checks for the `config.xml` file.
  * **Ionic** projects, the Step checks for the `ionic.config.json` and `ionic.project` files.
  * **React Native** projects, the Step checks for `package.json` files and also runs the **iOS** and **Android** native project scanners.
  * **Flutter** projects, the Step checks for the `pubspec.yaml` files.

  ### Configuring the Step

  To successfully run the Step, you need:
  1. An SSH key
  1. A repository

  To configure the Step:

  1. **POST url to send the scan results to**: You can send your app's scan results to an URL as a POST request.
  1. **URL to get app icon candidates upload URLs**: You can upload your app's icons using this input.
  1. **Verbose log option**: You can set this input to `yes` to produce more informative logs.
  1. **Activate SSH key and clone git repo inside the Step**: You can set this input to `true` to activate an SSH key and clone the git repository of your app.

  ### Troubleshooting

  If you receive an error message, `No known platform detected`, make sure that you cloned the correct repository and you have a valid SSH key.

  ### Useful links

  * [Creating your own project scanner](https://devcenter.bitrise.io/en/steps-and-workflows/developing-your-own-bitrise-step/creating-your-own-bitrise-project-scanner.html)

website: https://github.com/bitrise-steplib/steps-project-scanner
source_code_url: https://github.com/bitrise-steplib/steps-project-scanner
support_url: https://github.com/bitrise-steplib/steps-project-scanner/issues
type_tags:
- utility
is_requires_admin_user: false
is_always_run: false
is_skippable: false
toolkit:
  go:
    package_name: github.com/bitrise-io/steps-project-scanner
inputs:
- scan_dir: $BITRISE_SOURCE_DIR
  opts:
    title: Directory to scan.
    description: The Step will look for the projects in this directory.
    is_required: true
- scan_result_submit_url: $BITRISE_SCAN_RESULT_POST_URL
  opts:
    title: POST url to send the scan results to
    description: |
       If provided, the scan results will be sent to the given
       URL, with a POST request.
    is_dont_change_value: true
- scan_result_submit_api_token: $BITRISE_APP_API_TOKEN
  opts:
    title: API Token for scan result submission
    description: |
       If provided and `scan_result_submit_url` also provided,
       this API Token will be used for sending the Scan Results.
    is_dont_change_value: true
    is_sensitive: true
- icon_candidates_url: $BITRISE_AVATAR_CANDIDATES_POST_URL
  opts:
    title: URL to get app icon candidates upload URLs
    description: |
      If provided, the app icons will be uploaded.
- verbose_log: "false"
  opts:
    title: Verbose log option
    description: |
      You can enable the verbose log for easier debugging.
    value_options:
    - "true"
    - "false"
- enable_repo_clone: "no"
  opts:
    title: Activate SSH key and clone git repo inside the Step
    description: |
      If set to yes then it will setup the SSH key (or HTTP credentials) and will clone the repo with the provided url and branch name.
    value_options:
    - "yes"
    - "no"
- ssh_rsa_private_key: $SSH_RSA_PRIVATE_KEY
  opts:
    title: SSH private key in RSA format
    description: SSH key to be used for the git clone.
    is_expand: true
    is_dont_change_value: true
    is_sensitive: true
- git_http_username: $GIT_HTTP_USERNAME
  opts:
    title: Username for establishing an HTTP(S) connection to the repository
    is_dont_change_value: true
    is_sensitive: true

- git_http_password: $GIT_HTTP_PASSWORD
  opts:
    title: Personal access token (or password) for establishing an HTTP(S) connection to the repository
    is_dont_change_value: true
    is_sensitive: true

- app_slug: $BITRISE_APP_SLUG
  opts:
    title: Unique Identifier (slug) of the Bitrise app
    description: Used for analytics purposes
    is_dont_change_value: true

- repository_url: $GIT_REPOSITORY_URL
  opts:
    title: Git repository URL
    description: Url to be used for the git clone.
    is_dont_change_value: true
- branch: $BITRISE_GIT_BRANCH
  opts:
    category: Clone Config
    title: Git Branch to clone
    description: Branch to be used for the git clone.
    is_dont_change_value: true