[KARAF-6651] The provided build command for pull requests in the contribution guide fails

• Type: Documentation
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Component/s: website

Environment

macOS Mojave 10.14.6
Model Name: MacBook Pro
Model Identifier: MacBookPro15,1
Processor Name: Intel Core i7
Processor Speed: 2,6 GHz
Number of Processors: 1
Total Number of Cores: 6
L2 Cache (per Core): 256 KB
L3 Cache: 12 MB
Hyper-Threading Technology: Enabled
Memory: 32 GB
java version "1.8.0_231"
Java(TM) SE Runtime Environment (build 1.8.0_231-b11)
Java HotSpot(TM) 64-Bit Server VM (build 25.231-b11, mixed mode)
Apache Maven 3.6.3

• Assignee: Jean-Baptiste Onofré
• Reporter: Oliver Limberg
• Created: 22/Mar/20 16:50
• Updated: 23/Mar/20 06:20
• Resolved: 23/Mar/20 06:20

Description

The guide states to run 

mvn clean verify -Prelease -fae -T 1C

before submitting a pull request.
Assuming the user only completed the tasks from BUILDING.md, this will probably always fail, because of the 'sign' goal of the included Apache Maven GPG Plugin.
I spent quite a few hours now to get this working.
Other users willing to provide pull requests might not have the patience.

Is signing the artifacts in this case really required? If not, the command should include

-Dgpg.skip=true

Otherwise, BUILDING.md should contain a section about installing GPG and creating a key as well.

I do not know if this is specific to my system, but I had to create a settings.xml file for maven to contain the passphrase for my GPG key and had to remove the maven options for parallel builds as well.