https://github.com/groupon/api-parent-pom
Project to contain parent pom for common plugin configuration across all API team Maven projects.
https://github.com/groupon/api-parent-pom
Last synced: about 1 year ago
JSON representation
Project to contain parent pom for common plugin configuration across all API team Maven projects.
- Host: GitHub
- URL: https://github.com/groupon/api-parent-pom
- Owner: groupon
- License: apache-2.0
- Archived: true
- Created: 2015-12-28T21:15:39.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2020-01-31T18:13:18.000Z (over 6 years ago)
- Last Synced: 2025-05-08T21:39:05.263Z (about 1 year ago)
- Size: 50.8 KB
- Stars: 1
- Watchers: 9
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
api-parent-pom
==============
Standardized set of build tool configurations for Groupon API projects.
Motivation
-----
As the number of Groupon API projects has grown and our code/build standards have matured. We required a better way to share configuration across projects rather than replicate the same configuration (e.g. compiler, checkstyle, findbugs, etc.) across all of our projects. The parent pom is intended to only provide the base configuration for plugins that we expect to be consistent throughout projects. Project specific configuration and plugins should not be included in the parent pom.
Usage
-----
Determine the latest version of the api parent pom in [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.groupon.api%22%20a%3A%22api-parent-pom%22).
Set the __parent__ block in your pom:
```xml
com.groupon.api
api-parent-pom
VERSION
```
Next, enable the desired plugins from the parent pom's __pluginManagement__ block in the __plugins__ block; for example to use the javadoc plugin specified in the parent include the following:
```xml
org.apache.maven.plugins
maven-javadoc-plugin
```
Building
--------
Prerequisites:
* [JDK8](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html)
* [Maven 3.3.3+](http://maven.apache.org/download.cgi)
Building:
api-parent-pom> mvn verify
To use the local version you must first install it locally:
api-parent-pom> mvn install
You can determine the version of the local build from the pom file. Using the local version is intended only for testing or development.
License
-------
Published under Apache Software License 2.0, see LICENSE
© Groupon Inc., 2015