step.yml

title: Generate Xcode test HTML/JUnit report
summary: Generate Xcode-like HTML report for Unit and UI Tests
description: Generate Xcode-like HTML report for Unit and UI Tests with XCTestHTMLReport
website: https://github.com/BirmacherAkos/bitrise-step-xctest-html-report
source_code_url: https://github.com/BirmacherAkos/bitrise-step-xctest-html-report
support_url: https://github.com/BirmacherAkos/bitrise-step-xctest-html-report/issues

project_type_tags:
  - ios
  - macos
  - react-native
  - flutter
type_tags:
  - utility

is_requires_admin_user: true
is_always_run: true
is_skippable: true

toolkit:
  go:
    package_name: github.com/BirmacherAkos/bitrise-step-xctest-html-report

inputs:
  - github_access_token:
    opts:
      title: Github Personal Access Token
      summary: Use this input to avoid Github rate limit issues for the XCTestHTMLReport download
      description: |-
        Use this input to avoid Github rate limit issues.
        See the github's guide: [Creating an access token for command-line use](https://help.github.com/articles/creating-an-access-token-for-command-line-use/).
        __UNCHECK EVERY SCOPE BOX__ when creating this token. There is no reason this token needs access to private information.
      is_sensitive: true
  - test_result_path: $BITRISE_XCRESULT_PATH
    opts:
      title: Xcode test result (.xctestresult) paths
      summary: The paths of the Xcode test generated .xctestresult files.
      description: |-
        The paths of the Xcode test generated .xctestresult files.

        **Separated by a new line**

        * $BITRISE\_SOURCE\_DIR/test.xctestresult
        * $BITRISE\_SOURCE\_DIR/test\_2.xctestresult
        * ./test\_3.xctestresult
      is_required: true

  - generate_junit: "yes"
    opts:
      title: Generate JUnit report?
      summary: Generate JUnit report?
      description: |
        Provide JUnit XML output if enabled.
      is_required: true
      value_options:
        - "yes"
        - "no"

  - output_dir: $BITRISE_DEPLOY_DIR
    opts:
      title: Output directory path
      summary: This directory will contain the generated test reports.
      description: |-
        This directory will contain the generated test reports.

        By default it's the `$BITRISE\_DEPLOY_DIR`
      is_required: "true"
    
  - version: "latest"
    opts:
      title: Version of the XCTestHTMLReport
      summary: Select which version to install
      description: |
        The version of XCTestHTMLReport you want to use from https://github.com/TitouanVanBelle/XCTestHTMLReport/releases.
        If the value is set to `latest`, the step will download to the latest XCTestHTMLReport version.
      is_required: true
      value_options:
        - "develop"
        - "master"
      
  - verbose: "no"
    opts:
      title: Enable verbose log?
      summary: Enable verbose log?
      description: |
        You can enable the verbose logging for troubleshooting purposes.
      is_required: true
      value_options:
        - "yes"
        - "no"

outputs:
  - XC_HTML_REPORT:
    opts:
      title: The path of the generated `HTML report`. Which was exported to the output\_dir ( $BITRISE\_DEPLOY\_DIR by default )
      summary: The path of the generated `HTML report`. Which was exported to the output\_dir ( $BITRISE\_DEPLOY\_DIR by default )
  
  - XC_JUNIT_REPORT:
    opts:
      title: The path of the generated `JUnit report`. Which was exported to the output\_dir ( $BITRISE\_DEPLOY\_DIR by default )
      summary: The path of the generated `JUnit report`. Which was exported to the output\_dir ( $BITRISE\_DEPLOY\_DIR by default )