api / org.gradle.api.tasks.diagnostics

Package org.gradle.api.tasks.diagnostics

Types

AbstractDependencyReportTask

abstract class AbstractDependencyReportTask : AbstractReportTask

Displays the dependency tree for a configuration.

AbstractReportTask

abstract class AbstractReportTask : ConventionTask

The base class for all project report tasks.

BuildEnvironmentReportTask

open class BuildEnvironmentReportTask : DefaultTask

Provides information about the build environment for the project that the task is associated with.

Currently, this information is limited to the project's declared build script dependencies visualised in a similar manner as provided by DependencyReportTask.

It is not necessary to manually add a task of this type to your project, as every project automatically has a task of this type by the name "buildEnvironment".

DependencyInsightReportTask

open class DependencyInsightReportTask : DefaultTask

Generates a report that attempts to answer questions like:

  • Why is this dependency in the dependency graph?
  • Exactly which dependencies are pulling this dependency into the graph?
  • What is the actual version (i.e. *selected* version) of the dependency that will be used? Is it the same as what was *requested*?
  • Why is the *selected* version of a dependency different to the *requested*?
Use this task to get insight into a particular dependency (or dependencies) and find out what exactly happens during dependency resolution and conflict resolution. If the dependency version was forced or selected by the conflict resolution this information will be available in the report.

While the regular dependencies report (DependencyReportTask) shows the path from the top level dependencies down through the transitive dependencies, the dependency insight report shows the path from a particular dependency to the dependencies that pulled it in. That is, it is an inverted view of the regular dependencies report.

The task requires setting the dependency spec and the configuration. For more information on how to configure those please refer to docs for DependencyInsightReportTask#setDependencySpec(Object) and DependencyInsightReportTask#setConfiguration(String).

The task can also be configured from the command line. For more information please refer to DependencyInsightReportTask#setDependencySpec(Object) and DependencyInsightReportTask#setConfiguration(String)

DependencyReportTask

open class DependencyReportTask : AbstractDependencyReportTask

Displays the dependency tree for a project. An instance of this type is used when you execute the dependencies task from the command-line.

ProjectReportTask

open class ProjectReportTask : AbstractReportTask

Displays a list of projects in the build. An instance of this type is used when you execute the projects task from the command-line.

PropertyReportTask

open class PropertyReportTask : AbstractReportTask

Displays the properties of a project. An instance of this type is used when you execute the properties task from the command-line.

TaskReportTask

open class TaskReportTask : AbstractReportTask

Displays a list of tasks in the project. An instance of this type is used when you execute the tasks task from the command-line.

By default, this report shows only those tasks which have been assigned to a task group, so-called visible tasks. Tasks which have not been assigned to a task group, so-called hidden tasks, can be included in the report by enabling the command line option --all.