7. Reporting and Documentation | Apache Maven Cookbook

Sign In Start Free Trial

Book Overview & Buying
Table Of Contents

Apache Maven Cookbook

By : Raghuram Bharathan

4.2 (5)

Apache Maven Cookbook

4.2 (5)

By: Raghuram Bharathan

Overview of this book

If you are a Java developer or a manager who has experience with Apache Maven and want to extend your knowledge, then this is the ideal book for you. Apache Maven Cookbook is for those who want to learn how Apache Maven can be used for build automation. It is also meant for those familiar with Apache Maven, but want to understand the finer nuances of Maven and solve specific problems.

Preface

Preface

What this book covers

What you need for this book

Who this book is for

Sections

Conventions

Reader feedback

Customer support

Free Chapter

1. Getting Started

1. Getting Started

Introduction

Installing Maven on Microsoft Windows

Installing Maven on Mac OS X

Installing Maven on Linux

Changing the JDK used by Maven

Creating a simple project with Maven

Building a simple project with Maven

Changing the location of the Maven repository

Running Maven behind an HTTP proxy server

Understanding the standard directory layout

2. IDE Integration with Maven

2. IDE Integration with Maven

Introduction

Creating a new Maven project in Eclipse

Importing an existing Maven project in Eclipse

Creating a new Maven project in NetBeans

Importing an existing Maven project in NetBeans

Creating a new Maven project in IntelliJ IDEA

Importing an existing Maven project in IntelliJ IDEA

3. Maven Lifecycle

3. Maven Lifecycle

Introduction

Understanding the Maven lifecycle, phases, and goals

Understanding the pom file

Understanding Maven settings

Understanding command-line options in Maven

Understanding Maven profiles

Adding a new Maven profile

Activating/deactivating a Maven profile

Using properties in Maven

Specifying source encoding for platform-independent builds

4. Essential Maven Plugins

4. Essential Maven Plugins

Introduction

Using the Maven Clean plugin

Using the Maven Compiler plugin

Changing the compiler used by the Maven Compiler plugin

Specifying the Java version for the Compiler plugin

Using the Maven Surefire plugin to run unit tests

Using the Maven Failsafe plugin to run integration tests

Using the Maven Resources plugin

Filtering using resources

Using Eclipse to run Maven goals

Using NetBeans to run Maven goals

Using IntelliJ IDEA to run Maven goals

5. Dependency Management

5. Dependency Management

Introduction

Choosing the scope of dependency

Getting a report of dependencies

Getting into dependency and avoiding dependency hell

Downloading dependencies into a folder

Understanding SNAPSHOT dependencies

Handling dependency download errors

Detecting unused/undeclared dependencies

Manually installing dependencies that are not available in a repository

Dependency management using Eclipse

Dependency management using NetBeans

Dependency management using IntelliJ IDEA

6. Code Quality Plugins

6. Code Quality Plugins

Introduction

Analyzing code coverage with the Maven JaCoCo plugin

Analyzing code coverage with the Maven Cobertura plugin

Analyzing code with the Maven PMD plugin

Analyzing code with the Maven Checkstyle plugin

Analyzing code with the Maven FindBugs plugin

Generating source references with the Maven JXR plugin

Analyzing code with the Maven SonarQube plugin

7. Reporting and Documentation

7. Reporting and Documentation

Introduction

Documenting with the Maven Site plugin

Generating Javadocs for a site

Generating source cross-reference for a site

Generating unit test reports for a site

Generating code coverage reports for a site

Generating code quality reports for a site

Generating selective reports

Deploying a site

8. Handling Typical Build Requirements

8. Handling Typical Build Requirements

Introduction

Including and excluding additional resources

Including and excluding source files and folders

Configuring Maven to search for plugins

Working in offline mode

Controlling the verbosity of the Maven output

Using the Maven Help plugin

Using the Maven SCM plugin

Generating changelogs for a site

9. Multi-module Projects

9. Multi-module Projects

Introduction

Understanding project inheritance

Understanding project aggregation

Combining inheritance and aggregation

Performing multi-module dependency management

Performing multi-module plugin management

Selectively building modules

Reporting for multi-module projects

10. Java Development with Maven

10. Java Development with Maven

Introduction

Building a JAR project

Generating an executable JAR

Generating a JAR of the source code

Generating a JAR of the test classes

Building a WAR project

Building an EAR project

Building a pom project

Running a web project with Jetty

Running a web project with Tomcat

11. Advanced Maven Usage

11. Advanced Maven Usage

Introduction

Creating an assembly

Running a custom executable

Running an ANT task

Determining updates to Maven plugin AntRun

Determining updates to Maven dependencies

Controlling the constraints

Generating unique builds

Releasing a Maven project

Index

Index

Generating source cross-reference for a site

In the previous chapter, we saw how the Maven JXR plugin generates source cross-reference. When publishing a project, it is useful to provide a way to refer to sources in addition to Javadocs. Let us see how to make that part of the site report.

How to do it...

Use the following steps to generate source cross-reference for a site:

Open the Maven project project with documentation.

Add the following code to the reporting section of the pom.xml file:

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-jxr-plugin</artifactId>
  <version>2.5</version>
</plugin>

Run the following command:
```
mvn site
```
Open the generated site report:

How it works...

Adding the Maven JXR plugin to the reporting section of pom automatically creates the project source cross-reference. By default, both source and test cross-references are generated. Like Javadoc, the reportSet element can be configured if we do not...

CONTINUE READING

83

Tech Concepts

36

Programming languages

73

Tech Tools

Unlimited access to the largest independent learning library in tech of over 8,000 expert-authored tech books and videos.

Innovative learning tools, including AI book assistants, code context explainers, and text-to-speech.

50+ new titles added per month and exclusive early access to books as they are being written.

Apache Maven Cookbook

Search

Your notes and bookmarks