[HBASE-20077] add a project health check that ensures the ref guide can be built

• Type: New Feature
• Status: Resolved
• Priority: Minor
• Resolution: Duplicate
• Component/s: documentation, test
• Labels: beginner
• Assignee: Unassigned
• Reporter: Sean Busbey
• Created: 25/Feb/18 01:32
• Updated: 10/Apr/18 14:27
• Resolved: 10/Apr/18 14:27

Description

unless someone can think of particulars to check, this command will assemble the book without doing most of the rest of the project:

mvn -pl . clean site --batch-mode -Dmaven.javadoc.skip=true -DskipTests
[INFO] Scanning for projects...
[INFO] ------------------------------------------------------------------------
[INFO] Detecting the operating system and CPU architecture
[INFO] ------------------------------------------------------------------------
[INFO] os.detected.name: osx
[INFO] os.detected.arch: x86_64
[INFO] os.detected.version: 10.11
[INFO] os.detected.version.major: 10
[INFO] os.detected.version.minor: 11
[INFO] os.detected.classifier: osx-x86_64
[INFO] 
[INFO] ------------------------------------------------------------------------
[INFO] Building Apache HBase 3.0.0-SNAPSHOT
[INFO] ------------------------------------------------------------------------
...

[INFO] Executed tasks
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 02:42 min
[INFO] Finished at: 2018-02-24T14:27:56-06:00
[INFO] Final Memory: 132M/1015M
[INFO] ------------------------------------------------------------------------

It's only good for specifically testing the ref guide, since it skips so much (i.e. project compilation and javadocs)

Issue Links

• duplicates: HBASE-15466 precommit should not run all java goals when given a docs-only patch