gradle-plugin/dev.zacsweers.metro.gradle.artifacts/GenerateGraphMetadataTask

GenerateGraphMetadataTask

@CacheableTask

abstract class GenerateGraphMetadataTask : DefaultTask(source)

Aggregates Metro graph metadata JSON files into a single consolidated report on a per-compilation basis.

This task collects all graph metadata JSON files generated by the Metro compiler plugin in a given compilation and combines them into a single JSON file containing metadata about all dependency graphs in the project. The output includes the project path, graph count, and an array of all individual graph metadata objects.

The generated file is useful for:

CI validation of dependency graph structure
Automated analysis and reporting
Tooling that needs a complete view of all Metro graphs in a project

Constructors

GenerateGraphMetadataTask

constructor()

Properties

open var actions: List<Action<in Task>>

open val ant: AntBuilder

asDynamicObject

@get:Internal

open val asDynamicObject: DynamicObject

compilationName

@get:Input

@get:Optional

abstract val compilationName: Property<String>

The kotlinc compilation name.

open val dependsOn: Set<Any>

open var description: @Nullable String?

open val destroyables: TaskDestroyables

open var didWork: Boolean

open var enabled: Boolean

open val extensions: ExtensionContainer

open val finalizedBy: TaskDependency

@get:InputFiles

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val graphJsonFiles: ConfigurableFileCollection

The graph metadata JSON files.

open var group: @Nullable String?

open val identityPath: Path

impliesSubProjects

open var impliesSubProjects: Boolean

open val inputs: TaskInputsInternal

isCompatibleWithConfigurationCache

open val isCompatibleWithConfigurationCache: Boolean

@get:Internal

open var isEnabled: Boolean

isHasCustomActions

open val isHasCustomActions: Boolean

lifecycleDependencies

@get:Internal

open val lifecycleDependencies: TaskDependencyInternal

open val localState: TaskLocalState

open val logger: Logger

open val logging: LoggingManager

open val mustRunAfter: TaskDependency

open val name: String

open val onlyIf: Spec<in TaskInternal>

@get:OutputFile

abstract val outputFile: RegularFileProperty

The output file where the consolidated metadata will be written.

open val outputs: TaskOutputsInternal

open val path: String

open val project: Project

@get:Input

abstract val projectPath: Property<String>

The Gradle project path this task is generating metadata for.

reasonNotToTrackState

open val reasonNotToTrackState: Optional<String>

reasonTaskIsIncompatibleWithConfigurationCache

open val reasonTaskIsIncompatibleWithConfigurationCache: Optional<String>

requiredServices

open val requiredServices: TaskRequiredServices

sharedResources

open val sharedResources: List<ResourceLock>

open val shouldRunAfter: TaskDependency

standardOutputCapture

open val standardOutputCapture: StandardOutputCapture

open val state: TaskStateInternal

open val taskActions: List<InputChangesAwareTaskAction>

taskDependencies

open val taskDependencies: TaskDependencyInternal

open val taskIdentity: TaskIdentity<*>

open val temporaryDir: File

temporaryDirFactory

open val temporaryDirFactory: Factory<File>

open val timeout: Property<Duration>

Functions

acceptServiceReferences

open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec>)

appendParallelSafeAction

open fun appendParallelSafeAction(action: Action<in Task>)

open operator fun compareTo(otherTask: Task): Int

open fun configure(closure: Closure<*>): Task

open fun dependsOn(vararg paths: Any): Task

open fun doFirst(action: Closure<*>): Task

open fun doFirst(action: Action<in Task>): Task

open fun doFirst(actionName: String, action: Action<in Task>): Task

open fun doLast(action: Closure<*>): Task

open fun doLast(action: Action<in Task>): Task

open fun doLast(actionName: String, action: Action<in Task>): Task

doNotTrackState

open fun doNotTrackState(reasonNotToTrackState: String)

open fun finalizedBy(vararg paths: Any): Task

open fun hasProperty(propertyName: String): Boolean

open fun hasTaskActions(): Boolean

open fun mustRunAfter(vararg paths: Any): Task

notCompatibleWithConfigurationCache

open fun notCompatibleWithConfigurationCache(reason: String)

open fun onlyIf(onlyIfClosure: Closure<*>)

open fun onlyIf(spec: Spec<in Task>)

open fun onlyIf(onlyIfReason: String, spec: Spec<in Task>)

prependParallelSafeAction

open fun prependParallelSafeAction(action: Action<in Task>)

open fun property(propertyName: String): Any

open fun setDependsOn(dependsOn: Iterable<*>)

open fun setFinalizedBy(finalizedByTasks: Iterable<*>)

setMustRunAfter

open fun setMustRunAfter(mustRunAfterTasks: Iterable<*>)

open fun setOnlyIf(onlyIfClosure: Closure<*>)

open fun setOnlyIf(spec: Spec<in Task>)

open fun setOnlyIf(onlyIfReason: String, spec: Spec<in Task>)

open fun setProperty(name: String, value: Any)

setShouldRunAfter

open fun setShouldRunAfter(shouldRunAfterTasks: Iterable<*>)

open fun shouldRunAfter(vararg paths: Any): TaskDependency

open fun usesService(service: Provider<out BuildService<*>>)