bitrise-step-android-lint/step.yml at master · BanyikAnna/bitrise-step-android-lint · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
title: "Android Lint"
summary: |-
  Runs Lint on your Android project source files and detects potential syntax errors to keep your code error free.
description: |-
  It highlights the code line where the error is found, explains the type of error and suggests corrections. The Step does not make the build fail if it spots any structural errors in your code. If you have inserted the **Deploy to Bitrise.io** Step in the Workflow, the tes results will be available in a viewable or downloadable Lint Report HTML or XML file which you can access on the Build's APPS & ARTIFACTS page.

  ### Configuring the Step

  1. Set the **Project Location** input which, by default, points to the root directory of your Android project.
  2. Set the module and variant you wish to lint in the **Module** and **Variant** fields.

  Optionally, you can modify these inputs:
  1. You can specify where the Lint reports should be found once the Step has run if you overwrite the **Report location pattern** input.
  2. You can set if the Step should cache build outputs and dependencies, only the dependencies or nothing at all in the **Set level of cache** input.
  3. You can set any gradle argument to the gradle task in the **Additional Gradle Arguments** input.

  ### Troubleshooting
  Make sure you insert the Step before a build Step.
  Make sure you type the correct module and variant names in the respective fields of the Step. If you are unsure about the exact names, you can check them in the **Project Structure** dialog of your project in Android Studio.

  ### Useful links
  - [Improve your code with lint checks](https://developer.android.com/studio/write/lint)

  ### Related Steps
  - [Android Build](https://www.bitrise.io/integrations/steps/android-build)
  - [Android Unit Test](https://www.bitrise.io/integrations/steps/android-unit-test)
  - [[BETA] Virtual Device Testing for Android](https://www.bitrise.io/integrations/steps/virtual-device-testing-for-android)
website: https://github.com/bitrise-steplib/bitrise-step-android-lint
source_code_url: https://github.com/bitrise-steplib/bitrise-step-android-lint
support_url: https://github.com/bitrise-steplib/bitrise-step-android-lint/issues
host_os_tags:
  - osx-10.10
  - ubuntu-16.04

project_type_tags:
  - android
  - react-native

type_tags:
  - test

is_requires_admin_user: true
is_always_run: false
is_skippable: false

toolkit:
  go:
    package_name: github.com/bitrise-steplib/bitrise-step-android-lint

inputs:
  - project_location: $BITRISE_SOURCE_DIR
    opts:
      title: Project Location
      summary: "The root directory of your android project, for example, where your root build gradle file exists (also gradlew, settings.gradle, etc...)"
      description: "The root directory of your android project, for example, where your root build gradle file exists (also gradlew, settings.gradle, etc...)"
      is_required: true
  - module: ""
    opts:
      title: Module
      summary: |
        Set the module that you want to lint. To see your available modules please open your project in Android Studio and go in [Project Structure] and see the list on the left.
      description: |
        Set the module that you want to lint. To see your available modules please open your project in Android Studio and go in [Project Structure] and see the list on the left.
      is_required: false
  - variant: ""
    opts:
      title: Variant
      summary: |
        Set the variant that you want to lint. To see your available variants please open your project in Android Studio and go in [Project Structure] -> variants section.
      description: |
        Set the variant that you want to lint. To see your available variants please open your project in Android Studio and go in [Project Structure] -> variants section.
      is_required: false
  - report_path_pattern: "*/build/reports/lint-results*.html"
    opts:
      category: Options
      title: Report location pattern
      summary: |
        Will find the report file with the given pattern. If you need the xml file then you can use: "*/build/reports/lint-results*.xml"
      description: |
        Will find the report file with the given pattern. If you need the xml file then you can use: "*/build/reports/lint-results*.xml"
      is_required: true
  - cache_level: "only_deps"
    opts:
      category: Options
      title: Set the level of cache
      description: |-
        `all` - will cache build cache and dependencies
        `only_deps` - will cache dependencies only
        `none` - will not cache anything
      is_required: true
      value_options:
      - "all"
      - "only_deps"
      - "none"
  - arguments:
    opts:
      category: Options
      title: Additional Gradle Arguments
      summary: Extra arguments passed to the gradle task
      description: Extra arguments passed to the gradle task
      is_required: false