Skip to main content

Android Lint

Android Lint is a static analysis tool provided by the Android SDK that helps identify potential issues in Android projects. It scans the source code for common programming errors, performance optimizations, usability issues, and other problems. Android Lint can detect a wide range of issues, such as unused resources, layout performance problems, memory leaks, and security vulnerabilities.

This step is used to run Lint Gradle tasks in your project via Appcircle.

Prerequisites

The workflow steps that need to be executed before running the Android Lint workflow step, along with their respective reasons, are listed in the table below.

Prerequisite Workflow StepDescription
Git CloneTo start the Android Lint process, the repository that needs to be built must be fetched from the branch. This generates the AC_REPOSITORY_DIR variable, which is then used as the input for the Android Lint step.
caution

Please ensure that you insert the Android Lint step before using the Android Build step.

Input Variables

For each component, specific input variables are required for its operation on your system. The input variables necessary for the Android Lint are as follows:

Variable NameDescriptionStatus
$AC_REPOSITORY_DIRThis variable represents the path of the cloned Git repository. If this step runs after the Git Clone step, the variable will be automatically populated.Required
$AC_MODULEThis variable specifies the project module to be built. This variable can also be set via the build Configuration. In Android Studio, you can locate the available modules for your project. For more information, please refer to this Android document.Required
$AC_VARIANTSThis variable specifies the project variant to be built. This variable can also be set via the build Configuration. In Android Studio, you can find the available variants for your project. For more information, please refer to this Android document.Required
$AC_PROJECT_PATHSpecifies the project path. If your project that needs to be built is not located in the root directory where it was cloned from Git, you should provide the subpath as a relative path.Optional
info

If you have filled in the required variables in the Configuration section, you will not need to redefine these variables again on the Workflows. For more information about configurations, refer to the Build Profile Configuration Overview document.

  1. The input corresponds to the 1st field: $AC_MODULE
  2. The input corresponds to the 2nd field: $AC_VARIANTS

Output Variables

The outputs that can result from the operation of this component are listed as follows:

Variable NameDescription
-Lint does not assign the XML/HTML file output to a variable. However, the resulting file from Lint appears in the output ($AC_OUTPUT_DIR) and report directory (<gradlew folder path>/$AC_MODULE/build/reports).
caution

To view the Lint report on the Download Artifacts page, please ensure that the Export Build Artifacts step is included in your Workflow after this step.


To access the source code of this component, please use the following link:

Preview of GitHub - appcircleio/appcircle-android-lint-component