Package org.gradle.api.reporting.dependencies

Class HtmlDependencyReportTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
org.gradle.api.internal.ConventionTask
org.gradle.api.tasks.diagnostics.ConventionReportTask
org.gradle.api.tasks.diagnostics.AbstractProjectBasedReportTask<AbstractDependencyReportTask.DependencyReportModel>
org.gradle.api.tasks.diagnostics.AbstractDependencyReportTask
org.gradle.api.reporting.dependencies.HtmlDependencyReportTask
All Implemented Interfaces:
Comparable<Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, Named, ExtensionAware, Reporting<DependencyReportContainer>, Task, Configurable<Task>
@UntrackedTask(because="We can\'t describe the dependency tree of all projects as input") public abstract class HtmlDependencyReportTask extends AbstractDependencyReportTask implements Reporting<DependencyReportContainer>
Generates an HTML dependency report. This report combines the features of the ASCII dependency report and those of the ASCII dependency insight report. For a given project, it generates a tree of the dependencies of every configuration, and each dependency can be clicked to show the insight of this dependency.

This task generates a report for the task's containing project by default. But it can also generate a report for multiple projects, by setting the value of the projects property. Here's how to generate an HTML dependency report for all the projects of a multi-project build, for example: 

 htmlDependencyReport {
     projects = project.allprojects
 }

The report is generated in the build/reports/project/dependencies directory by default. This can also be changed by setting the reports.html.destination property: 

 htmlDependencyReport {
     reports.html.outputLocation = file("build/reports/project/dependencies")
 }

  • Constructor Details

    • HtmlDependencyReportTask

      public HtmlDependencyReportTask()

  • Method Details

    • getReports

      public DependencyReportContainer getReports()
      Description copied from interface: Reporting
      A ReportContainer instance.

      Implementers specify a specific implementation of ReportContainer that describes the types of reports that are available.

      Specified by:
      getReports in interface Reporting<DependencyReportContainer>
      Returns:
      The report container

    • reports

      public DependencyReportContainer reports(Closure closure)
      Description copied from interface: Reporting
      Allow configuration of the report container by closure. 
       reports {
   html {
     required false
   }
   xml.outputLocation = "build/reports/myReport.xml"
 }
      Specified by:
      reports in interface Reporting<DependencyReportContainer>
      Parameters:
      closure - The configuration
      Returns:
      The report container

    • reports

      public DependencyReportContainer reports(Action<? super DependencyReportContainer> configureAction)
      Description copied from interface: Reporting
      Allow configuration of the report container by closure. 
       reports {
   html {
     required false
   }
   xml.outputLocation = "build/reports/myReport.xml"
 }
      Specified by:
      reports in interface Reporting<DependencyReportContainer>
      Parameters:
      configureAction - The configuration
      Returns:
      The report container

    • getObjectFactory

      @Inject protected ObjectFactory getObjectFactory()

    • getVersionSelectorScheme

      @Inject protected org.gradle.api.internal.artifacts.ivyservice.ivyresolve.strategy.VersionSelectorScheme getVersionSelectorScheme()

    • getVersionComparator

      @Inject protected org.gradle.api.internal.artifacts.ivyservice.ivyresolve.strategy.VersionComparator getVersionComparator()

    • getVersionParser

      @Inject protected org.gradle.api.internal.artifacts.ivyservice.ivyresolve.strategy.VersionParser getVersionParser()

    • getCallbackActionDecorator

      @Inject protected org.gradle.api.internal.CollectionCallbackActionDecorator getCallbackActionDecorator()
      Required for decorating reports container callbacks for tracing user code application.
      Since:
      5.1

    • generate

      public void generate()