---
title: Usage
author:
  - Allan Ramirez
date: July 2006
---

<!-- Copyright 2006 The Apache Software Foundation.-->
<!---->
<!-- 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.-->
# Usage

Generate the Report as Part of Project Reports
----------------------------------------------

To generate the Surefire report as part of the site generation, add the following in the `<reporting>` section of your POM:

```xml
<project>
  ...
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-surefire-report-plugin</artifactId>
        <version>${project.version}</version>
      </plugin>
    </plugins>
  </reporting>
  ...
</project>
```

When `mvn site` is invoked, the report will automatically be included in the Project Reports menu as shown in the figure below.

<figure><img src="images/surefire-sample1.png" /><figcaption>Sample Surefire Report</figcaption></figure>

Generate the Report in a Standalone Fashion
-------------------------------------------

The plugin can also generate the report using its standalone goal:

```bash
mvn surefire-report:report
```

An HTML report should be generated in `${esc.d}{basedir}/target/reports/surefire.html`.

<figure><img src="images/surefire-sample2.png" /><figcaption>Sample standalone surefire-report</figcaption></figure>
