[COMMONSSITE-81] commons-build-plugin README/CONTRIBUTING.md handle multi-modules

• Type: Improvement
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 1.5-SNAPSHOT
• Component/s: Commons Build Plugin
• Labels: patch
• Assignee: Benedikt Ritter
• Reporter: Bernd Eckenfels
• Created: 31/Dec/14 17:51
• Updated: 02/Jan/15 20:19
• Resolved: 02/Jan/15 20:19

Description

The following patch will allow the commons-build-plugin to generate the correct README/CONTRIBUTING.md even when we are in a multi-module scenario.

It will especially not use artifact-id for URLs (but `commons-${commons.componentId}`).

This requires that the componentid does not contain "commons-" prefix (which is not given for the plugin itself).

There is a hack for creating a usefull maven artifact dependency. If the current project contains "-project" it is removed as it is asumed that the main artifact you want to include is not the meta-artifact.

(This "hack" works for VFS but it is a bit ugly, thats why I did not simply commit it).

The patch also uses https for all the links.

BTW: for VFS the generated 2 files in the top level directory work (besides the download-link and apidoc).