Turn on Javadoc generation by default.

Description

We currently have a release profile that does things such as generating Javadocs and signing artifacts for deployment to Nexus. Take the Javadoc generation out of this profile and turn it on by default.

Javadocs generation is necessary, not to just create the Javadocs archive, but also to check for Javadoc errors. It’s easy to forget to run with the release profile until after a feature branch is merged, resulting in Javadocs needing to be fixed on the main branch (or the feature branch reopened). Instead one gets into the habit of simply adding -P release to every build. We might as well have Javadocs generation always occurs, and allow the quick profile to temporary disable it. By default it is configured for the package phase and we can leave it there.

Signing artifacts is something we always need to do for Nexus. But we don’t need to do it until just before deploying, in the deploy phase. By default it happens in the verify phase, presumably this is because you want the artifacts signed before you install them, perhaps to prevent problems where you have a published version and an installed version but only one is signed. We don’t want to enter some password to sign the artifacts each time we install e.g. a new -SNAPSHOT version needed for another -SNAPSHOT version when both are in development, so for now let’s leave artifact signing in the separate profile it is in now.

The Maven Source Plugin generation of source documentation, by default in the package phase and currently relegated to the release profile, can be placed in or out of the profile. Since it takes a bit of extra time, and since we have no need for for the source unless we are publishing the artifacts, let’s go ahead and leave it in the profile for now.

Environment

None

Activity

Fixed

Details

Assignee

Reporter

Components

Priority

Created October 11, 2022 at 11:17 PM
Updated October 11, 2022 at 11:35 PM
Resolved October 11, 2022 at 11:35 PM