README.md

Inspector Graphetto

Inspector Graphetto is a Gradle build plugin to inspect and visualize the task execution graph of your build.

Installation

Inside your top-level Gradle file add the Inspector Graphetto plugin:

In a build.gradle file (Groovy):

plugins {
    id 'at.droiddave.graphetto' version '0.0.1'
}

In a build.gradle.kts Kotlin DSL file:

plugins {
    id("at.droiddave.graphetto") version "0.0.1"
}

Usage

Simply run a build, and Inspector Graphetto will write a GraphViz .dot file to build/reports/taskGraph/graph.dot.

$ ./gradlew assembleDebug
$ cat build/reports/taskGraph/graph.dot

strict digraph G {
  1 [ label=":someOtherTask" ];
  2 [ label=":someTask" ];
  2 -> 1;
}

You can also print the entire task dependency graph to the console:

$ ./gradlew assembleDebug -Dat.droiddave.graphetto.consoleOutput=TREE

 ── :someTask
    └── :someOtherTask

> Task :someOtherTask UP-TO-DATE
> Task :someTask UP-TO-DATE

BUILD SUCCESSFUL in 92ms

Configuration

The plugin registers an extension called graphetto on your project which can be used to configure the output:

graphetto {
    outputFile = new File(buildDir, 'reports/my-task-graph.dot')
    consoleOutput = at.droiddave.graphetto.ConsoleOutput.TREE
}

outputFile

Configures the path of the .dot output file containing the information about the task graph that was executed. Defaults to reports/taskGraph/graph.dot.

graphetto {
    outputFile = new File(buildDir, 'reports/my-task-graph.dot')
}

consoleOutput

Configures the type of console output produced by the plugin.

• TREE will print the entire task dependency tree before after the configuration phase of your build.
• NONE will not print any console output. This is the default.

graphetto {
    consoleOutput = at.droiddave.graphetto.ConsoleOutput.TREE
}

You can also override the current configuration by passing the -Dat.droiddave.graphetto.consoleOutput=TREE option when invoking your build on the command line.