Skip to content

Bernardo-MG/base-pom

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Base POM

Parent Maven POM for common Maven projects. Supports good practices such as unit plus integration testing, or dependency convergence. And this is done without adding any additional dependency to the project, only Maven plugins. This way it is useful for any kind of project, no matter what actual technologies it is based on.

Maven Central

Release docs Development docs

Features

  • Build validation.
  • Maven Site reports added for the project.
  • Common build and report plugins.
  • Deployment plugin prepared to deploy into the distribution management repo.
  • Manifest prepared with default configuration.
  • Sets the JDK version to be used by the project.
  • Sets the project default encoding to UTF-8.

Example

The Library Maven Archetype makes use of this POM. And extends it. This is an easy way to check how the POM can be used and modified.

Documentation

Documentation is always generated for the latest release, kept in the 'master' branch:

Documentation is also generated from the latest snapshot, taken from the 'develop' branch:

The documentation site sources come along the source code (as it is a Maven site), so it is always possible to generate them using the following Maven command:

mvn site -P deployment-site

Usage

Use as a parent POM on any Maven project:

<parent>
    <groupId>com.bernardomg.maven</groupId>
    <artifactId>base-pom</artifactId>
    <version>(Check POM or badges)</version>
</parent>

Installing

If needed, the project can be added to the local Maven repository with the following command:

mvn install

Collaborate

Any kind of help with the project will be well received, and there are two main ways to give such help:

  • Reporting errors and asking for extensions through the issues management
  • or forking the repository and extending the project

Issues management

Issues are managed at the GitHub project issues tracker, where any Github user may report bugs or ask for new features.

Getting the code

If you wish to fork or modify the code, visit the GitHub project page, where the latest versions are always kept. Check the 'master' branch for the latest release, and the 'develop' for the current, and stable, development version.

License

The project has been released under the MIT License.