- Apache Maven Cookbook
- Table of Contents
- Apache Maven Cookbook
- Credits
- About the Author
- About the Reviewers
- www.PacktPub.com
- Preface
- 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
- 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
- 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
- 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
- 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
- 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
- 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
- 10. Java Development with Maven
- 11. Advanced Maven Usage
- Index
In this chapter, we will see how we can use the Maven Site plugin, as well as configure various reports on a site. We will cover the following recipes:
- 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
One of the most powerful features of Maven is the ability to create documentation for the project. It is useful to have a self-documenting project that can be published to a website without additional effort. Maven provides the ability to generate this documentation, known as a site report, and publish it to a website.
Many Maven plugins use the Site feature to generate project documentation. In fact, Maven itself uses the Site plugin to generate its website.
-
No Comment
..................Content has been hidden....................
You can't read the all page of ebook, please click here login for view all page.