<!--
  ~ Copyright 2013 the original author or authors.
  ~
  ~ Licensed under the Apache License, Version 2.0 (the "License");
  ~ you may not use this file except in compliance with the License.
  ~ You may obtain a copy of the License at
  ~
  ~      http://www.apache.org/licenses/LICENSE-2.0
  ~
  ~ Unless required by applicable law or agreed to in writing, software
  ~ distributed under the License is distributed on an "AS IS" BASIS,
  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  ~ See the License for the specific language governing permissions and
  ~ limitations under the License.
  -->

<chapter id="buildDashboard_plugin">
    <title>The Build Dashboard Plugin</title>
    <note>
        <para>
            The build dashboard plugin is currently <link linkend="feature_lifecycle">incubating</link>. Please be aware that the DSL and other configuration may change in later Gradle versions.
        </para>
    </note>

    <para>
        The Build Dashboard plugin can be used to generate a single HTML dashboard that provides a single point of
        access to all of the reports generated by a build.
    </para>

    <section id="sec:build_dashboard_usage">
        <title>Usage</title>
        <para>To use the Build Dashboard plugin, include the following in your build script:</para>
        <sample id="useBuildDashboardPlugin" dir="buildDashboard" title="Using the Build Dashboard plugin">
            <sourcefile file="build.gradle" snippet="use-build-dashboard-plugin"/>
        </sample>
        <para>
            Applying the plugin adds the <literal>buildDashboard</literal> task to your project.
            The task aggregates the reports for all tasks that implement the <apilink class="org.gradle.api.reporting.Reporting" />
            interface from <emphasis>all projects</emphasis> in the build.
            It is typically only applied to the root project.
        </para>
        <para>
            The <literal>buildDashboard</literal> task does not depend on any other tasks. It will only aggregate the reporting tasks that are independently
            being executed as part of the build run. To generate the build dashboard, simply include this task in the list of tasks to execute.
            For example, “<userinput>gradle buildDashboard build</userinput>” will generate a dashboard for all of the reporting tasks that are dependents of the <literal>build</literal> task.
        </para>
    </section>

    <section id="sec:build_dashboard_tasks">
        <title>Tasks</title>
        <para>The Build Dashboard plugin adds the following task to the project:</para>
        <table>
            <title>Build Dashboard plugin - tasks</title>
            <thead>
                <tr>
                    <td>Task name</td>
                    <td>Depends on</td>
                    <td>Type</td>
                    <td>Description</td>
                </tr>
            </thead>
            <tr>
                <td>
                    <literal>buildDashboard</literal>
                </td>
                <td>-</td>
                <td><apilink class="org.gradle.api.reporting.GenerateBuildDashboard"/></td>
                <td>Generates build dashboard report.</td>
            </tr>
        </table>
    </section>

    <section id="sec:build_dashboard_project_layout">
        <title>Project layout</title>
        <para>The Build Dashboard plugin does not require any particular project layout.</para>
    </section>

    <section id="sec:build_dashboard_dependency_management">
        <title>Dependency management</title>
        <para>The Build Dashboard plugin does not define any dependency configurations.</para>
    </section>

    <section id="sec:build_dashboard_configuration">
        <title>Configuration</title>
        <para>You can influence the location of build dashboard plugin generation via <apilink class="org.gradle.api.reporting.ReportingExtension"/>.</para>
    </section>

</chapter>
