Defining Custom Tasks
Write your own Gradle tasks using Groovy or Kotlin DSL to automate specific build steps.
Defining Custom Tasks is a free Groovy & Gradle: JVM Automation and Build Engineering lesson on CoddyKit — lesson 1 of 4. You can read the complete lesson below for free — then practise it hands-on in the browser with a built-in code editor and a 24/7 AI tutor. It is part of the Groovy & Gradle: JVM Automation and Build Engineering learning path, one of 4 lessons in the course, and your progress syncs across the web and the CoddyKit app.
Custom Tasks: Why & How?
Why define your own Gradle tasks? They let you automate unique steps not covered by standard plugins. Think of custom tasks as recipes for specific build actions.
This lesson will show you how to craft them to extend Gradle's capabilities!
Your First Custom Task
The simplest way to create a custom task is directly in your build.gradle file. Use the task keyword followed by your task's name.
Let's create a task named helloCustom:
// build.gradle
task helloCustom {
doLast {
println 'Hello from a custom task!'
}
}Task Actions: doLast & doFirst
Tasks can have multiple actions. You can define them using doFirst and doLast blocks. These blocks specify code to run before or after the task's main actions.
// build.gradle
task orderedActions {
doFirst {
println 'This runs first!'
}
doLast {
println 'This runs last!'
}
doLast { // Can have multiple doLast/doFirst
println 'This runs after the previous doLast!'
}
}Beyond Inline: Custom Task Classes
For more complex logic or reusability across projects, you'll want to define a custom task as a class. This allows for better organization, testing, and property management.
- Encapsulation: Keep task logic in one place.
- Reusability: Share tasks between different projects.
- Configuration: Define properties for customization.
Writing a Custom Task Class
Custom task classes extend Gradle's DefaultTask. You define the task's actions within a method, often annotated with @TaskAction.
Create a file named src/main/groovy/com/coddykit/tasks/MyGreetingTask.groovy:
package com.coddykit.tasks
import org.gradle.api.DefaultTask
import org.gradle.api.tasks.TaskAction
class MyGreetingTask extends DefaultTask {
@TaskAction
def greet() {
println "Hello from MyGreetingTask!"
}
}Using Your Custom Task Class
To use your custom task class, you need to tell Gradle where to find it and then register an instance of it. First, add the Groovy plugin to compile your task class.
Update your build.gradle:
// build.gradle
plugins {
id 'groovy' // To compile Groovy task classes
}
repositories {
mavenCentral()
}
dependencies {
// Required for DefaultTask
implementation gradleApi()
// If your task uses Groovy
implementation 'org.codehaus.groovy:groovy-all:3.0.10'
}
// Register our custom task
tasks.register('myGreeting', com.coddykit.tasks.MyGreetingTask)Executing the Class-Based Task
Now that your custom task class is defined and registered in build.gradle, you can execute it just like any other Gradle task from your terminal.
Run the command:
gradle myGreetingTask Types vs. Definitions
It's important to distinguish between defining a task type (the class) and defining a task instance (registering it).
- Task Type: The
MyGreetingTaskclass itself, which extendsDefaultTask. It defines what the task can do. - Task Definition:
tasks.register('myGreeting', MyGreetingTask). This creates a specific task named 'myGreeting' of that type.
Custom Task Quiz
You've learned how to create custom tasks. Let's test your understanding!
Defining Custom Tasks Recap
Great job! You've learned how to define custom Gradle tasks:
- Inline Tasks: Using
task name { doLast { ... } }for simple, script-local actions. - Task Actions: Controlling execution order with
doFirstanddoLast. - Custom Task Classes: Extending
DefaultTaskfor reusable, organized, and configurable task logic. - Registering Tasks: Using
tasks.register()to create instances of your custom task classes.
Next, we'll dive deeper into task types and how to configure properties for more dynamic tasks!
Frequently asked questions
Is the “Defining Custom Tasks” lesson free?
Yes — the full text of “Defining Custom Tasks” is free to read here on the web, and the Groovy & Gradle: JVM Automation and Build Engineering course includes 4 lessons in total. To practise it interactively (a built-in code editor and a 24/7 AI tutor) and unlock the rest of the Groovy & Gradle: JVM Automation and Build Engineering course, upgrade to CoddyKit PRO.
What will I learn in “Defining Custom Tasks”?
Write your own Gradle tasks using Groovy or Kotlin DSL to automate specific build steps. You practise Groovy & Gradle: JVM Automation and Build Engineering with hands-on code you run directly in the browser, and a 24/7 AI tutor answers your questions as you work through the lesson.
Do I need any experience to start Groovy & Gradle: JVM Automation and Build Engineering?
No prior experience is required. Groovy & Gradle: JVM Automation and Build Engineering on CoddyKit is structured for beginners through advanced learners; this is — lesson 1 of 4, so you can start here or from the beginning and move at your own pace.
How long does the “Defining Custom Tasks” lesson take?
Most CoddyKit lessons take about 5–10 minutes. Each one is bite-sized and interactive, so you make steady progress and pick up exactly where you left off across the web and the app.
Can I write and run code in this Groovy & Gradle: JVM Automation and Build Engineering lesson?
Yes. Every Groovy & Gradle: JVM Automation and Build Engineering lesson includes a built-in code editor, so you write and run real code right in your browser and get instant AI feedback — no local setup required.