Skip to main content

Gradle Runner

The Gradle Runner workflow step executes the specified Gradle task provided by the user.

Prerequisites

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

Prerequisite Workflow StepDescription
Git CloneTo initiate the Gradle Runner process, the repository that needs to be built must be fetched from the branch. This is achieved as follows: Upon completion of the Git Clone step, it generates the AC_REPOSITORY_DIR variable, which is then used as the input for the Gradle Runner step.

Input Variables

For each component, specific input variables are required for its operation on your system. The input variables necessary for the Gradle Runner 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_OUTPUT_DIRSpecifies the directory path for the generated app files.Required
$AC_GRADLE_TASKSpecifies the name of the Gradle task. Refer to the documentation for detailed information: List available tasks.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. The default value is: ./Optional
$AC_GRADLE_TASK_EXTRA_PARAMETERSExtra arguments were passed to the Gradle task. For more information, please refer to this Gradle document.Optional

Output Variables

As the output may vary depending on the task you execute, there is no specific output defined by default.

caution

If there is an output generated, ensure to use the Export Build Artifacts step afterward to ensure it is included in the Download Artifacts page.

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

Preview of GitHub - appcircleio/appcircle-android-gradle-task-component