[RNG-23] Towards version 1.0

• Type: Task
• Status: Closed
• Priority: Major
• Resolution: Done
• Fix Version/s: 1.0
• Labels: build-tools documentation modularization release review
• Assignee: Unassigned
• Reporter: Gilles Sadowski
• Created: 01/Nov/16 23:08
• Updated: 13/Dec/16 10:23
• Resolved: 13/Dec/16 10:11

Description

Codebase has been split into several maven modules (in branch "multimodule").

The following check-list supersedes issue RNG-6:

Web site (i.e. contents of directory "site-content") should not be duplicated in each module
Userguide must be moved to the "top-level" (i.e. out of "commons-rng-core")
Review Javadoc of each module
Update the userguide

• Describe each module

Review "OSGi" configuration ("internal" classes must now be accessible as other modules depend on them)
Review "commons-rng-jmh/pom.xml" (and document how to run the benchmark)
Review "commons-rng-examples/pom.xml" (and document how to run the examples)
Check "Jenkins" configuration
Check "travis" configuration
Check "coveralls" configuration (full coverage is now split between the "core" and "simple" modules)
Enable Jacoco
Update "doc/release/release.howto.txt"
Ensure that the "commons-rng-build-tools" module is acceptable (wrt Commons release policy)
Module was removed.

Fix maven warning:

WARNING] Some problems were encountered while building the effective model for org.apache.commons:commons-rng-client-api:jar:1.0-SNAPSHOT
[WARNING] 'build.plugins.plugin.(groupId:artifactId)' must be unique but found duplicate declaration of plugin org.codehaus.mojo:clirr-maven-plugin @ org.apache.commons:commons-rng:1.0-SNAPSHOT, /home/eran/devel/java/apache/commons-rng/trunk/pom.xml, line 238, column 15

Specific web pages for each module:

• Client API
• Core
• Simple
• JMH (not necessary ATM)
• Examples (not necessary ATM)

Fix "CheckStyle" and FindBugs errors

• Client API
• Core
• Simple
• JMH (generated code must be excluded from the report)
• Examples
• Sampling

Issue Links

• supercedes: RNG-6 Check list for first release

Sub-Tasks

• Non-redundant "site-content" directory: Closed
• Continuous integration configuration: Closed
• "build-tools" module: Closed
• Exclude generated sources from CheckStyle and FindBugs: Closed
• Running benchmarks and examples: Open