apache / apache/maven-site

Please add common parent POMs that are applicable to general use cases

Open
#1,340 1 comment 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Java
Stars
123
Forks
301
Avg merge
16h 59m
Merged PRs (30d)
32

Description

### Improvement proposal

## Problem

With maven 3, it was possible to create a small and trivial pom file without "any help".
Maven 4 will (correctly) print a bunch of warnings, and to get a "simple" pom file that works without warnings, it'll probably take a couple of pages of xml.

## Solution
In maven 4, realistically will require a parent POM for most projects.
I propose to add already-existing parent POM projects and to https://maven.apache.org/pom/index.html page and and have a jump-off point for users to decide which one to use for their own project.
If that's not appropriate, I am open to any other suggestions where to put these.

## Context
When I asked on slack about a year ago whether there was a parent POM that is generally applicable for any project, I was told that there was no such thing.
I created one which works great and is generally applicable.
Today, a reddit user pointed out another one that was started in 2017. I propose to get both of those on the page,
and any other "good" ones that come up.
Both are equally good, one is more complete, and another is smaller in scope (and less code)

One is https://github.com/flowlogix/base-pom / https://docs.flowlogix.com/base-pom (Disclaimer: this is mine)
Another one is https://github.com/basepom/basepom / https://basepom.org

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the Maven parent POM page at maven.apache.org/pom/index.html and review the linked flowlogix/base-pom and basepom/basepom projects. Determine which existing projects meet the page's criteria and document their links and distinctions; the work is done when users have a clear set of general-purpose options to evaluate.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
build-system, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.