Create custom checks

Custom checks can be created as a Gradle ↗ tasks. These tasks should be added to the appropriate inner build.gradle files, within the language subfolders. Here is an example of a Gradle task that prints Hello World when executed (note that the doLast method creates a task action that runs when the task executes, rather than at configuration time):

Copied!
1
2
3
4
5
6
// Define custom task
task customTask {
    doLast {
        println "Hello World"
    }
 }

In order for tasks to get executed during CI checks, there must be a CI task that depends on your custom task. This is also defined in the same build.gradle file. In the following example, the check task would be executed after customTask in CI; this is where the Hello World message will appear in the CI logs.

Copied!
1
2
// Add CI dependency on custom task
 project.tasks.check.dependsOn customTask

In order for tasks to get executed at the end of the task list, you would use the following syntax instead.

Copied!
1
2
// Execute custom task after CI checks are published
project.tasks.publish.configure { finalizedBy customTask }

To add dependencies, you can use the following CI tasks: project.tasks.check, project.tasks.test, and project.tasks.publish. We strongly recommend you do not use or rely on other CI tasks (for example, internal tasks) as these are not guaranteed and are subject to change.

More documentation of the functionality provided by Gradle build scripts is available in the Gradle docs ↗.