Class HtmlDependencyReportTask

  • All Implemented Interfaces:
    java.lang.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 org.gradle.api.internal.ConventionTask
    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 Detail

      • HtmlDependencyReportTask

        public HtmlDependencyReportTask()
    • Method Detail

      • getProjectReportDirectory

        public DirectoryProperty getProjectReportDirectory()
        Returns the project report directory.
        the directory to store project reports
      • getObjectFactory

        protected ObjectFactory getObjectFactory()
      • getVersionSelectorScheme

        protected org.gradle.api.internal.artifacts.ivyservice.ivyresolve.strategy.VersionSelectorScheme getVersionSelectorScheme()
      • getVersionComparator

        protected org.gradle.api.internal.artifacts.ivyservice.ivyresolve.strategy.VersionComparator getVersionComparator()
      • getVersionParser

        protected org.gradle.api.internal.artifacts.ivyservice.ivyresolve.strategy.VersionParser getVersionParser()
      • getCallbackActionDecorator

        protected org.gradle.api.internal.CollectionCallbackActionDecorator getCallbackActionDecorator()
        Required for decorating reports container callbacks for tracing user code application.
      • generate

        public void generate()
      • getProjects

        public java.util.Set<Project> getProjects()
        Returns the set of projects to generate a report for. By default, the report is generated for the task's containing project.
        The set of files.
      • setProjects

        public void setProjects​(java.util.Set<Project> projects)
        Specifies the set of projects to generate this report for.
        projects - The set of projects. Must not be null.