Giter Club home page Giter Club logo

api-parent-pom's Introduction

api-parent-pom

License: Apache 2 Travis Build Maven Artifact

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.

Set the parent block in your pom:

<parent>
    <groupId>com.groupon.api</groupId>
    <artifactId>api-parent-pom</artifactId>
    <version>VERSION</version>
    <relativePath />
</parent>

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:

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
        </plugin>
    </plugins>
</build>

Building

Prerequisites:

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

api-parent-pom's People

Contributors

aleqi200 avatar brandonarp avatar cchacin avatar ddimensia avatar elai avatar namral avatar vjkoskela avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.